Scribd
Upload
34 views21 pages

Dachser Targospeed Order Management API

1. The document describes the order process workflow, including user login, searching for stocks/prices, querying order types and freight carriers, and creating/updating orders. 2. To begin, the user must login to get an authentication token, which is required for subsequent API calls. 3. The user can then optionally search for stock quantities, prices and product data by warehouse. They can also optionally query order types and available freight carriers. 4. To create an order, the user calls the API to generate an empty order record with the required authentication token and customer details. They can then update the order by calling the API again.

Uploaded by

Digital Pine
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
34 views21 pages

Dachser Targospeed Order Management API

1. The document describes the order process workflow, including user login, searching for stocks/prices, querying order types and freight carriers, and creating/updating orders. 2. To begin, the user must login to get an authentication token, which is required for subsequent API calls. 3. The user can then optionally search for stock quantities, prices and product data by warehouse. They can also optionally query order types and available freight carriers. 4. To create an order, the user calls the API to generate an empty order record with the required authentication token and customer details. They can then update the order by calling the API again.

Uploaded by

Digital Pine
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd

1、Order Process

User Login Query for Search for Query for Query Create Update
Check Order
to get Token Warehouse Stocks and Prices order type freight carrier Empty Order Order

2、User login to get token （Mandatory）

Function Description
User login to get token

Description for Interface call


Specific account and password are needed for each call method
altnum: AUG0142
Password: AUG0142

URL
[Link]

HTTP Request method


Get
Post

Description for input parameters


parameter name Is it Type Description default
necessary?
command Yes String method NULL
altnum Yes String client number NULL
password Yes String Specify password NULL

Request example
[Link]
command=getToken&altnum=altnum1&password=password1
Description for returned parameter

parameter name type Description


result String Json Format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Description for returned parameter

parameter name Description

altnum client number

message Get notes

token Token

tokenTimeout Token Get date

The correct return example

"result":{

"altnum": "AUG0142test",

"message": "succeed.",

"token": "596EE94E452148ECAFA8CDA924413B40",

"tokenTimeout": "2017-12-11 08:31"

},

"rowCount":0,

"success":true
}
3、Search for stocks and prices（Optional）

Function Description
Search for stocks ， prices and product data of the
designated warehouse

Description for Interface call


Need token

URL
[Link]

HTTP Request method


Get
Post

Description for input parameters


parameter name Is it Type Description default
necessary?
command Yes String method NULL
token Yes String token NULL
altnum Yes String client number NULL
warehouse Yes String warehouse NULL
keyword NO String keyword NULL

Request example
get
[Link]
command=getInventoryAndPrice&altnum=altnum1&warehouse=warehouse&token=token&ke
yword=keyword1

Description for returned parameter


s
parameter name type Description
result String Json Format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Description for returned parameter

parameter name Description

itemCode Aster item code

available Available Stock

price Price

The correct return example

"result": [{

"itemCode": "03B2000",

"available": 100,

“price”: 10

}],

"rowCount": 0,

"success": true

}
4、Query order type（Optional）

Function Description
Query order type

Interface Call Description


Direct query

URL
[Link]

HTTP Request method


Get
Post

Description of input parameters


parameter name Is it Type Description default
necessary?
command Yes String Call method NULL

Request Example
get
[Link]

Return Parameter Description

parameter name type Description


result String Json Array format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Return parameter description

parameter name description


description Order type description

orderType Order type code

Correct return example

"result": [

"description": "Complete Plain Drop Shipping",

"orderType": " CPDROP"

},

"description ": "Drop ship order",

"orderType ": " DROP "

},

"description ": "Drop ship from China",

"orderType ": " OEM"

]
"rowCount":2,

"success":true

5、Query freight carrier（Optional）

Function Description
Query freight carrier

Interface Call Description


Need token

URL
[Link]

HTTP Request method


Get
Post

Description of input parameters

parameter name Is it Type Description default


necessary?
command Yes String Call method NULL
token Yes String token NULL

Request Example
[Link] &token=token

Return Parameter Description

parameter name type Description


result String Json Array format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Return parameter description

Parameter name Description

caCode Carrier code

caTitle Freight forwarding description

Correct return example

"result": [

"caCode": "DAC ",

"caTitle": "Dachser Targospeed "

},

"caCode ": "DPD",

"caTitle ": "DPD Normal Service"

"rowCount":0,

"success":true

}
6、Create Empty Order （Mandatory）

Function Description
Create an order based on specified parameters

Interface call description


Need token

URL
[Link]

HTTP Request method


Get
Post

Description of input parameters


parameter name Is it necessary? Type Description default
command Yes String Call method NULL
altnum Yes String Customer code NULL
token Yes String token NULL

Request Example
[Link]

Return parameter description

parameter name Type Description


result String Json Array format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Description for returned parameter

parameter name Description

amount Order item amount

auditStatus Approval Status


discount Discount amount

instruction order notes

itemList Items List

message Call note

orderDate Order creation date

orderId order number

orderStatus Order Status

orderTotal Total order

orderType Order Type

paymentTerms Customer order terms

ponumber Customer order number

shipVia Carrier information

shippingCharg

fright charge

tax Tax

warehourse Warehourse

Correct returned example


{

"result": {

"amount": 0,

"auditStatus": "false",

"discount": 0,

"instruction": "",

"message": "Order created successfully.",

"orderDate": "2018-12-15 08:28",

"orderId": "37725",

"orderStatus": "EP",

"orderTotal": 0,

"orderType": "",

"paymentTerms": "T/T in Advance",

"ponumber": "",

"shipVia": "",

"shippingCharge": 0,

"tax": 0,

"warehourse": ""

},

"rowCount":0,

"success":true

}
7、Update order （Mandatory）

Function Description
Update order based on specified parameters

Interface call description

Need token
Method： updateOrder

URL
[Link]

HTTP Request method


Get
Post

Description of input parameters

parameter Is it Type decription Default


name necessary?
command Yes String Call method NULL
altnum Yes String client number NULL
orderId Yes int Order number NULL
token Yes String Token NULL
ponumber No String Customer number NULL
warehourse Yes String Warehouse NULL
GB: UK Warehouse
orderType Yes String Order type NULL
REG: Regular order
DROP: Dropship order
CPDROP: Complete Plain Drop Ship
instruction No String Order discription NULL
shipVia Yes String Carrier NULL
DPD: UK DPD
shipTo Yes String Shipping address json format NULL
itemsList Yes String Product model json array format NULL

shipTo Parameter Description

"company": "company test",

"firstname": "firstname test",

"lastname": "lastname test",

"addr": "addr",

"addr2": "addr2",

"city": "city test",

"state": "state test",

"zipcode":"zipcode",

"country": "FR",

"phone": "131231231231"

itemsList Parameter Description

[{

"number": "B328C",

"qty": "12"

},

{
"number": "B2120",

"qty": "12"

}]

Request Example
[Link]
command=updateOrder&altnum=altnum&token=token&ponumber=ponumber&order
Id=37725&warehouse=FR_NW&orderType=DROP&instruction =instruction
test&shipVia=COL
&shipTo={
"company": "company test",
"firstname": "firstname test",
"lastname": "lastname test",
"addr": "addr",
"addr2": "addr2",
"city": "city test",
"state": "state test",
"zipcode": "zipcode",
"country": "003",
"phone": "13169268426"
}
&itemsList:=[{
"number": "B328C",
"qty": "12"   
}, {
"number": "B2120",
"qty": "12"
}]

Return Parameter Description

parameter name type Discription


result String Json Array format character content
rowCount String Return the number of lines
success String Whether the call is successful
8、Order checking （Optional）

Function Description
Query orders based on specified parameters

Interface Call Description


Need token

URL
[Link]

HTTP request method


Get
Post

Description of input parameters


parameter name Is it type Discription 默认
necessary?
command Yes String Call method NULL
altnum Yes String Customer code NULL
token Yes String token NULL
orderId Yes String Order number NULL

Request Example
[Link]
command=getOrderInfo&altnum=altnum&token=token&orderId=orderId

Return Parameter Description

parameter name Type Discription


result String Json Array format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Description for returned parameter


parameter name Description

amount Order item amount

auditStatus Approval Status

discount Discount amount

instruction order notes

itemList Items List

message Call note

orderDate Order creation date

orderId order number

orderStatus Order Status

orderTotal Total amount

orderType Order type

paymentTerms Payment terms

ponumber Customer order number

shipVia Carrier

shippingCharge Shipping charge

tax Tax
warehourse warehouse

itemList
[
{
"createDate": "2018-10-25 03:04",
"description": "Replacement for TN-2120,Black,2600",
"itemStatus": "CM",
"orderId": 37579,
"price": 10,
"productCode": "B2120",
"qty": 10
},
{
"createDate": "2018-10-25 03:04",
"description": "Replacement for TN-325C,Cyan,3500",
"itemStatus": "CM",
"orderId": 37579,
"price": 100,
"productCode": "B325C",
"qty": 50
}
],
9、Get Tracking Number （Optional）

Function Description
Get Tracking Number by orderId

Interface Call Description


Direct query
URL
[Link]

HTTP Request method


Get
Post

Description of input parameters

parameter name Is it Type Description default


necessary?
command Yes String Call method NULL
orderId Yes int

Request Example
get
[Link]

Return Parameter Description

parameter name type Description


result String Json Array format character content
rowCount String Return the number of lines
success String Whether the call is successful

result Return parameter description

Parameter name Description

caCode Carrier code

trackingNumber Tracking Number

orderId

Correct return example

{
"result": [

"caCode": "DPD",

"trackingNumber": "05228992488733 "

},

"caCode ": "DPD",

"trackingNumber": "05228992488833"

"rowCount":2

"success":true

[Link].

You might also like