# Orders API API

> Orders API API on Apizie: 9 endpoints (Get all orders, Get all released orders, Get released orders for next page, Get an order, …) returned as clean JSON through one API key. 9 endpoints are live now. Call it over REST at https://www.apizie.tech/v1/ecommerce:walmart-order/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `ecommerce:walmart-order`
- Category: E-commerce
- Status: live
- Source: https://walmart.com
- Page: https://www.apizie.tech/api/ecommerce/walmart-order
- OpenAPI: https://www.apizie.tech/api/ecommerce/walmart-order/openapi.json

Please make sure you use the correct version of the APIs for your use case. To find out the appropriate version, go to the API Docs drop down on the menu.

## Endpoints

### Get all orders
`GET https://www.apizie.tech/v1/ecommerce:walmart-order/get-all-orders`

| Parameter | Type | Required | Description |
|---|---|---|---|
| shipNode | string | no | Ship Node |
| sku | string | no | Retrieves all orders with the specified SKU. |
| customerOrderId | string | no | Retrives the details of the specified customerOrderId. |
| purchaseOrderId | string | no | The purchase order ID associated with the order to retrieve. One customer order can have multiple purchase orders associated with it. |
| status | string | no | The list of orders corresponding to the requested status. |
| createdStartDate | string | no | Limit orders to those created after this date or a timestamp. |
| createdEndDate | string | no | Limit orders to those created before this date or timestamp. |
| fromExpectedShipDate | string | no | Limit orders to those that have order lines with an expected ship date after this date. |
| toExpectedShipDate | string | no | Limit orders to those that have order lines with an expected ship date before this date. |
| limit | integer | no | The number of orders to be returned. Do not set this parameter to over 200 orders. |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |

### Get all released orders
`GET https://www.apizie.tech/v1/ecommerce:walmart-order/get-released-orders`

| Parameter | Type | Required | Description |
|---|---|---|---|
| shipNode | string | no | Ship Node |
| createdStartDate | string | yes | Limit orders to those created after this date or a timestamp. |
| limit | integer | no | The number of orders to be returned. Do not set this parameter to over 200 orders. |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |

### Get released orders for next page
`GET https://www.apizie.tech/v1/ecommerce:walmart-order/get-next-cursor-released-orders`

| Parameter | Type | Required | Description |
|---|---|---|---|
| nextCursor | string | yes | Used for pagination when there are more than 200 orders to retrieve. The nextCursor value of the returned response includes a link to… |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |

### Get an order
`GET https://www.apizie.tech/v1/ecommerce:walmart-order/get-order-by-purchase-order-id`

| Parameter | Type | Required | Description |
|---|---|---|---|
| purchaseOrderId | string | yes | Purchase Order ID |
| shipNode | string | no | Ship Node |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |

### Acknowledge orders
`POST https://www.apizie.tech/v1/ecommerce:walmart-order/acknowledge-orders`

| Parameter | Type | Required | Description |
|---|---|---|---|
| purchaseOrderId | string | yes | Purchase Order ID |
| shipNode | string | no | Ship Node |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |

### Cancel order lines
`POST https://www.apizie.tech/v1/ecommerce:walmart-order/cancel-order`

| Parameter | Type | Required | Description |
|---|---|---|---|
| purchaseOrderId | string | yes | Purchase Order ID |
| shipNode | string | no | Ship Node |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |
| body | string | yes | XML request body (string) |

### Refund order lines
`POST https://www.apizie.tech/v1/ecommerce:walmart-order/refund-order`

| Parameter | Type | Required | Description |
|---|---|---|---|
| purchaseOrderId | string | yes | Purchase Order ID |
| shipNode | string | no | Ship Node |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |
| body | string | yes | XML request body (string) |

### Shipping updates
`POST https://www.apizie.tech/v1/ecommerce:walmart-order/shipping-order`

| Parameter | Type | Required | Description |
|---|---|---|---|
| purchaseOrderId | string | yes | Purchase Order ID |
| shipNode | string | no | Ship Node |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |
| body | string | yes | XML request body (string) |

### Get orders for next page
`GET https://www.apizie.tech/v1/ecommerce:walmart-order/get-all-orders-next`

| Parameter | Type | Required | Description |
|---|---|---|---|
| nextCursor | string | yes | Used for pagination when there are more than 200 orders to retrieve. The nextCursor value of the returned response includes a link to… |
| WM_CONSUMER.CHANNEL.TYPE | string | yes | Channel Type |
| WM_CONSUMER.ID | string | yes | Your Consumer ID |
| WM_SEC.TIMESTAMP | string | yes | Epoch timestamp |
| WM_SEC.AUTH_SIGNATURE | string | yes | Authentication signature |
| WM_SVC.NAME | string | yes | The Service name |
| WM_QOS.CORRELATION_ID | string | yes | A Transaction ID |

## Example
```
curl "https://www.apizie.tech/v1/ecommerce:walmart-order/get-all-orders" \
  -H "x-api-key: $APIZIE_KEY"
```

## FAQ

### How do I call the Orders API API?
Create a free Apizie key, then send GET https://www.apizie.tech/v1/ecommerce:walmart-order/get-all-orders with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Orders API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card.

### Can AI agents use the Orders API API?
Yes. Add the Apizie MCP server (https://www.apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key ecommerce:walmart-order.

### What is the status of the Orders API API?
Live: works with just an Apizie key
