AfterShip Orders API

The Orders API from AfterShip — 4 operation(s) for orders.

Documentation GitHub OpenAPI

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /orders Create an order · Create an order #

Ask an LLM

“How do I push a new order into AfterShip for tracking and returns?”

“What fields are required when I create an order?”

Tell an agent

Create order number {number} in {currency} totaling {order_total} with items {items}.

Add order {number} to store {store} with delivery method {delivery_method}.

GET /orders List orders in a store · Get orders #

Ask an LLM

“How do I pull a list of orders from my store?”

“Can I fetch several specific orders at once by their IDs?”

Tell an agent

List orders in store {store}.

Get orders {ids} sorted by {sort}.

GET /orders/{id} Get an order by ID · Get order by ID #

Ask an LLM

“What are the details of a specific order?”

“Can I look up one order by its ID?”

Tell an agent

Show order {id} from store {store}.

Get order {id}.

PATCH /orders/{id} Update an order's details or status · Update order by ID #

Ask an LLM

“Can I change the shipping address on an order I already created?”

“How do I update an order's financial or fulfillment status?”

Tell an agent

Update the shipping address of order {id} to {shipping_address}.

Set order {id} fulfillment status to {fulfillment_status}.

POST /orders/{id}/items Add a line item to an order · Create an order item #

Ask an LLM

“How do I add another product line to an existing order?”

“Can I include an HS code and origin country on a new order item?”

Tell an agent

Add {quantity} of {product_title} to order {id} as item {item_id}.

Create item {item_id} with SKU {sku} on order {id}.

GET /orders/{id}/items/{item_id} Get one line item from an order · Get order item by ID #

Ask an LLM

“What are the details of a single item within an order?”

“Can I look up one order line item by its ID?”

Tell an agent

Show item {item_id} on order {id}.

Get order {id} line item {item_id} from store {store}.

PATCH /orders/{id}/items/{item_id} Update an order line item · Update order item by ID #

Ask an LLM

“Can I change the quantity of an item on an order?”

“How do I correct the price or SKU of an order line?”

Tell an agent

Change the quantity of item {item_id} on order {id} to {quantity}.

Set the unit price of order {id} item {item_id} to {unit_price}.

DELETE /orders/{id}/items/{item_id} Delete a line item from an order · Delete an order item #

Ask an LLM

“How do I remove a product line from an order?”

“Can I delete a single item without deleting the whole order?”

Tell an agent destructive · confirm first

Delete item {item_id} from order {id}.

Remove line {item_id} from order {id} in store {store}.

AfterShip Orders API

Operations 8

Documentation

Specifications

Schemas & Data

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification