POD Mfg Partner API

GET /me

Who this key is (a connection test)

Your brand, the key's mode and scopes, and whether a card is on file.

Answers Merchant

• 200 The merchant behind the key.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /products

List published products

Your published products, newest first, each with its variants. Needs products:read. Unknown query parameters are refused (400 parameter_unknown).

Answers ProductList

• 200 A page of products.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /products/{id}

One published product

The product with its variants, mockup images and prices. Needs products:read.

Answers Product

• 200 The product.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /variants/{id}

One variant

A variant of a published product. Needs products:read.

Answers Variant

• 200 The variant.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

PATCH /variants/{id}

Set your own SKU for a variant

The only change allowed on products in v1. external_sku is unique among your variants (409 external_sku_taken); null clears it. Orders may name a variant by its id, our sku or your external_sku. Needs orders:write.

Body object

{
  "external_sku": "TEAM-TEE-NAVY-M"
}

Answers Variant

• 200 The updated variant.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /orders

List orders

Your orders in the key's mode (a test key sees test orders only), newest first. Needs orders:read.

Answers OrderList

• 200 A page of orders.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /orders

Create an order

Needs orders:write. Each line names exactly one of variant_id, sku (ours) or external_sku (yours); unknown fields are refused. Answers 201 with the order, its status and the charge result: a live order is charged now (charge.status succeeded → status: paid; failed → status: payment_failed, retried automatically; pending → Stripe is still working on it). A held order (on_hold) isn't charged until we release it.

Body OrderCreate

{
  "external_order_id": "1042",
  "external_order_url": "https://merchant-admin.example.com/orders/1042",
  "line_items": [
    {
      "external_line_id": "li_1",
      "quantity": 2,
      "retail_price": 2800,
      "variant_id": "var_31xaQ8dZr0mJxWb7fKp2sT"
    }
  ],
  "metadata": {
    "anything": "merchant wants echoed back"
  },
  "packing_slip": {
    "message": "Thanks for supporting the team!",
    "show_prices": false
  },
  "ship_to": {
    "address1": "123 Main St",
    "address2": "Apt 4",
    "city": "Irvine",
    "company": null,
    "country": "US",
    "email": "jane@example.com",
    "name": "Jane Smith",
    "phone": "+19495551234",
    "postal_code": "92618",
    "state": "CA"
  },
  "shipping_method": "standard"
}

Answers Order

• 201 The order.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 422 Well-formed but can't be done (address_invalid, country_not_supported, variant_not_found, sku_not_found, external_sku_not_found, variant_not_available, price_unavailable, shipping_method_unavailable, personalization_unsupported, amount_too_small, url_not_allowed).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.
• 503 Payments, shipping quotes or webhook set-up are offline for a moment (payments_unavailable, shipping_unavailable, webhooks_unavailable). Retry with the same Idempotency-Key.

POST /orders/estimate

Price an order without making it

The same body as POST /orders (external_order_id optional). Answers the wholesale total, shipping and tax, and whether the order would be held. Nothing is stored or charged. Needs orders:write or orders:read.

Body OrderEstimateRequest

{
  "line_items": [
    {
      "quantity": 12,
      "sku": "PMG-ST350-NAV-M-8F2KA19C0D"
    }
  ],
  "ship_to": {
    "address1": "123 Main St",
    "city": "Irvine",
    "country": "US",
    "name": "Jane Smith",
    "postal_code": "92618",
    "state": "CA"
  },
  "shipping_method": "standard"
}

Answers OrderEstimate

• 200 The estimate.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 422 Well-formed but can't be done (address_invalid, country_not_supported, variant_not_found, sku_not_found, external_sku_not_found, variant_not_available, price_unavailable, shipping_method_unavailable, personalization_unsupported, amount_too_small, url_not_allowed).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.
• 503 Payments, shipping quotes or webhook set-up are offline for a moment (payments_unavailable, shipping_unavailable, webhooks_unavailable). Retry with the same Idempotency-Key.

GET /orders/{id}

One order

Status, the price snapshot, charges, refunds and shipments. Needs orders:read.

Answers Order

• 200 The order.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /orders/{id}/cancel

Cancel an order before production

Allowed until the order is in_production; a paid order is refunded in full. Cancelling a cancelled order answers it again. After production starts: 409 order_not_cancellable (contact us). Needs orders:write.

Body object

Answers Order

• 200 The cancelled order (with its refund).
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /orders/{id}/retry_payment

Charge a failed order again

For a live order that is payment_failed, or on_hold with payment_failed_final (e.g. after you saved a new card). Answers the paid order, or 402 payment_failed when the card is declined again. Test orders: a simulated failure (POST /orders/{id}/simulate/payment_failed) retries into simulated success (order.paid); any other test order is 409 test_mode. Needs orders:write.

Answers Order

• 200 The order after the charge.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 402 The card was declined again (payment_error, payment_failed). The order's charge says why.
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /events

List events

The events of the key's mode, newest first, exactly as they were (or would have been) sent: to poll, or to backfill after your endpoint was down. Kept 30 days. Needs orders:read.

Answers EventList

• 200 A page of events.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /events/{id}

One event

The envelope exactly as sent. Needs orders:read.

Answers Event

• 200 The event.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /events/{id}/resend

Send an event again

To one endpoint (webhook_endpoint_id) or to every active endpoint of the key's mode that wants the event's type. Each delivery starts the retry schedule again; it goes out within seconds. 409 no_webhook_endpoint when no active endpoint wants it. Needs orders:write.

Body object

Answers object

• 200 Queued.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

GET /webhook_endpoints

List webhook endpoints

Your endpoints in the key's mode, newest first. Never the secrets. Needs orders:write.

Answers WebhookEndpointList

• 200 A page of endpoints.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /webhook_endpoints

Add a webhook endpoint

In the key's mode (a test key makes a test endpoint). Live endpoints must be https; the host must be a public address. Answers the endpoint with its signing secret, the only time it is shown (a replay with the same Idempotency-Key answers secret: null). At most 16 endpoints per mode. Needs orders:write.

Body WebhookEndpointCreate

{
  "description": "Order system",
  "enabled_events": [
    "order.shipped",
    "order.payment_failed",
    "order.cancelled"
  ],
  "url": "https://merchant.example.com/podmfg/webhooks"
}

Answers WebhookEndpointWithSecret

• 201 The endpoint, with its secret.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 422 Well-formed but can't be done (address_invalid, country_not_supported, variant_not_found, sku_not_found, external_sku_not_found, variant_not_available, price_unavailable, shipping_method_unavailable, personalization_unsupported, amount_too_small, url_not_allowed).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.
• 503 Payments, shipping quotes or webhook set-up are offline for a moment (payments_unavailable, shipping_unavailable, webhooks_unavailable). Retry with the same Idempotency-Key.

GET /webhook_endpoints/{id}

One webhook endpoint

Needs orders:write.

Answers WebhookEndpoint

• 200 The endpoint.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

PATCH /webhook_endpoints/{id}

Change a webhook endpoint

Any of url, enabled_events, description (null clears it), status (active / disabled). Turning an endpoint back on forgets its failures and resumes deliveries that were waiting. Needs orders:write.

Body WebhookEndpointUpdate

{
  "enabled_events": [
    "*"
  ]
}

Answers WebhookEndpoint

• 200 The endpoint.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 422 Well-formed but can't be done (address_invalid, country_not_supported, variant_not_found, sku_not_found, external_sku_not_found, variant_not_available, price_unavailable, shipping_method_unavailable, personalization_unsupported, amount_too_small, url_not_allowed).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

DELETE /webhook_endpoints/{id}

Delete a webhook endpoint

Nothing more is sent to it; deliveries still waiting end as failed. Needs orders:write.

Answers object

• 200 Deleted.
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /webhook_endpoints/{id}/rotate_secret

Rotate an endpoint's signing secret

A new secret, shown once in this answer; deliveries are signed with it from now on (the old one stops at once; update your handler first, or accept both while you switch). Needs orders:write.

Answers WebhookEndpointWithSecret

• 200 The endpoint, with its new secret.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.
• 503 Payments, shipping quotes or webhook set-up are offline for a moment (payments_unavailable, shipping_unavailable, webhooks_unavailable). Retry with the same Idempotency-Key.

POST /orders/{id}/simulate/cancel

Test mode: POD Mfg cancels a test order

Cancels the order as POD Mfg staff would (reason: cancelled_by_pod_mfg) and sends order.cancelled, so you can test an order you did not cancel yourself. Allowed before production, like POST /orders/{id}/cancel. Test keys and test orders only (a live key: 403 test_mode_only; a live order's id is not found with a test key). No body. Needs orders:write. Wrong state: 409 order_state.

Answers Order

• 200 The test order after the simulation.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /orders/{id}/simulate/payment_failed

Test mode: fail a test order's payment

The simulated payment fails: the order becomes payment_failed (status_reason: card_declined, charge.status: failed) and order.payment_failed is sent. Then POST /orders/{id}/retry_payment simulates success (order.paid), or cancel it. No card is involved. Needs the order paid. Test keys and test orders only (a live key: 403 test_mode_only; a live order's id is not found with a test key). No body. Needs orders:write. Wrong state: 409 order_state.

Answers Order

• 200 The test order after the simulation.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

POST /orders/{id}/simulate/ship

Test mode: mark a test order shipped

Makes one simulated parcel for the whole order (carrier USPS, service Ground Advantage, a fake tracking number TEST + 16 digits) and moves the order to shipped. An order.shipped webhook goes to your test endpoints through the same pipeline (signing, retries, delivery log) as a real shipment. Nothing is made or shipped. Needs the order paid. Test keys and test orders only (a live key: 403 test_mode_only; a live order's id is not found with a test key). No body. Needs orders:write. Wrong state: 409 order_state.

Answers Order

• 200 The test order after the simulation.
• 400 The request is malformed (parameter_invalid, parameter_unknown, parameter_missing, body_invalid, line_item_reference, idempotency_key_invalid, resource_missing cursor).
• 401 No key, or not a valid one (api_key_missing, api_key_invalid).
• 403 The key lacks a scope (missing_scope), the brand hasn't accepted the Terms of Service (terms_required), or a simulation was asked with a live key (test_mode_only).
• 404 No such resource for your brand (resource_missing). Another brand's ids are always 404.
• 409 The change clashes with existing data or the order's state (external_sku_taken, duplicate_external_order_id, idempotency_key_reused, idempotency_key_in_use, order_not_cancellable, charge_in_progress, order_not_payable, test_mode, order_state, too_many_webhook_endpoints, no_webhook_endpoint).
• 429 Over 10 requests a second (bursts of 50) for this key, or too many bad keys from your address (rate_limited).
• 500 Our fault (internal_error). Safe to retry reads.

order.events

order.created, order.paid, order.payment_failed, order.on_hold, order.in_production, order.delivered, order.cancelled

Payload: Event

order.shipped

A shipment was recorded (one per shipment)

Payload: Event + object

product.events

product.published, product.updated, product.unpublished (sent in both modes)

Payload: Event

Address

Charge

Error

Event

The envelope of every webhook. data by type. order.shipped: { order_id, external_order_id, shipment: { id, carrier, service, tracking_number, tracking_url, shipped_at, line_items: [{ external_line_id, variant_id, quantity }] }, order_status } (one event per shipment: a partial shipment is its own event). Other order.*: { order_id, external_order_id, order_status, previous_status, reason, occurred_at, order } (order = the Order object when the event was made); order.payment_failed adds failure_code, failure_message, next_retry_at; order.cancelled adds refunded_amount, currency. product.*: { product_id, product_status, product } (product = the Product object; null once unpublished). ping: { webhook_endpoint_id, message }.

EventList

EventType

ping is the Developers page's test event; order.delivered needs a carrier tracking feed (none yet, so it is never sent today).

One of: product.published, product.updated, product.unpublished, order.created, order.paid, order.payment_failed, order.on_hold, order.in_production, order.shipped, order.delivered, order.cancelled, ping

LineItemCreate

Exactly one of variant_id, sku, external_sku.

Merchant

Order

OrderCreate

OrderEstimate

OrderEstimateRequest

The OrderCreate body with external_order_id optional.

OrderList

OrderShippedData

OrderStatus

received → payment_pending → paid → in_production → partially_shipped → shipped → delivered; payment_failed (retrying), on_hold (status_reason: address_review, blank_out_of_stock, payment_failed_final, artwork_issue, manual_review), cancelled, refunded (money returned after shipping).

One of: received, payment_pending, paid, in_production, partially_shipped, shipped, delivered, payment_failed, cancelled, on_hold, refunded

Product

ProductList

Shipping

Variant

WebhookEndpoint

WebhookEndpointCreate

WebhookEndpointList

WebhookEndpointUpdate

WebhookEndpointWithSecret