WMS Orders API RESTful v3 / Get order by order number
Version 3, last updated on 05-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
http://<integration>.shipedge.com/API/Rest/v3/Orders/
Get Order
Ping to check the system status.
- POST /get_order
Parameters
| Parameter | Type | Description |
|---|---|---|
| username (*) | varchar | Admin or other authorized username |
| key (*) | varchar | Your warehouse API Key |
| warehouse (*) | varchar | Your Shipedge WMS |
| order_number (*) | int | The Order Number you wish to look up |
Example request
{
"username": "test",
"key": "123abc",
"warehouse": "whx",
"order_number": "123"
}
Example response
{
"status": "successful",
"http_code": 200,
"order":
{
"orders":
[
{
"order_id": "99999",
"order_number": "99999",
"reference_number": "",
"date": "2024-03-28 09:50:21",
"status":
{
"id": "3",
"description": "pending"
},
"cart":
[],
"pending_date": "2024-03-28 09:50:21",
"shipping_date": null,
"last_update": "2024-05-03 06:25:17",
"order_comments": "",
"cod_amount": "",
"billing":
{
"first_name": "John",
"last_name": "Doe",
"address1": "456 Elm Street",
"address2": "",
"city": "Metropolis",
"state": "NC",
"zip": "12345",
"country": "US"
},
"customer":
{
"first_name": "John",
"last_name": "Doe",
"company": "",
"address1": "456 Elm Street",
"address2": "",
"email": "john@example.com",
"phone": "123-456-7890",
"city": "Metropolis",
"state": "NC",
"zip": "12345",
"country": "US"
},
"shipping":
{
"method": "EUSFCD",
"description": "USPS Ground Advantage",
"tracking_number": ""
},
"label":
[],
"items":
[
{
"item_id": "98765",
"sku": "FakeTest",
"quantity": "1",
"sold_price": "0.00",
"description": "Testing sample data generation.",
"attributes":
[],
"product":
{
"product_id": "67890",
"account_id": "123",
"sku": "FakeTest",
"upc": null,
"description": "Testing sample data generation.",
"harmonization_code": "",
"quantity_in_warehouse": "-8",
"quantity_available": "1",
"quantity_hurt": "0",
"quantity_shipped": "11",
"cost": "0.00",
"retail": "0.00",
"discontinued": "N",
"discontinued_date": null,
"created_date": "2024-03-28 09:06:13",
"updated_date": "2024-05-03 06:25:17",
"weight": "5.0000",
"width": "5.000",
"height": "5.000",
"length": "5.000",
"origin_country": null,
"distribution_center":
{
"id": "1",
"name": "DC1"
},
"supplier":
{
"id": null,
"name": null
},
"package_type":
{
"id": null,
"name": null
},
"serials":
[],
"attributes":
[]
}
}
],
"attributes":
[
{
"id": "100000",
"attributte_name": "total",
"attribute_value": "2",
"description": "_total_"
},
{
"id": "100001",
"attributte_name": "subtotal",
"attribute_value": "0",
"description": "_subtotal_"
},
{
"id": "100002",
"attributte_name": "shipping cost",
"attribute_value": "0",
"description": "_shipping_"
},
{
"id": "100003",
"attributte_name": "handling estimate",
"attribute_value": "2.00",
"description": "_handling_"
}
],
"account":
{
"account_id": "123",
"account_name": "dreamworld",
"company_name": "Dream World",
"contact_name": "James Dreamer",
"address1": "789 Fantasy Road",
"address2": "Suite 300",
"city": "Metropolis",
"state": "NC",
"postal_code": "12345",
"country": "United States",
"phone": "123-456-7890",
"email": "contact@dreamworld.com",
"activated": "true",
"attributes":
[]
}
}
]
}
}
Note: All matching order numbers will be returned regardless of their OMS account or order status.