Version: 202201
After Sales List
GET/openapi/2022-01/orders/after_sales_list
Request
Query Parameters
status string
After-sales status: pending,processing,finished
page int32
Page number
per_page int32
Limit per page
created_at_start string
Filter orders created after the date, for example: 2016-01-18T23:41:00Z
created_at_end string
Filter orders created before the date, for example: 2016-01-18T23:41:00Z
Responses
- 200
200
- application/json
- Schema
- Example
- Result
Schema
- Array [
- Array [
- ]
- Array [
- Array [
- ]
- Array [
- ]
- ]
- ]
countinteger
Default value:
0Example:
4pending_countinteger
Default value:
0Example:
2processing_countinteger
Default value:
0Example:
0post_sales object[]
browser_ipstring
Example:
183.15.177.205created_atstring
Example:
2024-04-22T07:22:51Zcredit_card_numberstring
Example:
0000currency_codestring
Example:
CNYcustomer_namestring
Example:
zhang senjundevicestring
Example:
PCdiscount_codestring
Example:
financial_statusstring
Example:
partially_refundedfulfillment_statusstring
Example:
waitingfulfillments object[]
object
idstring
Example:
e18d1fc2-df36-4d6e-8e03-f1586d963b5fline_items object[]
compare_at_pricestring
Example:
97.00fulfillment_statusstring
Example:
waitingfulfillment object[]
object
idstring
Example:
31d95f28-baf0-47c9-ad53-dbf3833f1b85image object
altstring
Example:
heightinteger
Default value:
0Example:
180pathstring
Example:
ccf0794c594bad32a320eea0d6bfe40c.jpegsrcstring
Example:
//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpegwidthinteger
Default value:
0Example:
174notestring
Example:
options object[]
namestring
Example:
sizevaluestring
Example:
Lpricestring
Example:
81.00product_handlestring
Example:
shirtproduct_idstring
Example:
a1a88be0-a1d4-47e4-a2f2-ba6e131cf447product_tagsstring[]
product_titlestring
Example:
shirtpropertiesstring
Example:
quantityinteger
Default value:
0Example:
2refund_discountstring
Example:
0.00refund_pricestring
Example:
0.00refund_quantityinteger
Default value:
0Example:
1refund_taxstring
Example:
0.00refund_totalstring
Example:
162.00requires_shippingboolean
Default value:
trueExample:
trueskustring
Example:
T-M-L-red-S-A001011spustring
Example:
T-Mtaxableboolean
Default value:
trueExample:
truetotalstring
Example:
162.00variant_idstring
Example:
cbd7a7b0-5dd7-4902-9466-e21bd02688b4variant_titlestring
Example:
L-red-Svendorstring
Example:
shoplazzaweightstring
Example:
1.10weight_unitstring
Example:
kgvendor_urlstring
Example:
https://shoplazza.comoversold_quantityinteger
Default value:
0Example:
0main_currency_prices object
compare_at_pricestring
Example:
13.4pricestring
Example:
11.19totalstring
Example:
22.38actual_ratestring
Example:
7.239804numberstring
Example:
00000013-S1order_numberstring
Example:
00000013order_totalstring
Example:
242.00payment_methodstring
Example:
bogus_gatewayrecipient_namestring
Example:
test testsales_platformstring
Example:
shoplazzashipping_address_extra_info object
object
shipping_countrystring
Example:
China mainlandshipping_emailstring
Example:
[email protected]shipping_line_namestring
Example:
testshipping_phonestring
Example:
+8615014471143sourcestring
Example:
https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8esource_namestring
Example:
{"created_at":"","data":""}placed_atstring
Example:
2024-04-22T07:21:48Zrefund_amountstring
Example:
162.00post_sale_notestring
Example:
last_referrer_showstring
Example:
{"created_at":"","data":""}last_landing_urlstring
Example:
shipping_line_descstring
Example:
11111delivery_methodinteger
Default value:
0Example:
1shipping_tax_totalstring
Example:
0.00shipping_tax_typeinteger
Default value:
0Example:
0all_tax_totalstring
Example:
0.00shop_namestring
Example:
staff_contactstring
Example:
statusstring
Example:
finished{
"count": 4,
"pending_count": 2,
"processing_count": 0,
"post_sales": [
{
"browser_ip": "183.15.177.205",
"created_at": "2024-04-22T07:22:51Z",
"credit_card_number": "0000",
"currency_code": "CNY",
"customer_name": "zhang senjun",
"device": "PC",
"discount_code": "",
"financial_status": "partially_refunded",
"fulfillment_status": "waiting",
"fulfillments": [
{}
],
"id": "e18d1fc2-df36-4d6e-8e03-f1586d963b5f",
"line_items": [
{
"compare_at_price": "97.00",
"fulfillment_status": "waiting",
"fulfillment": [
{}
],
"id": "31d95f28-baf0-47c9-ad53-dbf3833f1b85",
"image": {
"alt": "",
"height": 180,
"path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
"src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
"width": 174
},
"note": "",
"options": [
{
"name": "size",
"value": "L"
}
],
"price": "81.00",
"product_handle": "shirt",
"product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
"product_tags": [
"s1-s2"
],
"product_title": "shirt",
"properties": "",
"quantity": 2,
"refund_discount": "0.00",
"refund_price": "0.00",
"refund_quantity": 1,
"refund_tax": "0.00",
"refund_total": "162.00",
"requires_shipping": true,
"sku": "T-M-L-red-S-A001011",
"spu": "T-M",
"taxable": true,
"total": "162.00",
"variant_id": "cbd7a7b0-5dd7-4902-9466-e21bd02688b4",
"variant_title": "L-red-S",
"vendor": "shoplazza",
"weight": "1.10",
"weight_unit": "kg",
"vendor_url": "https://shoplazza.com",
"oversold_quantity": 0,
"main_currency_prices": {
"compare_at_price": "13.4",
"price": "11.19",
"total": "22.38",
"actual_rate": "7.239804"
}
}
],
"number": "00000013-S1",
"order_number": "00000013",
"order_total": "242.00",
"payment_method": "bogus_gateway",
"recipient_name": "test test",
"sales_platform": "shoplazza",
"shipping_address_extra_info": {},
"shipping_country": "China mainland",
"shipping_line_name": "test",
"shipping_phone": "+8615014471143",
"source": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
"source_name": "{\"created_at\":\"\",\"data\":\"\"}",
"placed_at": "2024-04-22T07:21:48Z",
"refund_amount": "162.00",
"post_sale_note": "",
"last_referrer_show": "{\"created_at\":\"\",\"data\":\"\"}",
"last_landing_url": "",
"shipping_line_desc": "11111",
"delivery_method": 1,
"shipping_tax_total": "0.00",
"shipping_tax_type": 0,
"all_tax_total": "0.00",
"shop_name": "",
"staff_contact": "",
"status": "finished"
}
]
}
{
"count": 4,
"pending_count": 2,
"processing_count": 0,
"post_sales": [
{
"browser_ip": "183.15.177.205",
"created_at": "2024-04-22T07:22:51Z",
"credit_card_number": "0000",
"currency_code": "CNY",
"customer_name": "zhang senjun",
"device": "PC",
"discount_code": "",
"financial_status": "partially_refunded",
"fulfillment_status": "waiting",
"fulfillments": [],
"id": "e18d1fc2-df36-4d6e-8e03-f1586d963b5f",
"line_items": [
{
"compare_at_price": "97.00",
"fulfillment_status": "waiting",
"fulfillment": [],
"id": "31d95f28-baf0-47c9-ad53-dbf3833f1b85",
"image": {
"alt": "",
"height": 180,
"path": "ccf0794c594bad32a320eea0d6bfe40c.jpeg",
"src": "//cdn.shoplazza.com/ccf0794c594bad32a320eea0d6bfe40c.jpeg",
"width": 174
},
"note": "",
"options": [
{
"name": "size",
"value": "L"
},
{
"name": "color",
"value": "red"
},
{
"name": "type",
"value": "S"
}
],
"price": "81.00",
"product_handle": "shirt",
"product_id": "a1a88be0-a1d4-47e4-a2f2-ba6e131cf447",
"product_tags": [
"s1-s2"
],
"product_title": "shirt",
"properties": "",
"quantity": 2,
"refund_discount": "0.00",
"refund_price": "0.00",
"refund_quantity": 1,
"refund_tax": "0.00",
"refund_total": "162.00",
"requires_shipping": true,
"sku": "T-M-L-red-S-A001011",
"spu": "T-M",
"taxable": true,
"total": "162.00",
"variant_id": "cbd7a7b0-5dd7-4902-9466-e21bd02688b4",
"variant_title": "L-red-S",
"vendor": "shoplazza",
"weight": "1.10",
"weight_unit": "kg",
"vendor_url": "https://shoplazza.com",
"oversold_quantity": 0,
"main_currency_prices": {
"compare_at_price": "13.4",
"price": "11.19",
"total": "22.38",
"actual_rate": "7.239804"
}
}
],
"number": "00000013-S1",
"order_number": "00000013",
"order_total": "242.00",
"payment_method": "bogus_gateway",
"recipient_name": "test test",
"sales_platform": "shoplazza",
"shipping_address_extra_info": {},
"shipping_country": "China mainland",
"shipping_line_name": "test",
"shipping_phone": "+8615014471143",
"source": "https://test-shoplazza.stg.myshoplaza.com/checkout/633130-00000001?key=e281e6f81c335487dd91cf3df34a8e",
"source_name": "{\"created_at\":\"\",\"data\":\"\"}",
"placed_at": "2024-04-22T07:21:48Z",
"refund_amount": "162.00",
"post_sale_note": "",
"last_referrer_show": "{\"created_at\":\"\",\"data\":\"\"}",
"last_landing_url": "",
"shipping_line_desc": "11111",
"delivery_method": 1,
"shipping_tax_total": "0.00",
"shipping_tax_type": 0,
"all_tax_total": "0.00",
"shop_name": "",
"staff_contact": "",
"status": "finished"
}
]
}