CancelOrder
DELETE
/order/{store}
Attempts to cancel a created order, success will depend on platform support.
Path parameters
-
store string Required
ID of the store.
Query parameters
-
order_id integer(int32) Required
ID of order to cancel.
DELETE /order/{store}
curl \
-X DELETE https://nomad.samarkand-global.cn/envoy/order/{store}?order_id=42 \
-H "x-ca-key: $API_KEY"
Response example (200)
{
"code": 42,
"message": "string",
"connectorResponses": [
{
"input": "string",
"mappingName": "GetProductMapping",
"api": [
"string"
],
"apiDocLink": "https://open.pinduoduo.com/#/apidocument/port?portId=pdd.goods.commit.detail.get",
"httpRequestRawData": "-",
"code": 42,
"response": "string",
"responseEn": "string",
"platform": "youzan",
"requestCount": 1,
"responseTime": 1000
}
],
"responseTime": 1000,
"data": {
"returnValue": "string",
"orders": [
{
"orderId": "string",
"clientOrderRef": "string",
"clientParentOrderRef": "string",
"platformTransactionId": "string",
"platformName": "pdd",
"isSubOrder": false,
"isDistributionOrder": false,
"distributorName": "string",
"orderType": "DISTRIBUTOR",
"items": [
{
"product": {
"productId": 123456,
"name": "COLAB Dry Shampoo",
"nameEn": "COLAB Dry Shampoo",
"skus": [
{
"skuNumber": "SMK123",
"price": 10,
"rrp": 8,
"groupBuyingPrice": 6,
"cost": 200,
"images": {
"ids": [
"string"
],
"urls": [
"string"
],
"uploads": [
"string"
]
},
"barcode": 55001234567,
"color": "green",
"size": "small",
"quantity": 10,
"isOnsale": false,
"netWeight": 30.3,
"grossWeight": 35.3,
"shippingCost": 4.2,
"shippingTime": 7,
"model": "iPhone XR",
"spec": "25mm",
"customsUnitCode": "142, 007, 瓶, ...",
"customsUnitCodePackage": "142, 011, 140",
"customsUnitCodeWeight": "035(means 千克, kilogram)",
"availableStock": 6,
"warehouseStock": 6,
"warehouse": "142, 011, 140"
}
],
"currency": "RMB",
"massUnit": "Kilogram",
"timeUnit": "days",
"barcode": 55001234567,
"description": "Some nice dry shampoo for when you cant be bothered to shower",
"price": 7,
"rrp": 8,
"groupBuyingPrice": 6,
"netWeight": 30.3,
"grossWeight": 35.3,
"images": {
"ids": [
"string"
],
"urls": [
"string"
],
"uploads": [
"string"
]
},
"isOnsale": false,
"status": "draft",
"category": [
"All",
"Cloth",
"Top"
],
"vendor": "Apple",
"country": "France",
"shelfLife": 21,
"createdAt": "2019-03-19T08:57:41.133Z",
"updatedAt": "2019-03-19T08:57:41.133Z",
"logisticsMode": "red_auto",
"shippingCost": 4.2,
"shippingTime": 7,
"hsCode": "7606929900",
"personalPostalArticlesTax": "01000000",
"ingredient": "Silk",
"model": "iPhone XR",
"spec": "25mm",
"warrantyPeriod": 180,
"expressType": "string",
"discount": 0,
"taxRate": 0,
"brand": "Nike",
"storeId": "samarkand.xxx",
"categoryId": "12345"
},
"quantity": 4,
"price": 10.1,
"discount": 10.1,
"tax": 1.2
}
],
"customer": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": "string",
"email": "string",
"age": 42,
"gender": "Female",
"chineseId": "string"
},
"customerIdRef": "string",
"seller": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": "string",
"email": "string",
"age": 42,
"gender": "Female",
"chineseId": "string"
},
"payer": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": "string",
"email": "string",
"age": 42,
"gender": "Female",
"chineseId": "string"
},
"status": "string",
"trackingReference": "string",
"destinationCode": "string",
"nodeCode": "string",
"expressCompany": "string",
"expressType": "string",
"currency": "RMB",
"customsCode": "SH",
"customsFilingId": "ABCDE29102918171",
"createdAt": "2019-07-12T13:13:52.004637+01:00",
"updatedAt": "2019-07-12T13:13:52.004637+01:00",
"payMethod": "EASIPAY",
"payMerchantName": "Paypal",
"payAmount": 611.08,
"payId": "2014030120394812",
"paymentPayId": "191028195204000214",
"paidAt": "2019-07-12T13:13:52.004637+01:00",
"payCustomsNo": "190401103508000055101002",
"productsTotalTax": 53.28,
"shippingCost": 25,
"shippingTax": 1,
"shippedDate": "2019-07-12T13:13:52+01:00",
"nonCashDeductionAmount": 0,
"insuranceFee": 2.5,
"customerNote": "This package is very important.",
"deliverySlipUrl": "string",
"campaignTrackingData": {
"cj_event": "test",
"utm_campaign": "my campaign"
},
"discountCode": "string"
}
],
"order": {
"orderId": "string",
"clientOrderRef": "string",
"clientParentOrderRef": "string",
"platformTransactionId": "string",
"platformName": "pdd",
"isSubOrder": false,
"isDistributionOrder": false,
"distributorName": "string",
"orderType": "DISTRIBUTOR",
"items": [
{
"product": {
"productId": 123456,
"name": "COLAB Dry Shampoo",
"nameEn": "COLAB Dry Shampoo",
"skus": [
{
"skuNumber": "SMK123",
"price": 10,
"rrp": 8,
"groupBuyingPrice": 6,
"cost": 200,
"images": {
"ids": [
"string"
],
"urls": [
"string"
],
"uploads": [
"string"
]
},
"barcode": 55001234567,
"color": "green",
"size": "small",
"quantity": 10,
"isOnsale": false,
"netWeight": 30.3,
"grossWeight": 35.3,
"shippingCost": 4.2,
"shippingTime": 7,
"model": "iPhone XR",
"spec": "25mm",
"customsUnitCode": "142, 007, 瓶, ...",
"customsUnitCodePackage": "142, 011, 140",
"customsUnitCodeWeight": "035(means 千克, kilogram)",
"availableStock": 6,
"warehouseStock": 6,
"warehouse": "142, 011, 140"
}
],
"currency": "RMB",
"massUnit": "Kilogram",
"timeUnit": "days",
"barcode": 55001234567,
"description": "Some nice dry shampoo for when you cant be bothered to shower",
"price": 7,
"rrp": 8,
"groupBuyingPrice": 6,
"netWeight": 30.3,
"grossWeight": 35.3,
"images": {
"ids": [
"string"
],
"urls": [
"string"
],
"uploads": [
"string"
]
},
"isOnsale": false,
"status": "draft",
"category": [
"All",
"Cloth",
"Top"
],
"vendor": "Apple",
"country": "France",
"shelfLife": 21,
"createdAt": "2019-03-19T08:57:41.133Z",
"updatedAt": "2019-03-19T08:57:41.133Z",
"logisticsMode": "red_auto",
"shippingCost": 4.2,
"shippingTime": 7,
"hsCode": "7606929900",
"personalPostalArticlesTax": "01000000",
"ingredient": "Silk",
"model": "iPhone XR",
"spec": "25mm",
"warrantyPeriod": 180,
"expressType": "string",
"discount": 0,
"taxRate": 0,
"brand": "Nike",
"storeId": "samarkand.xxx",
"categoryId": "12345"
},
"quantity": 4,
"price": 10.1,
"discount": 10.1,
"tax": 1.2
}
],
"customer": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": "string",
"email": "string",
"age": 42,
"gender": "Female",
"chineseId": "string"
},
"customerIdRef": "string",
"seller": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": "string",
"email": "string",
"age": 42,
"gender": "Female",
"chineseId": "string"
},
"payer": {
"firstName": "John",
"lastName": "string",
"address1": "string",
"address2": "string",
"city": "string",
"state": "string",
"country": "string",
"zip": "string",
"tin": "string",
"phone": "string",
"countryCode": "string",
"email": "string",
"age": 42,
"gender": "Female",
"chineseId": "string"
},
"status": "string",
"trackingReference": "string",
"destinationCode": "string",
"nodeCode": "string",
"expressCompany": "string",
"expressType": "string",
"currency": "RMB",
"customsCode": "SH",
"customsFilingId": "ABCDE29102918171",
"createdAt": "2019-07-12T13:13:52.004637+01:00",
"updatedAt": "2019-07-12T13:13:52.004637+01:00",
"payMethod": "EASIPAY",
"payMerchantName": "Paypal",
"payAmount": 611.08,
"payId": "2014030120394812",
"paymentPayId": "191028195204000214",
"paidAt": "2019-07-12T13:13:52.004637+01:00",
"payCustomsNo": "190401103508000055101002",
"productsTotalTax": 53.28,
"shippingCost": 25,
"shippingTax": 1,
"shippedDate": "2019-07-12T13:13:52+01:00",
"nonCashDeductionAmount": 0,
"insuranceFee": 2.5,
"customerNote": "This package is very important.",
"deliverySlipUrl": "string",
"campaignTrackingData": {
"cj_event": "test",
"utm_campaign": "my campaign"
},
"discountCode": "string"
},
"orderId": "string"
}
}