WMS Orders API RESTful v2 / Ship orders
Version 56, last updated on 08-08-2024
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, especially 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.
Base
https://<integration>.shipedge.com/API/Rest/v2/Orders
Ping
Ping to check the system status.
- POST /ping
Parameters
| Parameter | Type | Description |
|---|---|---|
| username | varchar | Admin username |
| account_id (*) | int | Your account ID |
| key (*) | varchar | Your API Key |
| warehouse (*) | varchar | This will be found in your ShipEdge account. Preferences > API Integration > Warehouse. |
Example request
{
"key": "123abc",
"warehouse": "whx",
"account_id": 1
}
Example response
{
"status": "successful",
"result": "pong!"
}
Mark as shipped
Mark order as shipped.
- POST /mark_as_shipped
Parameters
| Parameter | Type | Description |
|---|---|---|
| username | varchar | Admin username |
| account_id (*) | int | Your account ID |
| key (*) | varchar | Your API Key |
| warehouse (*) | varchar | This will be found in your ShipEdge account. Preferences > API Integration > Warehouse. |
| id (*) | varchar | Specify an id of order to mark as shipped. |
| carrier (*) | varchar | Carrier name. |
| shipping_method (*) | varchar | Valid shipping method. |
| tracking_number (*) | varchar | Tracking number. |
| final_postage (*) | varchar | Final postage. |
Example request
{
"username": "manager",
"key": "abc123",
"warehouse": "wh0",
"account_id": 1,
"order": {
"id": "1",
"carrier": "USPS",
"shipping_method": "FCD",
"tracking_number": "123456",
"final_postage": 3.4
}
}
Example response
{
"status": "successful",
"result": "Order shipped"
}
Release tray
Release tray for processing orders
- POST /release_tray
Parameters
| Paremeter | Type | Description |
|---|---|---|
| username (*) | varchar | Admin username |
| account_id (*) | int | Account ID |
| key (*) | varchar | Admin API Key |
| warehouse (*) | varchar | This will be found in your ShipEdge account. Preferences > API Integration > Warehouse. |
| order_id | varchar | Specify an id of order to get details about a shipment. |
| order_number | varchar | Specify a number of order to get details about a shipment. |
| processing | varchar | Specify type of processing. none (default), under, ready |
* Add order_id or order_number.
Example request
{
"username": "user1",
"key": "abc123",
"warehouse": "wh0",
"account_id": 1,
"order_number": "a1",
"processing": "ready"
}
Example response
{
"status": "successful",
"result": {
"order": {
"id": "1",
"order_number": "a1",
"status": {
"id": "4",
"description": "processing"
},
"shipping": {
"id": "1",
"old_tray_number": "TRAY123",
"label_status": 92
}
}
}
}
Add attributes to an Oder or item respectively, if the attribute already exists; it is only modified, If no more attributes are added. In case OrderItemID is 0 or empty, it’s assigned for all orders.
POST /add_attributes
Request
{
"account_id": "210",
"key": "13439852318c7988c8774f02bad0b1d5",
"warehouse": "dev",
"order_id": "123654",
"order_item_id": "2453",
"attribute": "color",
"attrval": "Blue",
"description": "Color of items 2453"
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| username | varchar | Admin username |
| account_id (*) | int | Your account ID |
| key (*) | varchar | Your API Key |
| warehouse (*) | varchar | This will be found in your ShipEdge account. Preferences > API Integration > Warehouse. |
Note: Check that the order_item_id variable could be sent or omitted, since the end user would define whether it’s added to an order or an item, or check if the item exists and not proceed.
Response
{
"success": true,
"message": "You updated it successfully."
}
Get shipment in
This endpoint is intended to retrieve details for orders that are in a Processing status. It includes information such as the destination address, carrier/method, box and SKU details, etc.
At this time, this endpoint does not support multi-box shipments and will not return all box details. If an order is not in a Processing status the response body may return blank. For orders in a Shipped status we suggest using POST /get_shipment_out instead.
- POST /get_shipment_in
Parameters
| Paremeter | Type | Description |
|---|---|---|
| username (*) | varchar | Admin or other authorized username. |
| key (*) | varchar | Your warehouse API Key. |
| warehouse (*) | varchar | Your Shipedge WMS. |
| account_id (*) | int | IMPORTANT: This is currently a required parameter for the endpoint to work, however it should be passed with a blank value. Example: “account_id”: “”, In a future release we will remove this as a required parameter or the endpoint will be updated to a new version. |
| order_id | varchar | Ship Number of the order you wish to retrieve details for. |
| order_number | varchar | Order Number of the order you wish to retrieve details for. |
| from_date | datetime | This will return orders based on the Pending Date of the order. Format yyyy-mm-dd hh:mm:ss. |
* Indicates a required parameter.
Note: Choose only one parameter to search by: order_id, order_number, or from_date.
Example request
{
"username": "manager",
"key": "abc123",
"warehouse": "wh0",
"account_id": "",
"order_id": "1"
}
Example response
{
"status": "successful",
"shipments": [{
"order": {
"order_id": "1",
"order_number": "jav_4160_XCHG_cp",
"order_reference": "",
"date": "2019-02-06 21:28:00",
"seller_name": "Etail Fulfillment",
"order_comments": "",
"currency": "usd",
"warehouse": "wh0",
"comments_warehouse": null,
"url_logo": null,
"label_ready": null
},
"customer": {
"title": "",
"first_name": "Jav",
"last_name": "Gar",
"email": "x@x.com",
"company": "Cust Company",
"phone": "123",
"address1": "123 Campbellton",
"address2": "",
"city": "Durham",
"state": "NC",
"zip": "20777",
"country": "US"
},
"billing": {
"title": "",
"first_name": "",
"last_name": "",
"email": "",
"company": "",
"phone": "",
"address1": "",
"address2": "",
"city": "",
"state": "",
"zip": "",
"country": ""
},
"seller": {
"title": "",
"first_name": "Peter",
"last_name": "Parker",
"email": null,
"phone": "9192911940",
"company": "Etail Fulfillment",
"department": "210",
"address1": "106 B Capitola Dr.",
"address2": "106 B Capitola Dr.",
"city": "Durham",
"state": "NC",
"zip": "27713",
"country": ""
},
"shipments": [{
"shipment_id": "1",
"shipment_number": "jav_4160_XCHG_cp",
"shipping_method": "PMD",
"shipping_method_description": "USPS Priority Mail (2-3)",
"shipping_carrier": "USPS",
"services": {
"insurance": "",
"require_signature": "No",
"saturday_delivery": "No",
"residential": "No",
"third_party_account": null,
"third_party_zip": null,
"third_party_country": null
},
"boxes": [{
"id": "1",
"box_number": "jav_4160_XCHG_cp",
"total_weight": "200.0000",
"length": "6.0000",
"width": "4.0000",
"height": "4.00",
"package_type": "Box",
"category": "Apparel, shoes, jewelry",
"products": [{
"sku": "S00063",
"upc": "",
"description": "test",
"quantity": "1",
"sold_price": "5.00",
"country_orig": "US",
"harmonization": "",
"weight": "0.3000",
"bin": "Z1-140(1)"
}, {
"sku": "Serial1",
"upc": "",
"description": "serial1",
"quantity": "3",
"sold_price": "1.00",
"country_orig": "US",
"harmonization": "",
"weight": "1.0000",
"bin": "A1-101(3)"
}, {
"sku": "Serial2",
"upc": "",
"description": "test serial2",
"quantity": "1",
"sold_price": "1.00",
"country_orig": "US",
"harmonization": "",
"weight": "1.0000",
"bin": "A02-01B01(1)"
}]
}]
}]
}]
}
Get shipment out
This endpoint is intended to retrieve details for orders that are in a Shipped status. It includes information such as the destination address, carrier/method, box and SKU details, etc.
At this time, this endpoint does not support multi-box shipments and will not return all box details. If an order is not in a Shipped status the response body may not return all the expected details. For orders in a Processing status we suggest using POST /get_shipment_in instead.
- POST /get_shipment_out
Parameters
| Parameter | Type | Description |
|---|---|---|
| username (*) | varchar | Admin or other authorized username. This parameter is only required when being used by a WMS user. |
| key (*) | varchar | Your warehouse API Key. |
| warehouse (*) | varchar | Your Shipedge WMS. |
| account_id (*) | int | The OMS account ID associated with the order(s). |
| order_id | varchar | Ship Number of the order you wish to retrieve details for. |
| order_number | varchar | Order Number of the order you wish to retrieve details for. |
| from_date | datetime | This will return orders based on the Shipped Date of the order. Format yyyy-mm-dd hh:mm:ss. |
* Indicates a required parameter.
Note: Choose only one parameter to search by: order_id or order_number. If an OMS user wishes to utilize this endpoint, they can exclude the username parameter and use their OMS API key instead. See examples below.
Example request (WMS users)
{
"username": "wh0",
"key": "wms123456789",
"warehouse": "wh0",
"account_id": 1,
"order_id": "1"
}
Example request (OMS users)
{
"key": "oms123456789",
"warehouse": "wh0",
"account_id": 1,
"order_id": "1"
}
Example response
{
"status": "successful",
"shipments": [{
"order": {
"order_id": "1",
"order_number": "1",
"order_reference": "",
"date": "2019-08-29 00:00:00",
"seller_name": null,
"order_comments": "",
"currency": "usd",
"warehouse": "demo1",
"comments_warehouse": null,
"url_logo": null,
"label_ready": null
},
"customer": {
"title": "",
"first_name": "Bruce",
"last_name": "Wayne",
"email": "bruce@shipedge.com",
"company": "Shipedge",
"phone": "123456789",
"address1": "4364 S Alston Ave.",
"address2": "Suite 120",
"city": "Durham",
"state": "NC",
"zip": "27713",
"country": "United States"
},
"billing": {
"title": "",
"first_name": "Bruxe",
"last_name": "Wayne",
"email": "",
"company": "Shipedge",
"phone": "",
"address1": "4364 S Alston Ave.",
"address2": "Suite 120",
"city": "Durham",
"state": "NC",
"zip": "27713",
"country": "United States"
},
"seller": {
"title": "",
"first_name": "",
"last_name": "",
"email": null,
"phone": null,
"company": "",
"department": "210",
"address1": null,
"address2": null,
"city": null,
"state": null,
"zip": null,
"country": null
},
"shipments": [{
"shipment_id": "1",
"shipment_number": "123",
"shipping_method": "PMD",
"shipping_method_description": "USPS Priority Mail (2-3)",
"shipping_carrier": "ezUSPS",
"tracking_number": "123456",
"services": {
"insurance": "NO",
"require_signature": "NO",
"saturday_delivery": "No",
"residential": "YES"
},
"boxes": [{
"id": "1",
"box_number": "1",
"total_weight": null,
"length": "1.81",
"width": "1.81",
"height": "1.81",
"package_type": null,
"category": "no products",
"products": []
}]
}]
}]
}