Status 422
Idempotency key is invalid
invalid_idempotency_key
When it happens
The Idempotency-Key header could not be read: a key is 1 to 255 visible ASCII characters, sent as a token or a quoted string.
What to do
Send a unique key per request, such as a UUID.
Can’t find the answer, or the error keeps coming back? Write to us and quote the X-Request-Id from the response so we can find the request. Contact us
Endpoints that return it
- post
/categoriesCreate a catalog category - patch
/categories/{category}Change a catalog category - delete
/categories/{category}Archive a catalog category - patch
/categories/by-external-id/{external_id}Create or change a catalog category by its external ID - post
/productsCreate a product with its variants - patch
/products/{product}Change a product card: fields, categories, external ID - delete
/products/{product}Archive a product with its variants - patch
/products/by-external-id/{external_id}Create or update a product with its variants by its external ID - put
/products/{product}/optionsReplace the product options and lay out its variants - post
/variantsAdd a variant to a product - patch
/variants/{variant}Update a product variant - delete
/variants/{variant}Archive a product variant - patch
/variants/by-external-id/{external_id}Create or update a variant by its external ID - put
/variants/{variant}/recipeReplace the recipe of a variant: components and the yield of a prep - patch
/products/{product}/media/{media}Move a gallery photo or make it primary - delete
/products/{product}/media/{media}Remove a photo from the product gallery - post
/products/{product}/mediaAdd a photo to the product gallery from an image URL - post
/modifier-groupsCreate a modifier group with options - patch
/modifier-groups/{group}Update a modifier group and its option set - delete
/modifier-groups/{group}Archive a modifier group - patch
/modifier-groups/by-external-id/{external_id}Create or update a modifier group by external ID - put
/products/{product}/modifier-groupsReplace the product modifier groups and their option surcharges by variant - post
/recommendation-rulesCreate a recommendation rule - patch
/recommendation-rules/{rule}Change a recommendation rule - delete
/recommendation-rules/{rule}Delete a recommendation rule - post
/price-listsCreate a wholesale price list - patch
/price-lists/{price_list}Update a price list: adjustment and rounding, and the name of a wholesale list; a location list's rule changes prices at all its locations - delete
/price-lists/{price_list}Delete a wholesale price list; its assignment to customers is removed with consent - post
/price-lists/{price_list}/itemsSet fixed variant prices in a price list in bulk - post
/price-lists/{price_list}/items/removeRemove fixed variant prices from a price list in bulk - post
/price-lists/{price_list}/modifier-itemsSet fixed modifier option surcharges in a price list in bulk - post
/price-lists/{price_list}/modifier-items/removeRemove fixed modifier option surcharges from a price list in bulk - post
/inventory-levels/setSet the on-hand quantity of a variant at a location - post
/inventory-levels/adjustReceive stock or write it off at a location - post
/orders/{order}/statusMove an order to another status of the store - post
/orders/{order}/cancelCancel an order - post
/orders/{order}/shipmentIssue the order's shipment with its carrier: the request runs in the background, the outcome shows in the order and arrives with order.updated - post
/orders/{order}/shipment/trackingWrite the tracking number of a delivery service without integration: number, link and service name - post
/orders/{order}/shipment/tracking/clearRemove a manually written tracking number - patch
/draft-orders/{draft}Change a draft order: customer, delivery, payment method and items - delete
/draft-orders/{draft}Delete a draft order - post
/draft-ordersCreate a draft order for a customer - post
/draft-orders/{draft}/completePlace the order from a draft: invoice the customer or record the payment as received - post
/payments/{payment}/confirmConfirm that the money of a pending invoice was received - post
/orders/{order}/refunds/calculateCalculate an order refund and what is left to refund, without writing anything - post
/orders/{order}/refundsRefund order items and delivery: money goes back by the payment methods, goods go back to stock - post
/refunds/{refund}/confirmConfirm that the refund money was paid back outside the system - post
/customersCreate a customer: a name and at least one contact - patch
/customers/{customer}Update a customer's name, language and external ID - patch
/customers/by-external-id/{external_id}Create or update a customer by its external ID - post
/customers/{customer}/wholesale-price-listAssign a wholesale price list to a customer or remove it - patch
/customers/{customer}/addresses/{address}Update a customer's address - delete
/customers/{customer}/addresses/{address}Delete an address from a customer's address book - post
/customers/{customer}/addressesAdd an address to a customer's address book - put
/customers/{customer}/fiscal-profileReplace a customer's tax details; null makes them a retail customer - post
/customer-groupsCreate a customer group - patch
/customer-groups/{customer_group}Change a group's name, description or activity - delete
/customer-groups/{customer_group}Delete a group: its memberships go with it, and discount rules and broadcasts stop targeting it - post
/customer-groups/{customer_group}/membersAdd customers to a group - post
/customer-groups/{customer_group}/members/removeRemove customers from a group - post
/orders/{order}/invoiceIssue the invoice of a closed sale: issuing runs in the background, the outcome comes as an event - post
/fiscal-documents/{document}/reissueReissue a document after a failure or a rejection by the tax authority - post
/fiscal-documents/{document}/dismissDismiss a rejected document: it will not be issued - post
/fiscal-documents/{document}/annulAnnul an issued invoice with a credit note - post
/money-transactionsRecord manual income or expense on a money account - patch
/money-transactions/{transaction}Update a money transaction: only the category, counterparty and description of a transaction with a source document - delete
/money-transactions/{transaction}Delete a manual money transaction and restore the account balance - patch
/money-transfers/{money_transfer}Update a whole transfer in place: accounts, amounts, fee, date and description - delete
/money-transfers/{money_transfer}Delete a transfer with all its legs - post
/money-transfersTransfer money between accounts, with or without a fee - post
/customer-accounts/{customer_account}/paymentsRecord a customer debt payment with money already received: an entry in the receivables book with withholding certificates - post
/suppliersCreate a supplier: tax details and payment terms - patch
/suppliers/{supplier}Update a supplier's tax details, payment terms and external ID - patch
/suppliers/by-external-id/{external_id}Create or update a supplier by its external ID - post
/supplier-billsCreate a draft supplier bill - patch
/supplier-bills/{supplier_bill}Change a draft supplier bill - delete
/supplier-bills/{supplier_bill}Delete a draft supplier bill - post
/supplier-bills/{supplier_bill}/postPost a supplier bill: it enters payables and the purchase ledger - post
/supplier-bills/{supplier_bill}/voidVoid a supplier bill together with its payments and offsets - post
/supplier-bills/{supplier_bill}/approveApprove a posted supplier bill for payment - post
/supplier-bills/{supplier_bill}/revoke-approvalRevoke the payment approval of a supplier bill - post
/supplier-bills/{supplier_bill}/payments/out-of-bandMark a supplier bill as paid outside the system - delete
/supplier-bills/{supplier_bill}/payments/{supplier_bill_payment}Cancel a supplier bill payment - post
/purchase-ordersCreate a draft purchase order - patch
/purchase-orders/{purchase_order}Change a purchase order: a draft in full, a placed order’s lines, date and note with a revision - delete
/purchase-orders/{purchase_order}Delete a draft purchase order - post
/purchase-orders/{purchase_order}/placeMark a draft as placed with the supplier - post
/purchase-orders/{purchase_order}/cancelCancel a placed purchase order - post
/purchase-orders/{purchase_order}/closeClose a received purchase order - post
/uploadsStart a chunked file upload — the input of a bulk operation - post
/uploads/{upload}/chunksAppend a file chunk as the raw body - post
/bulk-operationsStart a bulk operation from an upload or an input address, a feed export or a file build - post
/bulk-operations/{operation}/cancelCancel a bulk operation at a line boundary - post
/webhook-endpointsAdd a webhook endpoint and subscribe it to event types - patch
/webhook-endpoints/{endpoint}Update a webhook endpoint: URL, description, event types, status - delete
/webhook-endpoints/{endpoint}Delete a webhook endpoint - post
/webhook-endpoints/{endpoint}/rotate-secretIssue a new signing secret: the previous one keeps signing deliveries alongside it for 24 hours - post
/webhook-endpoints/{endpoint}/testSend a ping test event to the endpoint — one attempt signed with the current secret - post
/webhook-deliveries/{delivery}/retryRetry the delivery now — the same body and the same webhook-id
Response body
application/problem+json · ValidationProblem
typestringrequiredMachine type of the problem: a stable code to branch on, such as insufficient_scope. Every type has a page in the error catalog.
titlestringrequiredShort summary of the problem in the language of the request.
statusintegerrequiredHTTP status of the response.
detailstringExplanation of this occurrence in the language of the request.
errorsmap of array of stringrequiredInvalid fields: name of the field (nested ones with dots, such as variants.0.price) → messages.