- Inbound order API
- API service controller
- Outbound order API
- Sku API
- Return order API
saveInboundInfo
POST
/outbound/save
Request
Body Params application/json
appKey
string
required
accessToken
string
required
timestamp
integer <int64>
required
Request timestamp:The timestamp is in UNIX time format (seconds) and must be a 10-digit integer.
The valid range for the input timestamp is:
current_time - 300 seconds <= input_time <= current_time + 300 seconds.
sign
string
required
Sort Parameters:
Sort all request parameters (including both public and business parameters) in ascending ASCII order by their first letter.
If two parameters share the same first letter, use the second letter for secondary sorting, and so on, proceeding left to right.
Concatenate Key-Value Pairs:
After sorting, concatenate the parameters into a single string in the order of key1value1key2value2...keyNvalueN.
No separators are included between key-value pairs.
Add app_secret:
Append the app_secret at both the beginning and end of the concatenated string to form the final signature string.
Generate MD5 Hash:
Encrypt the final signature string using the MD5 algorithm. Convert the resulting MD5 hash to uppercase to obtain the sign value.
This method ensures a consistent and secure signature generation process.
saveOutbound
object (SaveOutbound)
required
shopId
string
optional
Please contact with your account manager for your shop Id, or you can enter Darwynn order management portal get your shop Id from 'Online Shop' module.
businessType
string
required
fromPlatCode
string
optional
operationSla
string
required
courierSla
string
required
requiredDeliveryTime
string
optional
orderDueDate
string
optional
customerName
string
optional
customerContact
string
optional
customerPhone
string
optional
customerAddress
string
optional
customerAddress2
string
optional
customerCity
string
optional
customerProvince
string
optional
customerCountry
string
optional
customerZipcode
string
optional
customerEmail
string
optional
cityCode
string
optional
provinceCode
string
optional
countryCode
string
optional
soReference1
string
optional
soReference2
string
optional
soReference3
string
optional
signatureRequired
string
required
noteText
string
optional
expectedShipmentTime
string
optional
warehouseId
string
required
WH02001 - 02001 (Toronto PROD);
WH02002 - 02002 (Calgary PROD);
WH02003 - 02003 (Montreal PROD);
WH02004 - 02004 (Vancouver PROD);
WS02001 - S02001 (Toronto Network PROD);
WS02002 - S02002 (Toronto Network PROD);
WS02003 - S02003 (Calgary Network PROD);
WS02004 - S02004 (Oshawa Network PROD);
WS02005 - S02005 (Vancouver Network PROD);
fromOrderNo
string
optional
carrierId
string
required
customerId
string
optional
customerAddressId
integer <int64>
optional
details
array[object (SaveOutBoundDetail) {8}]
required
Example
{
"appKey": "string",
"accessToken": "string",
"timestamp": 0,
"sign": "string",
"saveOutbound": {
"shopId": "string",
"businessType": "string",
"fromPlatCode": "string",
"operationSla": "string",
"courierSla": "string",
"requiredDeliveryTime": "string",
"orderDueDate": "string",
"customerName": "string",
"customerContact": "string",
"customerPhone": "string",
"customerAddress": "string",
"customerAddress2": "string",
"customerCity": "string",
"customerProvince": "string",
"customerCountry": "string",
"customerZipcode": "string",
"customerEmail": "string",
"cityCode": "string",
"provinceCode": "string",
"countryCode": "string",
"soReference1": "string",
"soReference2": "string",
"soReference3": "string",
"signatureRequired": "string",
"noteText": "string",
"expectedShipmentTime": "string",
"warehouseId": "string",
"fromOrderNo": "string",
"carrierId": "string",
"customerId": "string",
"customerAddressId": 0,
"details": [
{
"sku": "string",
"unit": "string",
"unitQty": 0,
"isGift": "string",
"productionDate": "string",
"expirationDate": "string",
"qualityCode": "string",
"batchNo": "string"
}
]
}
}
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/outbound/save' \
--header 'Content-Type: application/json' \
--data-raw '{
"appKey": "string",
"accessToken": "string",
"timestamp": 0,
"sign": "string",
"saveOutbound": {
"shopId": "string",
"businessType": "string",
"fromPlatCode": "string",
"operationSla": "string",
"courierSla": "string",
"requiredDeliveryTime": "string",
"orderDueDate": "string",
"customerName": "string",
"customerContact": "string",
"customerPhone": "string",
"customerAddress": "string",
"customerAddress2": "string",
"customerCity": "string",
"customerProvince": "string",
"customerCountry": "string",
"customerZipcode": "string",
"customerEmail": "string",
"cityCode": "string",
"provinceCode": "string",
"countryCode": "string",
"soReference1": "string",
"soReference2": "string",
"soReference3": "string",
"signatureRequired": "string",
"noteText": "string",
"expectedShipmentTime": "string",
"warehouseId": "string",
"fromOrderNo": "string",
"carrierId": "string",
"customerId": "string",
"customerAddressId": 0,
"details": [
{
"sku": "string",
"unit": "string",
"unitQty": 0,
"isGift": "string",
"productionDate": "string",
"expirationDate": "string",
"qualityCode": "string",
"batchNo": "string"
}
]
}
}'
Responses
🟢200Success
application/json
Body
key
object
optional
Example
{
"": {}
}