创建退货单 POST v1/returnOrder

Create return Order

POST http://openapi.ck1info.com/v1/returnOrder

Description: Create return order
Http 200 - Ok
Http 400 - Invalid data, Please check

Request

Body Parameters

Name	DataType	Annotation	Required	Description	Example
ShipToAddress	AddressWithContact	None.
ReceivingWarehouseCode	string	String length: between 0 and 20		Handle Location	NJ
PackageId	string	regular expression: ^[a-zA-Z0-9\-_]*$ String length: between 0 and 50	Required	PackageId, The third party system defined, CustomerId+PackageId is unique	SMT23015236489
ServiceCode	string	String length: between 0 and 30	Required	Shipping Service Code	CUE
Sender	AddressWithContact	None.	Required
Weight	decimal number	None.	Required	Weight of Package, in Gram	600
Length	decimal number	Decimal: 8,2		Length of Package	25
Width	decimal number	Decimal: 8,2		Width of Package	10
Height	decimal number	Decimal: 8,2		Height of Package	20
Skus	Collection of ReturnSkuObject	None.	Required	Skus, with quantity
SalesPlatform	string	None.		Sales Platform Name	Ebay
Custom	string	String length: between 0 and 1000		Custom Text, may print to custom area on label	bag-red
Remark	string	String length: between 0 and 1000		Remark	remark

Request in JSON

{
  "ShipToAddress": {
    "Contact": "sample string 1",
    "Phone": "sample string 2",
    "Email": "sample string 3",
    "Country": "sample string 4",
    "Province": "sample string 5",
    "City": "sample string 6",
    "Street1": "sample string 7",
    "Street2": "sample string 8",
    "Postcode": "sample string 9"
  },
  "ReceivingWarehouseCode": "sample string 1",
  "PackageId": "sample string 2",
  "ServiceCode": "sample string 3",
  "Sender": {
    "Contact": "sample string 1",
    "Phone": "sample string 2",
    "Email": "sample string 3",
    "Country": "sample string 4",
    "Province": "sample string 5",
    "City": "sample string 6",
    "Street1": "sample string 7",
    "Street2": "sample string 8",
    "Postcode": "sample string 9"
  },
  "Weight": 4,
  "Length": 5,
  "Width": 6,
  "Height": 7,
  "Skus": [
    {
      "Sku": "sample string 1",
      "Quantity": 2,
      "Weight": 3,
      "NewDeclareValue": {
        "Value": 1,
        "Currency": "sample string 2"
      },
      "DeclareNameEn": "sample string 4",
      "DeclareNameCn": "sample string 5",
      "ProductName": "sample string 6",
      "Price": 7,
      "HsCode": "sample string 8",
      "SaleURL": "sample string 9"
    },
    {
      "Sku": "sample string 1",
      "Quantity": 2,
      "Weight": 3,
      "NewDeclareValue": {
        "Value": 1,
        "Currency": "sample string 2"
      },
      "DeclareNameEn": "sample string 4",
      "DeclareNameCn": "sample string 5",
      "ProductName": "sample string 6",
      "Price": 7,
      "HsCode": "sample string 8",
      "SaleURL": "sample string 9"
    }
  ],
  "SalesPlatform": "sample string 8",
  "Custom": "sample string 9",
  "Remark": "sample string 10"
}

Response

Name	DataType	Annotation	Example
PackageId	string	None.	SMT23015236489
Ck1PackageId	string	None.	EUU20160808TST00001
HandleStatus	DirectExpressOrderStatus	None.	Submitted
TrackingNumber	string	None.	T024963157
IsFinalTrackingNumber	boolean	None.	true
ShippingProvider	string	None.	DHL
CreateFailedReason	UnShippedReason	None.
ShippingCosts	Collection of ShippingCost	None.
HasRemoteFee	boolean	None.

Response in JSON

{
  "PackageId": "sample string 1",
  "Ck1PackageId": "sample string 2",
  "HandleStatus": "Initial",
  "TrackingNumber": "sample string 3",
  "IsFinalTrackingNumber": true,
  "ShippingProvider": "sample string 5",
  "CreateFailedReason": {
    "ReasonCode": "sample string 1",
    "ReasonText": "sample string 2",
    "ExtendMessage": "sample string 3"
  },
  "ShippingCosts": [
    {
      "Money": 1,
      "Currency": "sample string 2",
      "Type": "None",
      "Remark": "sample string 3"
    },
    {
      "Money": 1,
      "Currency": "sample string 2",
      "Type": "None",
      "Remark": "sample string 3"
    }
  ],
  "HasRemoteFee": true
}

Testing Tool