AfterShip Products API

The Products API from AfterShip — 4 operation(s) for products.

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 /products Create a product with variants · Create a product #

Ask an LLM

“How do I add a new product to my store catalog?”

“What's required to create a product, like images and variants?”

Tell an agent

Create product {title} with images {image_urls} and variants {variants}.

Add a product to store {store} with variants {variants}.

GET /products List or search products in a store · Get products #

Ask an LLM

“How do I list the products in my store?”

“Can I search products by keyword or show only published ones?”

Tell an agent

List products in store {store}.

Search products for {search}.

GET /products/{id} Get a product by ID · Get product by ID #

Ask an LLM

“What are the details of a specific product?”

“Can I look up one product and its variants by ID?”

Tell an agent

Show product {id}.

Get product {id} from store {store}.

PATCH /products/{id} Update a product's details · Update product by ID #

Ask an LLM

“Can I change a product's title or description?”

“How do I unpublish a product?”

Tell an agent

Rename product {id} to {title}.

Set product {id} published to {published}.

POST /products/{id}/variants Add a variant to a product · Create a new product variant #

Ask an LLM

“How do I add a new size or color variant to a product?”

“Can a new variant allow backorders?”

Tell an agent

Add variant {variant_id} with SKU {sku} priced {price}.

Create a new product variant {title} with {available_quantity} in stock.

GET /products/{id}/variants/{variant_id} Get a product variant · Get variant by ID #

Ask an LLM

“What are the details of one variant of a product?”

“Can I retrieve a single product variant by its ID?”

Tell an agent

Get a specific product variant from store {store}.

Show the price and stock of one product variant.

PATCH /products/{id}/variants/{variant_id} Update a product variant · Update product variant #

Ask an LLM

“How do I change a variant's price or stock level?”

“Can I update a variant's compare-at price?”

Tell an agent

Set the variant price to {price}.

Update the variant's available quantity to {available_quantity}.

DELETE /products/{id}/variants/{variant_id} Delete a product variant · Delete product variant #

Ask an LLM

“How do I remove a variant I no longer sell?”

“Can I delete one variant without deleting the product?”

Tell an agent destructive · confirm first

Delete a product variant in store {store}.

Remove a discontinued variant from its product.

AfterShip Products 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