OrderInvoiceLink
The POS invoice a platform order became, named by the feed identity the store agent stamped on it: externalId and processorCode are the path value and the processorCode query of GET /v1/invoices/external/{externalId}. The link is a reference, not a grant: it is present whatever the calling key may read, and following it is an ordinary invoice read by feed identity (GET /v1/invoices/external/{externalId}?processorCode=) with that endpoint's own requirements: the sales-data capability and the sales.read scope, a key without a row scope, and the store's per-item data switch. An order-intake key carries only the order-intake capability, so it gets a free 403 capability_not_enabled (nothing reserved, nothing sent to the store); read the invoice with the same store's sales-data key. The store compares both values the way its POS stored them (current TisWin3 databases keep the first 25 characters of the external id and the first 10 of the processor code) and answers 409 invoice_ambiguous rather than guess when two invoices match; 404 invoice_not_found while the store has not turned the order into an invoice yet, or after it deleted it; 422 filter_unsupported at a store below TisWin3 database version 1.324, which keeps neither column. None of these is charged. The POS strips leading zeros from a feed's order id, so the lookup can miss an externalOrderId that starts with 0.
Type: object.
| Name | Type | Description |
|---|---|---|
externalId required | string | The order's externalOrderId, which the store wrote to the invoice's ExternalID. Pattern: ^[A-Za-z0-9][A-Za-z0-9._:#@+-]{0,127}$ |
processorCode required | string | CDAPI: followed by your integration id (at most 50 characters), which the store wrote to the invoice's ProcessorCode. Send it whole; the store cuts it the way its POS did. Pattern: ^[A-Za-z0-9][A-Za-z0-9 ._:#&+@-]{0,49}$ |
url | string (uri) | GET /v1/invoices/external/{externalId}?processorCode= for this order as an absolute URL on the deployment's public base URL, both values already percent-encoded. Present when the deployment knows its public base URL, like a problem's docsUrl. |
No other fields appear.