Paging query gift card

Requires read_gift_card access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/gift_cards.json

[]

handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .

Query Parameters

fields string
[]
Specify return parameters , separated by ','
[]
Example: note, initial_value
limit integer
[]
The biggest result of return , default 50 , maximum not more than 250
[]
Example: 50
page_info string
[]
The call party does not require use and attention to this field , automatically encapsulated by Shopline
[]
Example: eyJzaW5jZUlkIjoiMzAxNTcwNDMzNTkyNDUzMzkyMzEzNjAyODIiLCJkaXJlY3Rpb24iOiJwcmV2Iiwic3RhdHVzIjoiZW5hYmxl
since_id string
[]
Start with a specify gift card id query
[]
Example: 30157043359245339231360282
status string
[]
Gift card status , enabled : enabled , disabled : not enabled
[]
Example: enabled

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Response

[]

For more information about status codes, see Http status code.

Response Headers

link
[]
Page turning information
traceId
[]
traceId

Response Body

gift_cardsobject[]
[]
Gift card information
api_client_id string
[]
Call party id
[]
Example: 36d2bc4e97af056677b61c529d9e3a3f7396040d
balance string
[]
Gift card balance
[]
Example: 200
created_at string
[]
Gift card creation time
[]
Example: 2023-08-16T23:59:59+08:00
currency string
[]
Gift card par currency
[]
Example: CNY
customer_id string
[]
Client id for customers assigned to present gift card
[]
Example: 4200113946
disabled_at string
[]
Gift card disable time
[]
Example: 2023-08-16T23:59:59+08:00
expires_on string
[]
Expiration date for present gift card, “null” means never expired
[]
Example: 2023-08-16T23:59:59+08:00
id string
[]
Gift card id
[]
Example: 30157043359245339231360282
initial_value string
[]
Initial face value of gift card
[]
Example: 200
last_characters string
[]
The last four characters from code
[]
Example: d246
line_item_id string
[]
Associated order items
[]
Example: 18060183094426803997483534
note string
[]
Note information for present gift card
[]
Example: This is a note
order_id string
[]
Associated order id
[]
Example: 24060486231247568944830202
updated_at string
[]
Gift card update time
[]
Example: 2023-08-16T23:59:59+08:00
user_id string
[]
Administrator account id on the admin interface for users to create gift cards
[]
Example: 4214250478

API Explorer

Debugger

Examples

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

Authorization — header required

fields — query

limit — query

page_info — query

since_id — query

status — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/gift_cards.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal