Open Api
  1. Outbound order API
Open Api
  • Inbound order API
    • queryInboundListDetail
      POST
    • queryInventoryList
      POST
    • Inventory list
      POST
    • queryInboundList
      POST
    • queryInboundDetail
      POST
    • saveInboundInfo
      POST
    • modifyInboundInfo
      POST
    • inboundSubmit
      POST
    • Inbound order cancel
      POST
  • API service controller
    • Generate appKey and appSecret credentials.
      POST
    • Get appKey and appSecret information
      GET
    • Get app information list
      POST
    • Create API access token
      POST
    • Get API access token
      POST
  • Outbound order API
    • modifyOutbound
      POST
    • saveInboundInfo
      POST
  • Sku API
    • order list
      POST
  • Return order API
    • Untitled Endpoint
      POST
    • Untitled Endpoint
      POST
  1. Outbound order API

saveInboundInfo

POST
/outbound/save

Request

Body Params application/json
appKey
string 
required
The value of app key
accessToken
string 
required
The value of access token
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
Request sign:The supported signature algorithm is MD5 (sign_method=md5). The signature process is as follows:
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
Outbound order parameter information entity
shopId
string 
optional
Shop Id - required for E-Commerce order
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
Business Type
fromPlatCode
string 
optional
From Platform Code
operationSla
string 
required
Operation SLA
courierSla
string 
required
Courier SLA
requiredDeliveryTime
string 
optional
Required Delivery Time
orderDueDate
string 
optional
Order due date
customerName
string 
optional
Customer name
customerContact
string 
optional
Customer contact
customerPhone
string 
optional
Customer phone number
customerAddress
string 
optional
Customer address
customerAddress2
string 
optional
Customer address2
customerCity
string 
optional
Customer city
customerProvince
string 
optional
Customer province
customerCountry
string 
optional
Customer country
customerZipcode
string 
optional
Customer zipcode
customerEmail
string 
optional
Customer email
cityCode
string 
optional
City code
provinceCode
string 
optional
Province code
countryCode
string 
optional
Country code
soReference1
string 
optional
So reference1
soReference2
string 
optional
So reference2
soReference3
string 
optional
So reference3
signatureRequired
string 
required
Signature required
noteText
string 
optional
Note text
expectedShipmentTime
string 
optional
Expected Arrival time,Date format: yyyy-MM-dd,The timezone requirement is Eastern Standard Time (EST)-America/Toronto.
warehouseId
string 
required
Warehouse ID:
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
From order No.
carrierId
string 
required
Carrier id
customerId
string 
optional
Ship from id
customerAddressId
integer <int64>
optional
Ship from address id
details
array[object (SaveOutBoundDetail) {8}] 
required
Inbound order parameter information entity
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
{
  "": {}
}
Previous
modifyOutbound
Next
order list
Built with