canonical: https://jentic.com/apis/walmart.com/orders-api

# Walmart Orders API

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. The API exposes 9 endpoints.

## For AI agents

Programmatically get all orders, get all released orders. Covers 9 operations.

## Scope

Does not handle payments, communications, or crm - use for e-commerce only.

## Capabilities

- Get all orders
- Acknowledge orders
- Cancel order lines
- Refund order lines
- Monitor Orders API operational status and events

## Use cases

### E-Commerce Operations

Use the Orders API to perform e commerce operations programmatically. The API provides 9 endpoints covering core functionality including get all orders, get all released orders, get released orders for next page.

Example prompt: Call GET /v3/orders to get all orders

### Automated Version 3 Management

Automate version 3 operations by combining multiple Orders API endpoints. Agents can get all released orders and then get released orders for next page in a single workflow.

Example prompt: Call GET /v3/orders/released to get all released orders, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Orders API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle none tokens manually.

Example prompt: Search Jentic for 'get all orders', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /v3/orders | Get all orders |
| GET | /v3/orders/released | Get all released orders |
| GET | /v3/orders/released{nextCursor} | Get released orders for next page |
| GET | /v3/orders/{purchaseOrderId} | Get an order |
| POST | /v3/orders/{purchaseOrderId}/acknowledge | Acknowledge orders |
| POST | /v3/orders/{purchaseOrderId}/cancel | Cancel order lines |
| POST | /v3/orders/{purchaseOrderId}/refund | Refund order lines |
| POST | /v3/orders/{purchaseOrderId}/shipping | Shipping updates |

## Key resources

- **Version 3** — Operations related to Version 3

## Why Jentic

- **Setup:** Wiring the Walmart Orders API by hand means pointing at the developer.walmart.com order proxy host and authenticating each request yourself. Through Jentic you install once, import the Orders API from the API Directory, store your Walmart credential once, and your agent calls it.
- **Permission scoping:** The Orders API puts the purchase order id in the URL path (/v3/orders/{purchaseOrderId}), so a rule can pin your agent to one order. You choose the operations it may call, so you can allow reading orders and acknowledging them while destructive ones like cancel or refund are not included unless you add them.
- **Credential handling:** Your Walmart credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get all orders' or 'acknowledge an order', and Jentic returns the matching Orders API operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Shopify** — Alternative e commerce API
- **Stripe** — Alternative e commerce API

## FAQ

### What authentication does the Orders API use?

The Orders API uses no authentication. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get all orders with the Orders API?

Yes. Use the GET /v3/orders endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Orders API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get all orders through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get all orders'. Jentic returns the matching Orders API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Orders API have?

The Orders API exposes 9 endpoints covering version 3 operations.

### Can I limit what my agent is allowed to do with the Walmart Orders API?

Yes. Because you run Jentic One yourself, your own rules decide which Orders API operations the agent may call and which Walmart credential it may use. You can allow read operations like GET /v3/orders and the acknowledge order operation while excluding destructive ones such as cancel or refund unless you explicitly add them. Since the endpoints carry the purchase order id in the path (/v3/orders/{purchaseOrderId}), a rule can also pin the agent to a single order.
