Remove item from order

Parameters

• idpath · stringrequired

  The order's order_id, or its portal_order_id (ord_…): either resolves the same order. An id the order answered to before it was re-routed resolves too.

• itemIdpath · stringrequired

  Item ID

• Idempotency-Keyheader · string (uuid)

  Unique key for idempotent requests. If you retry a request with the same key within 24 hours, you receive the original response. The key is bound to the request payload: reusing it for a different payload returns 422 idempotency_key_reuse rather than the original response, so a changed request is never silently dropped. The binding is over the JSON's content, not its bytes — keys in another order or other whitespace are the same request. Generate a new key for each new request. On an operation that moves money (an order, a batch, an item, a shipping or address change, a cancellation's refund), a key that cannot be checked because the idempotency ledger is unreachable is answered 503 idempotency_unavailable with Retry-After, and nothing runs or is charged: retry with the same key.

Request

curl -X DELETE "https://printedsimply.com/api/v1/test_ord_wVK9ZiG-VYiPrlSeBUBmrUVk/item/itm_fowT5-1iZwSnQcGX0ByoA64l/cancel" \
  -H "x-api-key: ps_test_YOUR_KEY" \
  -H "Idempotency-Key: cancel-item-$(date +%s)"

Response 200

{
  "status": "success",
  "data": {
    "item_id": "itm_vNx36IWd8kx2dCQqkFbsTVg3",
    "refunded": "$0.00",
    "refunded_cents": 0,
    "test_mode": true
  },
  "request_id": "4e3753e1-48dd-4313-bfd8-48e4af4e116a"
}

Errors

• 401invalid_api_keymissing_api_keykey_expired

  Missing, invalid or expired API key: missing_api_key (none sent), invalid_api_key (unknown or revoked), key_expired (past the expiry set when it was created; create a new key).

• 404

  Resource not found

• 409order_not_modifiableconcurrent_modification

  order_not_modifiable — the order has gone into production (or later), past the point where items can be removed. concurrent_modification — another change to this order's lines (a quantity change, a cancel, an added line) did not finish within a few seconds, or, on a test order (which the plant never sees), changed this line while it ran: nothing was removed or refunded. Read the order and retry.

• 422below_cost_floor

  below_cost_floor — on our own plant, the order this cancel would leave costs more to make and ship than it was charged, at worst-case postage on today's season (one 8×10 or 9×11 poster alone in the carriers' peak window, which checkout refuses too). Nothing was cancelled or refunded; details.skus names the lines that would be left and details.contribution_cents how far short they fall. Cancel the whole order instead (DELETE /v1/order/{id}/cancel).

• 429rate_limit_exceededdaily_quota_exceeded

  Rate limit exceeded. Two windows can produce this status and error.code says which: rate_limit_exceeded for the per-minute sliding window, daily_quota_exceeded for the plan's daily quota. Both carry Retry-After; the daily one also carries X-Daily-Limit and X-Daily-Remaining. The per-minute limits are plan-based — see Rate Limits above, or call GET /v1/me for this credential's own figures.

• 500refund_failedsettlement_recording_failed

  refund_failed — the item was removed at the plant and from the order, but its refund went through only in part or not at all (details.refunded_cents of details.owed_cents); the rest is retried automatically. Do not retry the cancellation. settlement_recording_failed — the item was removed at the plant and its refund, if any, was sent, but the order's record could not follow it (among the reasons, another change landed on this line while the cancel ran, and the line was not removed over it): do not retry; read the order and quote the request_id to support.

• 501not_supported_by_provider

  not_supported_by_provider — the order was produced by an independent network shop, which does not accept amendments at all. Never retryable, unlike the 409.

• 502

  Production system error

• 503order_lock_unavailableidempotency_unavailable

  order_lock_unavailable — changes to one order's lines are taken one at a time, and whether another was in progress could not be checked, so nothing was changed, charged or refunded and the production system was not asked; retry the same request after Retry-After. Sent with or without an Idempotency-Key. idempotency_unavailable — the request carried an Idempotency-Key and the ledger that makes it mean at-most-once could not be reached, so nothing ran and nothing was charged; retry the same request with the same key after Retry-After.