Example Code
Examples of how to use the API in different programming languages:
This is a REST API that can create orders and get product, inventory, carrier, order and order status data.
Examples of how to use the API in different programming languages:
You can choose to use XML or JSON data. To send XML or JSON, add a "Content-Type" http header set to either "application/xml" or "application/json". To receive XML or JSON, add an "Accept" http header set to either "application/xml" or "application/json".
View order status information
| API | Description |
|---|---|
| GET api/orderstatus?pageNumber={pageNumber}&pageSize={pageSize}&orderedBefore={orderedBefore}&orderedAfter={orderedAfter}&shippedBefore={shippedBefore}&shippedAfter={shippedAfter}&shipToName={shipToName} |
Get order status for all orders placed during the specified date range. |
| GET api/orderstatus/{orderNumber} |
Get order status for a specific order number |
| GET api/orderstatus?externalOrderNumber={externalOrderNumber} |
Get order status for a specific external order number |
| GET api/orderstatus?poNumber={poNumber} |
Get order status for a specific po number |
| GET api/orderstatus?trackingNumber={trackingNumber} |
Get order status for a specific tracking number. |
Get product inventory information.
| API | Description |
|---|---|
| GET api/inventory?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter}&locationId={locationId} |
No documentation available. |
| GET api/inventory/{sku} |
Get inventory details for a specified sku. |
| GET api/inventory?upc={upc} |
Get inventory details for a specified upc. |
| GET api/inventory?manufacturerNumber={manufacturerNumber} |
Get inventory details for a specified manufacturer number. |
| GET api/inventory?itemIdentifier={itemIdentifier} |
Get inventory details for a specified item identifier. First checks the product's Sku then UPC then Manufacturer Number. |
Get available carriers. A Carrier Id is required to create an order.
| API | Description |
|---|---|
| GET api/carrier |
Get a list of all available carriers and their shipping options. An id of a shipping option is required to create an order. |
| GET api/carrier?destinationCountry={destinationCountry}&destinationState={destinationState}&destinationZip={destinationZip}&weight={weight}&length={length}&width={width}&height={height} |
Get a list of carriers and their rates for their shipping options. If the rate is null it means that we were unable to calculate it with the paramters provided. |
| GET api/Carrier/{id} |
Get a specific carrier by id. |
| API | Description |
|---|---|
| GET api/inventoryV2?pageNumber={pageNumber}&pageSize={pageSize}&modifiedAfter={modifiedAfter} |
No documentation available. |
| GET api/inventoryV2/{sku} |
No documentation available. |
| GET api/inventoryV2?upc={upc} |
No documentation available. |
| GET api/inventoryV2?manufacturerNumber={manufacturerNumber} |
No documentation available. |
| GET api/inventoryV2?itemIdentifier={itemIdentifier} |
No documentation available. |
Create new orders and view detailed order information.
| API | Description |
|---|---|
| GET api/packingsliptypes |
No documentation available. |
Explore the category hierarchy
| API | Description |
|---|---|
| GET api/categoryHierarchy |
Get the root category node |
| GET api/categoryHierarchy/{id} |
Get a category node by id |
Get detailed product information.