Orders API RESTful

 In API/Developers

Please note:

It is your responsibility to properly set up all translation features, perform testing, and request support from ShipEdge in a timely manner. It is your responsibility to test and verify the integration between ShipEdge and any 3rd party selling channel. We strongly recommend frequent testing of any integration, specially when changes occur on your selling channel (e.g. SKU renaming, shipping method variations, permissions and credentials). ShipEdge is not responsible for translation issues, omitted orders, or any other issues related to communication with any 3rd party selling channel. Support for channel automation requires at least 24 hours for investigation before any action can be taken (hourly development charges may apply). The warehouse is not responsible for any omission, duplication or error in your orders coming through this system, and you agree not to get the warehouse involved in integration issues, nor will they make any exception or procedure changes due to the use of this feature.

API
AccountID123
Key1233456789
Warehouse123
Api basehttp://integration.shipedge.com/API/Rest/Orders

Operations

 

Ping

Ping to check the system status.

GET /ping

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx"
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.

 

Get orders

Gets the collection of orders.

GET /getOrders

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
"page": 2, 
"order_status": "All"
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
page (*)intPagination, number of page.
order_status(*)varcharOrders status.All
Cancel
Pending
Processing
Incomplete
Divided
Backorder
Shipped
Error
Return by carrier
Packing error
Low balance
Hold
Dropship
Editing
Sent to Shipedge
Shipped by Shipedge
Pending to CoTim
Sent to CoTim
Shipped by CoTim

 

Create Orders

API ORDERS

Method: addOrdersAccountCreate orders.

HTTP: POST http://integration.shipedge.com/API/Rest/Orders/addOrdersAccount

Format: JSON

 

Parameter Type

 

Description
Key (*)varcharFound in your ShipEdge account. Preferences>API Integration> Key. (Required)
AccountID (*)int

 

Found in your ShipEdge account. Preferences>API Integration>AccountID. (Required)

 

Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse. (Required)
orderNum (*)varchar orderNum must be unique. You may use a shopping-cart or order processing software ID. It is recommended to use incremental consecutive numbers. If an Order# is repeated, the system will not import that row. (Required) 
orderShipMethod (*)varcharplease refer to ship method codes table. (Required) 
custEmailvarcharwe can send order status updates to this email on your behalf. 
custPhonevarcharYour customer’s delivery phone# is required on all international orders and express shipments. You may use your own phone number if you don’t have the buyers contact phone#. 
custFName (*)varcharUse as first name or as complete name.(Required)
custLNamevarcharLast name after first name. 
custCompanyvarcharIf buyer is a company or organization. 
custAddress1 (*)varcharstreet delivery address. (Required) 
custAddress2varcharapartment or unit number. International order may use this field for zone or area. 
custCity (*)varchardelivery city name. (Required) 
custState (*)varcharstate or province. (Required)
custCountry (*)varchardelivery country name. (Required)
custBillFNamevarcharBuyer first or complete name. Used for customer services purposes and order management. If left blank we will repeat the delivery address. 
custBillLNamevarcharIf left blank we will repeat the delivery address. 
custBillCompanyvarcharIf left blank we will repeat the delivery address. 
custBillAddress1varcharIf left blank we will repeat the delivery address. 
custBillAddress2varcharIf left blank we will repeat the delivery address. 
custBillCityvarcharIf left blank we will repeat the delivery address. 
custBillStatevarcharIf left blank we will repeat the delivery address. 
custBillZipvarcharIf left blank we will repeat the delivery address. 
custBillCountryvarcharIf left blank we will repeat the delivery address. 
orderCODvarcharAmount to be picked up when shipment is delivered (only available through UPS – additional service fees apply). 
orderInsurancevarcharIf insurance is required, please include the insurance amount otherwise leave blank (additional charges apply). UPS and FedEx automatically include insurance up to $100 at no additional charge. 
orderReqSignatureEnum (YES, NO)YES or NO (blank or nill)
CheckoutDateDate(YYYY-MM-DD)payment cleared date.
CartIDintIf multiple you sell through multiple shopping carts.
ChannelIDintIf multiple you sell through multiple Channels.
LogoIDintTo be shown in the packing list. In case you use a different logo on multiple channels or shopping carts (not yet implemented).
NoteFromvarcharIf you would like to include your address or a different note specific for each order (not yet implemented).
ShipmentSubtotalvarcharTotal amount charged for merchandise not including shipping & handling charges.
ShippingChargevarcharShipping and Handling charges.
TotalChargevarcharTotal amount charged for merchandise plus shipping & handling charges.
ResidentialEnum(YES,NO)YES / NO. Used to attain different service levels by UPS or FedEx. We can fill this for you if you are subscribed to automatic address verification and residence status (this service will detect the status of the delivery and automatically select the correct service: Commercial or Residential)
CustCommentsvarcharComments received by customer during checkout.
WarehouseIDintNot required for home warehouse. Only used by multi-warehouse users or drop-shipping.
ItemsintUse for one line per order, including multiple SKUs per package (total number of SKUs included in the package, not total number of products).
Option1 to 10varchar
StoreIDint
Sku (*)varcharThe SKU we need to place in the package. (Required) 
Qty (*)intThe number of products for its respective.(Required)
SoldPricefloat
DescriptionvarcharDescription of the Sku.

 

 

(*) Required Parameters

Request (Example):

{

“AccountID”:”123″,

“Key”:”123abcd”,

“Warehouse”:”dev1″,

“orders”:[{

“orderNum”:”20″,

“orderShipMethod”:”DROPSHIP”,

“orderComments”:”Comments”,

“custEmail”:”ashishp@7nodes.com”,

“custPhone”:”123345″,

“custFName”:”Luis1″,

“custLName”:”cust Name”,

“custCompany”:”cust Company”,

“custAddress1″:”123 Campbellton”,

“custAddress2″:”cust Address2”,

“custCity”:”Montague – PE”,

“custState”:”PE”,”custZip”:”C0A 1R0″,

“custCountry”:”Canada”,

“custBillFName”:”Bill FName”,

“custBillLName”:”Bill LName”,

“custBillCompany”:”Bill Company”,

“custBillAddress1″:”Bill Address1”,

“custBillAddress2″:”Bill Address2”,

“custBillCity”:”Los angeles”,

“custBillState”:”CA”,

“custBillZip”:”60915″,

“custBillCountry”:”USA”,

“orderCOD”:””,

“orderInsurance”:”NO”,

“orderReqSignature”:”NO”,

“CheckoutDate”:”2016-04-16″,

“CartID”:””,

“ChannelID”:””,

“LogoID”:””,

“NoteFrom”:””,

“ShipmentSubtotal”:””,

“ShippingCharge”:””,

“TotalCharge”:””,

“Residential”:”YES”,

“CustComments”:””,

“WarehouseID”:”1″,

“items”:”1″,

“Option1″:””,

“Option2″:””,

“Option3″:””,

“Option4″:””,

“Option5″:””,

“Option6″:””,

“Option7″:””,

“Option8″:””,

“Option9″:””,

“Option10″:””,

“StoreID”:””,

“Detaill”:[{

“Sku”:”SEN-MOM-WIR-BLA-BRA-NEW”,

“Qty”:”1″,

“SoldPrice”:”2.2200″,

“Description”:”sell by user example”

},

{

“Sku”:”DNP003″,

“Qty”:”2″,

“SoldPrice”:”3.3333″,

“Description”:”sell by user example 3333″

}]

},

{

“orderNum”:”21″,

“orderShipMethod”:”DROPSHIP”,

“orderComments”:”Comments”,

“custEmail”:”ashishp@7nodes.com”,

“custPhone”:”6789000″,

“custFName”:”Luis2″,

“custLName”:”cust Name”,

“custCompany”:”cust Company”,

“custAddress1″:”123 Campbellton”,

“custAddress2″:”cust Address2”,

“custCity”:”Montague – PE”,

“custState”:”PE”,

“custZip”:”C0A 1R0″,

“custCountry”:”Canada”,

“custBillFName”:”Bill FName”,

“custBillLName”:”Bill LName”,

“custBillCompany”:”Bill Company”,

“custBillAddress1″:”Bill Address1”,

“custBillAddress2″:”Bill Address2”,

“custBillCity”:”Los angeles”,

“custBillState”:”CA”,

“custBillZip”:”60915″,

“custBillCountry”:”USA”,

“orderCOD”:””,

“orderInsurance”:”NO”,

“orderReqSignature”:”NO”,

“CheckoutDate”:”2016-04-16″,

“CartID”:””,

“ChannelID”:””,

“LogoID”:””,

“NoteFrom”:””,

“ShipmentSubtotal”:””,

“ShippingCharge”:””,

“TotalCharge”:””,

“Residential”:”YES”,

“CustComments”:””,

“WarehouseID”:”1″,

“items”:”1″,

“Option1″:””,

“Option2″:””,

“Option3″:””,

“Option4″:””,

“Option5″:””,

“Option6″:””,

“Option7″:””,

“Option8″:””,

“Option9″:””,

“Option10″:””,

“StoreID”:””,

“Detaill”:[{

“Sku”:”AC-F2-F15″,”Qty”:”1″,

“SoldPrice”:”2.2200″,

“Description”:”sell by user example”

},

{

“Sku”:”AC-F3-F14″,

“Qty”:”2″,

“SoldPrice”:”3.3333″,

“Description”:”sell by user example 3333″

}]

}]

}

 

 

 

 

 

 

 

 

Answers (Example):

{

“access”:

{

“AccountID”:”202″,

“AccessAccount”:”Allow: addOrdersAccount”,

“Warehouse”:”dev1″,

“NumOrders”:2,

“Message”:”All orders in system”,

“BatchId”:123

},

“addListOrders”:

{

“allow”:[{

“orderNum”:”20″,

“OrderID”:”1002″

}]

,

“denied”:[{

“orderNum”:”21″,

“CommentAPI”:Check Field:SKU”,

“OrderID”:false

}]

}

}

 

 

 

 

 

 

Example: In Php.

 

<?php

$data = array(

“AccountID” => “123”,

“Key” => “123abc”,

“Warehouse” => “dev1”,

“orders” => array(

array(

‘orderNum’ => ’20’,

‘orderShipMethod’ => ‘DROPSHIP’,  

‘orderComments’ => ‘Comments’,

‘custEmail’ => ‘ashishp@7nodes.com’,

‘custPhone’ => ‘123345’,

‘custFName’ => ‘Luis1’,

‘custLName’ => ‘cust Name’,  

‘custCompany’ => ‘cust Company’,  

‘custAddress1’ => ‘123 Campbellton’,  

‘custAddress2’ => ‘cust Address2’,

‘custCity’ => ‘Montague – PE’,

‘custState’ => ‘PE’,  

‘custZip’ => ‘C0A 1R0’,  

‘custCountry’ => ‘Canada’,

‘custBillFName’ => ‘Bill FName’,  

‘custBillLName’ => ‘Bill LName’,  

‘custBillCompany’ => ‘Bill Company’,  

‘custBillAddress1’ => ‘Bill Address1’,

‘custBillAddress2’ => ‘Bill Address2’,

‘custBillCity’ => ‘Los angeles’,

‘custBillState’ => ‘CA’,

‘custBillZip’ => ‘60915’,  

‘custBillCountry’ => ‘USA’,

‘orderCOD’ => ”,

‘orderInsurance’ => ‘NO’,

‘orderReqSignature’ => ‘NO’,  

‘CheckoutDate’ => ‘2015-12-16’,  

‘CartID’ => ”,  

‘ChannelID’ => ”,

‘LogoID’ => ”,  

‘NoteFrom’ => ”,

‘ShipmentSubtotal’ => ”,

‘ShippingCharge’ => ”,  

‘TotalCharge’ => ”,  

‘Residential’ => ‘YES’,  

‘CustComments’ => ”,

‘WarehouseID’ => ‘1’,

‘items’ => ‘1’,  

‘Option1’ => ”,  

‘Option2’ => ”,  

‘Option3’ => ”,  

‘Option4’ => ”,  

‘Option5’ => ”,  

‘Option6’ => ”,  

‘Option7’ => ”,  

‘Option8’ => ”,  

‘Option9’ => ”,  

‘Option10’ => ”,

‘StoreID’ => ”,

‘Detaill’ => array(

array(

‘Sku’ => ‘SEN-MOM-WIR-BLA-BRA-NEW’,

‘Qty’ => ‘1’,

‘SoldPrice’ => ‘2.2200’,

‘Description’ => ‘sell by user example’

)

,

array(

‘Sku’ => ‘DNP003’,

‘Qty’ => ‘2’,

‘SoldPrice’ => ‘3.3333’,

‘Description’ => ‘sell by user example 3333’

)

)

),

 

array(

‘orderNum’ => ’20’,

‘orderShipMethod’ => ‘DROPSHIP’,  

‘orderComments’ => ‘Comments’,

‘custEmail’ => ‘ashishp@7nodes.com’,

‘custPhone’ => ‘123345’,

‘custFName’ => ‘Luis1’,

‘custLName’ => ‘cust Name’,  

‘custCompany’ => ‘cust Company’,  

‘custAddress1’ => ‘123 Campbellton’,  

‘custAddress2’ => ‘cust Address2’,

‘custCity’ => ‘Montague – PE’,

‘custState’ => ‘PE’,  

‘custZip’ => ‘C0A 1R0’,  

‘custCountry’ => ‘Canada’,

‘custBillFName’ => ‘Bill FName’,  

‘custBillLName’ => ‘Bill LName’,  

‘custBillCompany’ => ‘Bill Company’,  

‘custBillAddress1’ => ‘Bill Address1’,

‘custBillAddress2’ => ‘Bill Address2’,

‘custBillCity’ => ‘Los angeles’,

‘custBillState’ => ‘CA’,

‘custBillZip’ => ‘60915’,  

‘custBillCountry’ => ‘USA’,

‘orderCOD’ => ”,

‘orderInsurance’ => ‘NO’,

‘orderReqSignature’ => ‘NO’,  

‘CheckoutDate’ => ‘2015-12-16’,  

‘CartID’ => ”,  

‘ChannelID’ => ”,

‘LogoID’ => ”,  

‘NoteFrom’ => ”,

‘ShipmentSubtotal’ => ”,

‘ShippingCharge’ => ”,  

‘TotalCharge’ => ”,  

‘Residential’ => ‘YES’,  

‘CustComments’ => ”,

‘WarehouseID’ => ‘1’,

‘items’ => ‘1’,  

‘Option1’ => ”,  

‘Option2’ => ”,  

‘Option3’ => ”,  

‘Option4’ => ”,  

‘Option5’ => ”,  

‘Option6’ => ”,  

‘Option7’ => ”,  

‘Option8’ => ”,  

‘Option9’ => ”,  

‘Option10’ => ”,

‘StoreID’ => ”,

‘Detaill’ => array(

array(

‘Sku’ => ‘AC-F2-F15’,

‘Qty’ => ‘1’,

‘SoldPrice’ => ‘2.2200’,

‘Description’ => ‘sell by user example’

)

,

array(

‘Sku’ => ‘AC-F3-F14’,

‘Qty’ => ‘2’,

‘SoldPrice’ => ‘3.3333’,

‘Description’ => ‘sell by user example 3333’

)

)

)

 

)

 

);

 

$data = json_encode($data);

$url =”http://integration.shipedge.com/API/Rest/Orders/addOrdersAccount”;

$curl = curl_init();

curl_setopt($curl, CURLOPT_HEADER, false);

curl_setopt($curl, CURLOPT_POST, 1);

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

curl_setopt($curl, CURLOPT_HTTPHEADER, array(‘Content-Type: application/json’,’Content-Length: ‘ . strlen($data)));

curl_setopt($curl, CURLOPT_URL, $url);

curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);

$x = curl_exec($curl);

$data = json_decode($x);

echo “<pre>”;

print_r($data);

echo “</pre>”;

?>

 

(*) Use the information in your account.

 

Get total orders

Gets the total of orders.

GET /getTotalOrders

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
"order_status": "All"
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
order_status(*)varcharOrders status.All
Cancel
Pending
Processing
Incomplete
Divided
Backorder
Shipped
Error
Return by carrier
Packing error
Low balance
Hold
Dropship
Editing
Sent to Shipedge
Shipped by Shipedge
Pending to CoTim
Sent to CoTim
Shipped by CoTim

 

Get order

Gets the detail information about an order.

GET /getOrder

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
"order_id": 1
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
order_id (*)integerSpecify an order_id to get details about an order.

 

Get products

Gets the items associated with an order.

GET /getProducts

Request

{
"AccountID": 1,
"Key": "123456789",
"Warehouse":"ncx",
"order_id": 1
}
ParemeterTypeDescription
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key.
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse.
order_id (*)integerSpecify an order_id to get details about an order.

 

 

Cancel Order

 

GET /cancelOrder

 

url: http://integration.shipedge.com/API/Rest/Orders/cancelOrder

 

Request

{

"AccountID": 1,

"Key": "123456789",

"Warehouse":"ncx",

"order_id": 1

"order_num": 33

}

 

PAREMETERTYPEDESCRIPTION
AccountID (*)intYour AccountID.
Key (*)varcharYour API Key
Warehouse (*)varcharThis will be found in your ShipEdge account. Preferences>API Integration> Warehouse
order_id (*)IntegerSpecify an order_id to get details about an order.

 

 

 

Contact Us

Send us an email and we'll get back to you, ASAP.