Payouts

Requires read_payment access scope.

For more info , refer to:

[]

access permission

GET https://{handle}.myshopline.com/admin/openapi/v20250601/payments/store/payouts.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 withdraw records, support paging query. Does not support POS currently.

Query Parameters

date_min string
[]
Filter the withdraw records after this date , follow to ISO8601 specifications
[]
Example: 2022-08-03T10:45:00+08:00
limit string
[]
Page size , default 100 , no more than 1000
[]
Example: 100
page_info string
[]
Pagination parameter，Obtained in the link response header, used in page_info mode (querying non-first page data). Refer to the paging mechanism for details about pagination.
[]
Example: eyJwYXlvdXRTdGF0dXMiOiJjb21wbGV0ZWQiLCJzaW5jZUlkIjoiMjAyMjA3MjkxNDUxMjIzODIwMDExMTMwMDAwIiwicGFnZVR5
since_id string
[]
The serial number of withdraw record, filter the withdraw records before this serial number. Used for since_id mode (query the first page of data). Refer to the paging mechanism for details about pagination.
[]
Example: 202208031899561700999905280
status string
[]
Withdraw status , available value : in progress ( in process ) ; accepted by bank ( bank accepted ) ; completed ( completed ) ; failed ( failed in payment ) ; retrying ( in re-sale )
[]
Example: in progress

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
[]
Pagination parameter, Refer to the paging mechanism for details about pagination.
traceId
[]
traceId

Response Body

payoutsobject[]
[]
Withdraw records
amount string
[]
Withdraw amount , amount reserved for two decimal points
[]
Example: 12.34
currency string
[]
Withdraw currency , according to ISO4217 specifications
[]
Example: USD
date string
[]
Withdraw date , follow ISO601 specifications
[]
Example: 2022-08-03T10:45:00+08:00
id string
[]
Withdraw serial number
[]
Example: 202208031899561700999905280
status string
[]
Withdraw status , available value : in progress ( in process ) ; accepted by bank ( bank accepted ) ; completed ( completed ) ; failed ( failed in payment ) ; retrying ( in re-sale )
[]
Example: in progress

API Explorer

Debugger

Examples

Base URL

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

ParamOptions

Authorization — header required

date_min — query

limit — query

page_info — query

since_id — query

status — query

Language

curl --request GET \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/payments/store/payouts.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