{"items":[{"type":"link","label":"Last-mile Orders API","link":"/apis/orders","routeSlug":"/apis/orders","content":{"contentType":"overview","meta":{"name":"Last-mile Orders API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"orders.json","url":"/_bundle/apis/orders.json?download"},{"kind":"download","label":"orders.yaml","url":"/_bundle/apis/orders.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"email","title":"E-mail","titleTranslationKey":"info.contact.name","email":"apisupport@quiqup.com","label":"apisupport@quiqup.com","withCopyButton":true,"copyContent":"apisupport@quiqup.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Proprietary","url":"https://quiqup.com/terms"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"description":"Production","url":"https://api-ae.quiqup.com"},{"description":"Staging","url":"https://api.staging.quiqup.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Last-mile Orders API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and manage Last-mile orders on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api-ae.quiqup.com"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order operations in this reference are generated from the API's own code, so they always describe what the API accepts and returns. For a walkthrough, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/lastmile/create-an-order"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Two responses are not JSON: the label download returns a PDF, and the webhook is a request Quiqup sends to you, shown as a callback on Create an order. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"sectionId":"/apis/orders"}],"sectionId":"/apis/orders"}]}]}},{"type":"group","label":"Orders","link":"/apis/orders/orders","routeSlug":"/apis/orders/orders","items":[{"label":"Download the AWB label","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/download-the-awb-label","routeSlug":"/apis/orders/orders/download-the-awb-label","metadata":{"seo":{"title":"Download the AWB label","description":"Returns the AWB label for one order, or for several in one PDF. Save it, print it andattach it to the parcel: couriers and warehouse staff scan its barcode at every step.You can download it before or after the order is ready for collection."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"download-the-awb-label","name":"Download the AWB label","isWebhook":false,"pointer":"/paths/~1order_label~1{order_ids}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Download the AWB label","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns the AWB label for one order, or for several in one PDF. Save it, print it and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"attach it to the parcel: couriers and warehouse staff scan its barcode at every step."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can download it before or after the order is ready for collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send one id, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/order_label/10000001"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or several separated by commas,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/order_label/10000001,10000002"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A batch returns a single PDF with every order's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"labels, one page per parcel."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The response is always a PDF, never JSON, so write it to a file rather than parsing it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"order_ids","in":"path","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One order id, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the create response, or several separated by commas."},"children":[]}]}]}],"required":true,"example":"10000001,10000002"}],"pointer":"/paths/~1order_label~1{order_ids}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/order_label/{order_ids}","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"order_ids","in":"path","required":true,"example":"10000001,10000002","schemaId":"schema_0"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","401","500"],"pointer":"/order_label/{order_ids}","href":"orders/download-the-awb-label","openApiOperationId":"download-the-awb-label","summary":"Download the AWB label","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The labels, as one PDF. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Disposition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" names the file "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"<order_id>.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single order and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"s<YYYY-MM-DD>.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a batch."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An id that does not match one of your orders can still answer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"200"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Content-Type: application/pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and an empty body. Check the content length before"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"writing the response to a file."},"children":[]}]}]}],"mediaType":"application/pdf","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_1"}},"schemaId":"schema_1","headers":{"Content-Disposition":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=10000001.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=s2026-01-15.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a batch."},"children":[]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_2"},{"code":"401","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token is missing, expired or not valid. This path is served by a different service"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from the other order operations, so the body has this shape, not "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"error\": \"unauthorized\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1order_label~1{order_ids}/get/responses/401/content/application~1json/example"]}},"schemaId":"schema_3","exampleIds":["paths/~1order_label~1{order_ids}/get/responses/401/content/application~1json/example"]},{"code":"500","description":"The label could not be generated. The body is a plain-text message.","mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_0"}},"schemaId":"schema_0"}],"pointer":"/paths/~1order_label~1{order_ids}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_1","mediaTypes":["application/pdf"],"mediaTypeContent":{"application/pdf":{"schemaId":"schema_1"}}},{"code":"401","schemaId":"schema_3","exampleIds":["paths/~1order_label~1{order_ids}/get/responses/401/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_3","exampleIds":["paths/~1order_label~1{order_ids}/get/responses/401/content/application~1json/example"]}}},{"code":"500","schemaId":"schema_0","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_0"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/download-the-awb-label"}],"panels":[]}]},"httpPath":"/order_label/{order_ids}"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/list-orders","routeSlug":"/apis/orders/orders/list-orders","metadata":{"seo":{"title":"List orders","description":"Returns one page of the orders submitted between from and to, newest first. You seethe orders of your account and of the other users on the same business account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"list-orders","name":"List orders","isWebhook":false,"pointer":"/paths/~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one page of the orders submitted between "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", newest first. You see"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the orders of your account and of the other users on the same business account."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pending orders are left out unless you ask for them."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" With no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[state]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list holds every state except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and every other filter, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[partner_order_id]"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"included, applies on top of that. To find an order you may have created but not released"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example after a create that timed out), name "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[state]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[state]=pending,ready_for_collection&filters[partner_order_id]=PARTNER-ORDER-ID"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pick the result whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is exactly yours."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total_pages"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are not always exact."},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" When you filter only by dates, or by"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dates and state, they come from a precomputed count that can be off, and read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"total: 1"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"when nothing matches. Adding any other filter makes them exact. To read everything,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"request pages until "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"results"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" holds fewer than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be valid: a missing one returns 422, but a date"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or number that does not parse returns 500."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First day, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"YYYY-MM-DD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DD-MM-YYYY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also works). Orders are matched on when they were submitted, in UAE time (UTC+4), and both days are included."},"children":[]}]}]}],"required":true,"example":"2026-10-01"},{"name":"to","in":"query","schemaId":"schema_4","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Last day, included. Same format as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"example":"2026-10-08"},{"name":"page","in":"query","schemaId":"schema_5","description":"Page number, from 1.","required":true,"example":1},{"name":"per_page","in":"query","schemaId":"schema_5","description":"Orders per page.","required":true,"example":50},{"name":"filters[state]","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated order states, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_for_collection,out_for_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Defaults to every state except "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An unknown or wrongly-cased state matches nothing."},"children":[]}]}]}]},{"name":"filters[partner_order_id]","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One reference of your own. Matches any order whose "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains it, ignoring case, so "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOP-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" also matches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SHOP-10"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the results when you need one exact order. Subject to the state default above, so add "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filters[state]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to find pending orders."},"children":[]}]}]}]},{"name":"filters[order_id]","in":"query","schemaId":"schema_0","description":"Comma-separated order ids. Values that are not order ids are ignored."},{"name":"filters[service_kind]","in":"query","schemaId":"schema_0","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Comma-separated service kinds, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_same_day,partner_next_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"order_by","in":"query","schemaId":"schema_6","description":"Sort order. Defaults to newest submitted first."}],"pointer":"/paths/~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":true,"example":"2026-10-01","schemaId":"schema_4"},{"name":"to","in":"query","required":true,"example":"2026-10-08","schemaId":"schema_4"},{"name":"page","in":"query","required":true,"example":1,"schemaId":"schema_5"},{"name":"per_page","in":"query","required":true,"example":50,"schemaId":"schema_5"},{"name":"filters[state]","in":"query","required":false,"schemaId":"schema_0"},{"name":"filters[partner_order_id]","in":"query","required":false,"schemaId":"schema_0"},{"name":"filters[order_id]","in":"query","required":false,"schemaId":"schema_0"},{"name":"filters[service_kind]","in":"query","required":false,"schemaId":"schema_0"},{"name":"order_by","in":"query","required":false,"schemaId":"schema_6"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","401","422"],"pointer":"/orders","href":"orders/list-orders","openApiOperationId":"list-orders","summary":"List orders","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"One page of orders.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderListResponse"}},"schemaId":"components/schemas/OrderListResponse"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"per_page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldErrors"}},"schemaId":"components/schemas/FieldErrors"}],"pointer":"/paths/~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderListResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderListResponse"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"components/schemas/FieldErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldErrors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/list-orders"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/create-an-order","routeSlug":"/apis/orders/orders/create-an-order","metadata":{"seo":{"title":"Create an order","description":"Creates an order in the pending state. A pending order shows in Quiqdash but is notdispatched: mark it ready_for_collection (PUT /orders/{id}/ready_for_collection) oncethe parcel can be collected, or send ready_for_collection: true here to skip that step."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"create-an-order","name":"Create an order","isWebhook":false,"pointer":"/paths/~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" state. A pending order shows in Quiqdash but is not"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"dispatched: mark it "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_for_collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /orders/{id}/ready_for_collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") once"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the parcel can be collected, or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_for_collection: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" here to skip that step."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the service, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_next_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_same_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_4hr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_export"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the request schema lists every value). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the parcels Quiqup carries, one label per item; "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the goods inside them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" so a retry does not create a second order: resending the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same account returns the original order with 200 and no second order is created. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"that is not a valid UUID, or that belongs to another account, is rejected with 422."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The full guide, with every field and a worked example, is at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://developer-docs.quiqup.com/docs/lastmile/create-an-order, and the order states at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://developer-docs.quiqup.com/docs/order-lifecycle."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderRequest"}},"schemaId":"components/schemas/OrderRequest","pointer":"/paths/~1orders/post/requestBody","description":"Order Request params"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderRequest"}},"responseCodes":["200","201","400","401","422"],"pointer":"/orders","href":"orders/create-an-order","openApiOperationId":"create-an-order","summary":"Create an order","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"schemaId":"components/schemas/OrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Idempotent replay: an order with this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" already exists for your account. That order is returned unchanged, and no second order is created."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}},"schemaId":"components/schemas/OrderResponse"},{"code":"201","description":"The order was created.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}},"schemaId":"components/schemas/OrderResponse"},{"code":"400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order could not be submitted, e.g. the account cannot place orders with its current payment setup, two "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" share a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parcel_barcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" has no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduled_for"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid time."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request was rejected: it failed validation, repeats an order reference, uses a service the account does not have, or supplies a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is malformed or belongs to another account."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}},"schemaId":"components/schemas/ApiError"}],"pointer":"/paths/~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}}},{"code":"201","schemaId":"components/schemas/OrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}}},{"code":"400","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"components/schemas/ApiError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ApiError"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Callbacks","labelTranslationKey":"callbacks","deepLinkSuffix":"callbacks"}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"item-content","variant":"callback","callback":{"httpVerb":"post","pathName":"https://your-endpoint.example.com/quiqup-webhook","summary":"Order state change","operationId":"order-webhook-event","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quiqup POSTs this to the URL you registered in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Quiqdash > Integrations > Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". There is no per-order callback URL."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payload shape is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderWebhookEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schema. Everything else about receiving it is in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"callbackName":"orderStateChange","callbackId":"orderStateChange/post","contentChildren":[{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","isEvent":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWebhookEvent"}},"schemaId":"components/schemas/OrderWebhookEvent","pointer":"/paths/~1orders/post/callbacks/orderStateChange/post/requestBody"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"2XX","description":"Any 2xx. The body is ignored."}],"pointer":"/paths/~1orders/post/callbacks/orderStateChange/post/responses"}]},"pointer":"/paths/~1orders/post/callbacks"}],"panels":[{"children":[{"kind":"callback-payload","callbackName":"orderStateChange/post","path":"https://your-endpoint.example.com/quiqup-webhook","httpVerb":"post","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderWebhookEvent"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/create-an-order"}],"panels":[]}]},"httpPath":"/orders"},{"label":"Cancel orders","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/cancel-pending-orders","routeSlug":"/apis/orders/orders/cancel-pending-orders","metadata":{"seo":{"title":"Cancel orders","description":"Cancels one or more of your orders. A last-mile order can be cancelled while it is pendingor ready_for_collection; a fulfilment order only while it is pending. Once a courier hasbeen assigned to collect or deliver it, the call is refused and the order has to be cancelledby Quiqup support."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"cancel-pending-orders","name":"Cancel orders","isWebhook":false,"pointer":"/paths/~1orders~1batch~1set_cancelled/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancels one or more of your orders. A last-mile order can be cancelled while it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_for_collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; a fulfilment order only while it is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Once a courier has"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"been assigned to collect or deliver it, the call is refused and the order has to be cancelled"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"by Quiqup support."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The state and courier checks cover the whole batch: if any order fails them, nothing is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled. A 422 from the state check lists the order ids that failed it; a 422 from the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"courier check is one message for the whole batch, without ids. Any other 422 can follow a"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partial cancellation, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"read the orders back with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to see which were cancelled."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelOrdersRequest"}},"schemaId":"components/schemas/CancelOrdersRequest","pointer":"/paths/~1orders~1batch~1set_cancelled/put/requestBody","description":"The orders to cancel."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/batch/set_cancelled","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/CancelOrdersRequest"}},"responseCodes":["201","202","401","422"],"pointer":"/orders/batch/set_cancelled","href":"orders/cancel-pending-orders","openApiOperationId":"cancel-pending-orders","summary":"Cancel orders","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"schemaId":"components/schemas/CancelOrdersRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CancelOrdersRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"The cancelled orders, as a bare array (not wrapped).","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}},"schemaId":"schema_7"},{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cancellation was recorded but the orders could not be read back in time. Do not retry: read them with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Also sent with the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-projection-pending: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchProjectionPending"}},"schemaId":"components/schemas/BatchProjectionPending"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order is in a state that cannot be cancelled or already has a courier assigned (nothing was cancelled), or the cancellation itself failed. Sent as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" envelope, except an unexpected failure, which is an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" message."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8"}],"pointer":"/paths/~1orders~1batch~1set_cancelled/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"schema_7","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_7"}}},{"code":"202","schemaId":"components/schemas/BatchProjectionPending","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/BatchProjectionPending"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/cancel-pending-orders"}],"panels":[]}]},"httpPath":"/orders/batch/set_cancelled"},{"label":"Add a parcel to a pending order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/add-a-parcel-to-a-pending-order","routeSlug":"/apis/orders/orders/add-a-parcel-to-a-pending-order","metadata":{"seo":{"title":"Add a parcel to a pending order","description":"Adds one parcel to a pending order and returns the new parcel on its own, not the wholeorder. A label is generated per parcel. Once the order has left pending the call isrejected with 422."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"add-a-parcel-to-a-pending-order","name":"Add a parcel to a pending order","isWebhook":false,"pointer":"/paths/~1orders~1{client_order_id}~1parcels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a parcel to a pending order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds one parcel to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order and returns the new parcel on its own, not the whole"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order. A label is generated per parcel. Once the order has left "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the call is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"rejected with 422."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_order_id","in":"path","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order id, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the create response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{client_order_id}~1parcels/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddParcelToOrderRequest"}},"schemaId":"components/schemas/AddParcelToOrderRequest","pointer":"/paths/~1orders~1{client_order_id}~1parcels/post/requestBody","description":"The parcel to add."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/orders/{client_order_id}/parcels","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"client_order_id","in":"path","required":true,"example":10000001,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/AddParcelToOrderRequest"}},"responseCodes":["200","401","403","422"],"pointer":"/orders/{client_order_id}/parcels","href":"orders/add-a-parcel-to-a-pending-order","openApiOperationId":"add-a-parcel-to-a-pending-order","summary":"Add a parcel to a pending order","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"schemaId":"components/schemas/AddParcelToOrderRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddParcelToOrderRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The parcel that was added.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NewParcel"}},"schemaId":"components/schemas/NewParcel"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"The order does not exist or was not created by your account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}},"schemaId":"components/schemas/ErrorMessage"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is missing or longer than 255 characters (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" envelope), or the order is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" message)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8"}],"pointer":"/paths/~1orders~1{client_order_id}~1parcels/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/NewParcel","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/NewParcel"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/ErrorMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}}},{"code":"422","schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/add-a-parcel-to-a-pending-order"}],"panels":[]}]},"httpPath":"/orders/{client_order_id}/parcels"},{"label":"Remove a parcel from a pending order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/remove-a-parcel-from-a-pending-order","routeSlug":"/apis/orders/orders/remove-a-parcel-from-a-pending-order","metadata":{"seo":{"title":"Remove a parcel from a pending order","description":"Removes one parcel from a pending order. An order must keep at least one parcel, soremoving the last one is rejected with 422. Takes no request body."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"remove-a-parcel-from-a-pending-order","name":"Remove a parcel from a pending order","isWebhook":false,"pointer":"/paths/~1orders~1{client_order_id}~1parcels~1{core_api_item_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a parcel from a pending order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes one parcel from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order. An order must keep at least one parcel, so"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"removing the last one is rejected with 422. Takes no request body."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"client_order_id","in":"path","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order id, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the create response."},"children":[]}]}]}],"required":true},{"name":"core_api_item_id","in":"path","schemaId":"schema_10","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parcel id: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.items[].id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on the order (sent there as a string), or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the add-a-parcel response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{client_order_id}~1parcels~1{core_api_item_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/orders/{client_order_id}/parcels/{core_api_item_id}","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"client_order_id","in":"path","required":true,"example":10000001,"schemaId":"schema_9"},{"name":"core_api_item_id","in":"path","required":true,"schemaId":"schema_10"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/orders/{client_order_id}/parcels/{core_api_item_id}","href":"orders/remove-a-parcel-from-a-pending-order","openApiOperationId":"remove-a-parcel-from-a-pending-order","summary":"Remove a parcel from a pending order","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parcel was removed. The body is the literal "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", sent with no Content-Type header."},"children":[]}]}]}],"mediaType":"text/plain","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_11"}},"schemaId":"schema_11"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"The order does not exist or was not created by your account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}},"schemaId":"components/schemas/ErrorMessage"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order is no longer "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it has only this parcel left, or no parcel on it matches "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"core_api_item_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}},"schemaId":"components/schemas/ErrorMessage"}],"pointer":"/paths/~1orders~1{client_order_id}~1parcels~1{core_api_item_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_11","mediaTypes":["text/plain"],"mediaTypeContent":{"text/plain":{"schemaId":"schema_11"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/ErrorMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}}},{"code":"422","schemaId":"components/schemas/ErrorMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/remove-a-parcel-from-a-pending-order"}],"panels":[]}]},"httpPath":"/orders/{client_order_id}/parcels/{core_api_item_id}"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/retrieve-an-order","routeSlug":"/apis/orders/orders/retrieve-an-order","metadata":{"seo":{"title":"Retrieve an order","description":"Returns one order, wrapped in order. You can read the orders your account created; anyother id, including one that does not exist, returns 403."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieve-an-order","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns one order, wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can read the orders your account created; any"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"other id, including one that does not exist, returns 403."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order id, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the create response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/orders/{id}","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":10000001,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","401","403","422"],"pointer":"/orders/{id}","href":"orders/retrieve-an-order","openApiOperationId":"retrieve-an-order","summary":"Retrieve an order","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"The order.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}},"schemaId":"components/schemas/OrderResponse"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"403","description":"The order does not exist or was not created by your account.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}},"schemaId":"components/schemas/ErrorMessage"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is not a valid order id."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldErrors"}},"schemaId":"components/schemas/FieldErrors"}],"pointer":"/paths/~1orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"403","schemaId":"components/schemas/ErrorMessage","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorMessage"}}},{"code":"422","schemaId":"components/schemas/FieldErrors","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/FieldErrors"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/retrieve-an-order"}],"panels":[]}]},"httpPath":"/orders/{id}"},{"label":"Mark an order ready for collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/orders/orders/mark-ready-for-collection","routeSlug":"/apis/orders/orders/mark-ready-for-collection","metadata":{"seo":{"title":"Mark an order ready for collection","description":"Releases a pending order to Quiqup: from now on it is planned for collection. Call it oncethe parcel is packed and labelled. Orders left pending are never collected. You can skipthis call by sending ready_for_collection: true when you create the order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"mark-ready-for-collection","name":"Mark an order ready for collection","isWebhook":false,"pointer":"/paths/~1orders~1{id}~1ready_for_collection/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Mark an order ready for collection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Releases a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order to Quiqup: from now on it is planned for collection. Call it once"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the parcel is packed and labelled. Orders left "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are never collected. You can skip"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"this call by sending "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_for_collection: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you create the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Read "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response rather than assuming the order moved: in some cases the call is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"accepted while the order stays where it is until Quiqup has finished checking it, and it then"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"moves on by itself."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This call books the shipment, so a booking problem (on an export order, for example a missing"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"customs detail) is reported here with 422 and the order stays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://developer-docs.quiqup.com/docs/lastmile/create-an-order and the order states at"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"https://developer-docs.quiqup.com/docs/order-lifecycle."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerToken","scopes":[],"type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]}]},{"schemes":[{"name":"oauthToken","scopes":[],"type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_9","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order id, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the create response."},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1orders~1{id}~1ready_for_collection/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/orders/{id}/ready_for_collection","servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"example":10000001,"schemaId":"schema_9"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerToken","type":"http","scheme":"bearer"}],"scopes":[]},{"schemes":[{"id":"oauthToken","type":"oauth2","flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["201","202","401","422"],"pointer":"/orders/{id}/ready_for_collection","href":"orders/mark-ready-for-collection","openApiOperationId":"mark-ready-for-collection","summary":"Mark an order ready for collection","securityGroups":[{"bearerToken":[]},{"oauthToken":[]}]},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order, wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}},"schemaId":"components/schemas/OrderResponse"},{"code":"202","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The release was recorded but the order could not be read back in time. Do not retry: read the order with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead. Also sent with the header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x-projection-pending: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectionPending"}},"schemaId":"components/schemas/ProjectionPending"},{"code":"401","description":"The token is missing, expired or not valid.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}},"schemaId":"components/schemas/Unauthorized"},{"code":"422","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order was not released. Its state does not allow it, the account cannot place orders with its payment setup, or a Saudi address has no valid national address (the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" envelope); or the id is not one of your orders, the account is blocked, or the shipment could not be booked (an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" message)."},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}},"schemaId":"schema_8"}],"pointer":"/paths/~1orders~1{id}~1ready_for_collection/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderResponse"}}},{"code":"202","schemaId":"components/schemas/ProjectionPending","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ProjectionPending"}}},{"code":"401","schemaId":"components/schemas/Unauthorized","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Unauthorized"}}},{"code":"422","schemaId":"schema_8","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_8"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/orders/mark-ready-for-collection"}],"panels":[]}]},"httpPath":"/orders/{id}/ready_for_collection"}],"content":{"contentType":"group","meta":{"name":"Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Orders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/order_label/{order_ids}","summary":"Download the AWB label","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/download-the-awb-label","deprecated":false},{"title":"/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/list-orders","deprecated":false},{"title":"/orders","summary":"Create an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/create-an-order","deprecated":false},{"title":"/orders/batch/set_cancelled","summary":"Cancel orders","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/cancel-pending-orders","deprecated":false},{"title":"/orders/{client_order_id}/parcels","summary":"Add a parcel to a pending order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/orders/add-a-parcel-to-a-pending-order","deprecated":false},{"title":"/orders/{client_order_id}/parcels/{core_api_item_id}","summary":"Remove a parcel from a pending order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/orders/remove-a-parcel-from-a-pending-order","deprecated":false},{"title":"/orders/{id}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/orders/retrieve-an-order","deprecated":false},{"title":"/orders/{id}/ready_for_collection","summary":"Mark an order ready for collection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/orders/mark-ready-for-collection","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/AddParcelToOrderRequest":{"id":"components/schemas/AddParcelToOrderRequest","kind":"json-schema","title":"AddParcelToOrderRequest","data":{"description":"POST body for adding parcel to an order","example":{"name":"item1"},"properties":{"name":{"description":"Item's name","maxLength":255,"minLength":1,"nullable":false,"type":"string"}},"required":["name"],"title":"AddParcelToOrderRequest","type":"object"}},"components/schemas/ApiError":{"id":"components/schemas/ApiError","kind":"json-schema","title":"ApiError","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error envelope. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is the structured form; the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_detail"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"error_details"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" repeat it for older clients."},"children":[]}]}]}],"example":{"api_error":{"attribute_errors":[{"detail":"[order][references] a unique reference with the same label and value already exists for this account"}],"code":"duplicate_order_reference","description":"A unique order reference already exists for this account.","http_status_code":422,"human":"[order][references] a unique reference with the same label and value already exists for this account","id":1010,"message":"[order][references] a unique reference with the same label and value already exists for this account"},"error":"[order][references] a unique reference with the same label and value already exists for this account","error_detail":"[order][references] a unique reference with the same label and value already exists for this account","error_details":[{"detail":"[order][references] a unique reference with the same label and value already exists for this account"}],"errors":[{"detail":"[order][references] a unique reference with the same label and value already exists for this account"}]},"properties":{"api_error":{"$ref":"#/components/schemas/ApiErrorBody"},"error":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"api_error.message"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"error_detail":{"description":"One-line summary of the error kind.","type":"string"},"error_details":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"errors"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ApiErrorDetail"},"type":"array"},"errors":{"items":{"$ref":"#/components/schemas/ApiErrorDetail"},"type":"array"}},"required":["api_error","error","errors"],"title":"ApiError","type":"object"}},"components/schemas/ApiErrorBody":{"id":"components/schemas/ApiErrorBody","kind":"json-schema","title":"ApiErrorBody","data":{"description":"The structured part of the error.","properties":{"attribute_errors":{"items":{"$ref":"#/components/schemas/ApiErrorDetail"},"type":"array"},"code":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Error kind, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"generic_user"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"description":{"description":"What to check in your request.","type":"string"},"http_status_code":{"description":"The status this error kind nominally maps to. It can differ from the HTTP status of the response; branch on the HTTP status, not on this field.","type":"integer"},"human":{"description":"Longer explanation of the error kind.","type":"string"},"id":{"description":"Stable numeric identifier of the error kind, e.g. 1010.","type":"integer"},"message":{"description":"Short summary, safe to show to a user.","type":"string"}},"required":["id","code","message","http_status_code","attribute_errors"],"title":"ApiErrorBody","type":"object"}},"components/schemas/ApiErrorDetail":{"id":"components/schemas/ApiErrorDetail","kind":"json-schema","title":"ApiErrorDetail","data":{"properties":{"detail":{"description":"One problem, in plain language.","type":"string"}},"required":["detail"],"title":"ApiErrorDetail","type":"object"}},"components/schemas/BatchProjectionPending":{"id":"components/schemas/BatchProjectionPending","kind":"json-schema","title":"BatchProjectionPending","data":{"description":"The change was recorded; these orders could not be read back in time.","example":{"order_ids":[10000001],"status":"pending_projection"},"properties":{"order_ids":{"items":{"type":"integer"},"type":"array"},"status":{"enum":["pending_projection"],"type":"string"}},"required":["order_ids","status"],"title":"BatchProjectionPending","type":"object"}},"components/schemas/CancelOrdersRequest":{"id":"components/schemas/CancelOrdersRequest","kind":"json-schema","title":"CancelOrdersRequest","data":{"example":{"order_ids":[10000001,10000002],"reason":"Customer changed their mind"},"properties":{"order_ids":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ids of your orders to cancel ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"items":{"type":"integer"},"minItems":1,"type":"array"},"reason":{"description":"Why the orders are cancelled, kept with the cancellation.","type":"string"}},"required":["order_ids"],"title":"CancelOrdersRequest","type":"object"}},"components/schemas/ErrorMessage":{"id":"components/schemas/ErrorMessage","kind":"json-schema","title":"ErrorMessage","data":{"description":"A plain error body: a single error string, sent by some errors and by the authentication check.","example":{"error":"Can not remove last parcel from an order."},"properties":{"error":{"description":"What went wrong, in plain language.","type":"string"}},"required":["error"],"title":"ErrorMessage","type":"object"}},"components/schemas/FieldErrors":{"id":"components/schemas/FieldErrors","kind":"json-schema","title":"FieldErrors","data":{"description":"Request parameters that failed validation, keyed by parameter name.","example":{"errors":{"id":["is invalid"]}},"properties":{"errors":{"additionalProperties":{"items":{"type":"string"},"type":"array"},"type":"object"},"message":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sent by some endpoints, always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Unprocessable entity"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"required":["errors"],"title":"FieldErrors","type":"object"}},"components/schemas/Item":{"id":"components/schemas/Item","kind":"json-schema","title":"Item","data":{"description":"A parcel. One label is printed per item.","properties":{"dimensions":{"description":"Centimetres.","nullable":true,"properties":{"height":{"nullable":true,"type":"number"},"length":{"nullable":true,"type":"number"},"width":{"nullable":true,"type":"number"}},"type":"object"},"id":{"description":"Parcel id, sent as a string. The id to pass when removing the parcel.","type":"string"},"name":{"nullable":true,"type":"string"},"parcel_barcode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The barcode on the label, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10000001-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"parcel_barcode_generated_by":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"quiqup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when Quiqup generated the barcode, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when you sent it."},"children":[]}]}]}],"type":"string"},"quantity":{"type":"integer"},"weight":{"description":"Kilograms, as a string.","nullable":true,"type":"string"}},"title":"Item","type":"object"}},"components/schemas/NewParcel":{"id":"components/schemas/NewParcel","kind":"json-schema","title":"NewParcel","data":{"description":"The parcel just added, returned on its own rather than inside the order.","properties":{"allowed_eans":{"description":"Always empty","items":{"type":"string"},"type":"array"},"checked":{"description":"Always false","type":"boolean"},"checked_at":{"description":"Always null","nullable":true,"type":"string"},"ean":{"description":"Always null","nullable":true,"type":"string"},"gid":{"description":"Global ID of the order the parcel belongs to","type":"string"},"id":{"description":"Parcel ID","type":"integer"},"metadata":{"description":"Always empty","type":"object"},"name":{"description":"Parcel name, as sent","type":"string"},"notes":{"description":"Always null","nullable":true,"type":"string"},"parcel_barcode":{"description":"Barcode printed on the label","type":"string"},"parcel_barcode_generated_by":{"description":"Who generated the barcode","type":"string"},"price":{"description":"Always \"0.0\"","type":"string"},"quantity":{"description":"Always 1","type":"integer"},"state":{"description":"Always null","nullable":true,"type":"string"},"total_cost":{"description":"Always \"0.0\"","type":"string"}},"title":"NewParcel","type":"object"}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order. The response carries more fields than these: the others are used by Quiqup's"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"own tools and can change without notice, so do not rely on them. Timestamps are in UAE"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"time ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+04:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"allowed_payment_types":{"description":"How the customer may pay on delivery.","items":{"enum":["cash","card"],"type":"string"},"type":"array"},"billing_identifier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"billing_identifier"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent at creation, if any."},"children":[]}]}]}],"nullable":true,"type":"string"},"brand_name":{"description":"The name of the account the order belongs to.","nullable":true,"type":"string"},"collection_attempts":{"nullable":true,"type":"integer"},"collection_time":{"description":"The collection window.","nullable":true,"properties":{"collection_after":{"format":"date-time","nullable":true,"type":"string"},"collection_before":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"created_at":{"format":"date-time","type":"string"},"delivery_attempts":{"type":"integer"},"delivery_failure_reason":{"description":"Set once a delivery attempt fails.","nullable":true,"type":"string"},"delivery_time":{"description":"The delivery window.","nullable":true,"properties":{"delivery_after":{"format":"date-time","nullable":true,"type":"string"},"delivery_before":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"destination":{"description":"Where the order is delivered.","properties":{"address":{"properties":{"address1":{"type":"string"},"address2":{"nullable":true,"type":"string"},"apartment_number":{"nullable":true,"type":"string"},"building_name":{"nullable":true,"type":"string"},"city":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The city, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"town"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no city was sent."},"children":[]}]}]}],"nullable":true,"type":"string"},"coordinates":{"description":"The point Quiqup delivers to or collects from.","nullable":true,"properties":{"lat":{"description":"Latitude","type":"number"},"lng":{"description":"Longitude","type":"number"}},"type":"object"},"country":{"nullable":true,"type":"string"},"id":{"description":"Address id, sent as a string.","type":"string"},"ksa_national_address":{"description":"Saudi national address, on Saudi orders.","nullable":true,"type":"string"},"postcode":{"nullable":true,"type":"string"},"town":{"nullable":true,"type":"string"}},"type":"object"},"arrived_at":{"description":"Always null.","format":"date-time","nullable":true,"type":"string"},"checked":{"nullable":true,"type":"boolean"},"contact_email":{"nullable":true,"type":"string"},"contact_name":{"nullable":true,"type":"string"},"contact_phone":{"nullable":true,"type":"string"},"finished_at":{"format":"date-time","nullable":true,"type":"string"},"id":{"description":"Waypoint id, sent as a string.","type":"string"},"notes":{"nullable":true,"type":"string"},"signature":{"properties":{"url":{"description":"Signature image, if any.","nullable":true,"type":"string"}},"type":"object"},"tracking_token":{"nullable":true,"type":"string"},"tracking_url":{"description":"Tracking page for this leg of the delivery.","nullable":true,"type":"string"},"zone":{"description":"Quiqup's delivery zone for the address.","properties":{"parent":{"nullable":true,"type":"string"},"parent_group":{"nullable":true,"type":"string"},"sector":{"nullable":true,"type":"string"}},"type":"object"}},"type":"object"},"display_items_info":{"nullable":true,"type":"boolean"},"forward_order_id":{"description":"On a return order, the id of the order it returns.","nullable":true,"type":"integer"},"forward_partner_order_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On a return order, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the order it returns."},"children":[]}]}]}],"nullable":true,"type":"string"},"id":{"description":"The order id. Use it in every other order route.","type":"integer"},"item_quantity_count":{"description":"Number of parcels.","type":"integer"},"items":{"description":"The parcels.","items":{"$ref":"#/components/schemas/Item"},"type":"array"},"kind":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service class. Read the service from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"origin":{"description":"Where the order is collected.","properties":{"address":{"properties":{"address1":{"type":"string"},"address2":{"nullable":true,"type":"string"},"apartment_number":{"nullable":true,"type":"string"},"building_name":{"nullable":true,"type":"string"},"city":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The city, or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"town"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" when no city was sent."},"children":[]}]}]}],"nullable":true,"type":"string"},"coordinates":{"description":"The point Quiqup delivers to or collects from.","nullable":true,"properties":{"lat":{"description":"Latitude","type":"number"},"lng":{"description":"Longitude","type":"number"}},"type":"object"},"country":{"nullable":true,"type":"string"},"id":{"description":"Address id, sent as a string.","type":"string"},"ksa_national_address":{"description":"Saudi national address, on Saudi orders.","nullable":true,"type":"string"},"postcode":{"nullable":true,"type":"string"},"town":{"nullable":true,"type":"string"}},"type":"object"},"arrived_at":{"description":"Always null.","format":"date-time","nullable":true,"type":"string"},"checked":{"nullable":true,"type":"boolean"},"contact_email":{"nullable":true,"type":"string"},"contact_name":{"nullable":true,"type":"string"},"contact_phone":{"nullable":true,"type":"string"},"finished_at":{"format":"date-time","nullable":true,"type":"string"},"id":{"description":"Waypoint id, sent as a string.","type":"string"},"notes":{"nullable":true,"type":"string"},"signature":{"properties":{"url":{"description":"Signature image, if any.","nullable":true,"type":"string"}},"type":"object"},"tracking_token":{"nullable":true,"type":"string"},"tracking_url":{"description":"Tracking page for this leg of the delivery.","nullable":true,"type":"string"},"zone":{"description":"Quiqup's delivery zone for the address.","properties":{"parent":{"nullable":true,"type":"string"},"parent_group":{"nullable":true,"type":"string"},"sector":{"nullable":true,"type":"string"}},"type":"object"}},"type":"object"},"partner_order_id":{"description":"Your own reference for the order.","nullable":true,"type":"string"},"payment_amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to collect, as a decimal string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.0\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payment_mode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (older orders can carry a retired mode)."},"children":[]}]}]}],"type":"string"},"products":{"description":"The goods, as sent at creation.","items":{"$ref":"#/components/schemas/Product"},"nullable":true,"type":"array"},"reason":{"description":"On a return order, the reason sent at creation.","nullable":true,"type":"string"},"region_name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dubai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"required_documents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Proof the courier collects at delivery, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"otp"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"type":"string"},"type":"array"},"return_order_id":{"description":"On an order with a return, the id of the return order.","nullable":true,"type":"integer"},"return_partner_order_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On an order with a return, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_order_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the return order."},"children":[]}]}]}],"nullable":true,"type":"string"},"scheduled_for":{"description":"The requested collection time, when one was sent.","format":"date-time","nullable":true,"type":"string"},"service_kind":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service the order was created with, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_same_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"sku_info":{"nullable":true,"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ready_for_collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Every state is listed at https://developer-docs.quiqup.com/docs/order-lifecycle."},"children":[]}]}]}],"type":"string"},"state_updated_at":{"description":"When the order entered its current state.","format":"date-time","nullable":true,"type":"string"},"submitted_at":{"description":"When the order was created.","format":"date-time","nullable":true,"type":"string"},"tracking_url":{"description":"The tracking page to share with your customer.","nullable":true,"type":"string"},"user":{"properties":{"email":{"description":"User email","type":"string"},"fullname":{"description":"User full name","nullable":true,"type":"string"},"id":{"description":"User ID","type":"integer"}},"type":"object"},"uuid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" you sent, or one Quiqup generated."},"children":[]}]}]}],"format":"uuid","type":"string"},"weight_kg":{"nullable":true,"type":"number"}},"title":"Order","type":"object"}},"components/schemas/OrderListAddress":{"id":"components/schemas/OrderListAddress","kind":"json-schema","title":"OrderListAddress","data":{"properties":{"address1":{"type":"string"},"address2":{"nullable":true,"type":"string"},"apartment_number":{"nullable":true,"type":"string"},"building_name":{"nullable":true,"type":"string"},"city":{"nullable":true,"type":"string"},"coordinates":{"nullable":true,"properties":{"lat":{"type":"number"},"lng":{"type":"number"}},"type":"object"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 code, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Can be null on non-UAE addresses."},"children":[]}]}]}],"nullable":true,"type":"string"},"postcode":{"nullable":true,"type":"string"},"town":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Area, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Business Bay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"}},"title":"OrderListAddress","type":"object"}},"components/schemas/OrderListItem":{"id":"components/schemas/OrderListItem","kind":"json-schema","title":"OrderListItem","data":{"description":"A parcel. One label is printed per item.","properties":{"dimensions":{"description":"Centimetres.","nullable":true,"properties":{"height":{"type":"number"},"length":{"type":"number"},"width":{"type":"number"}},"type":"object"},"name":{"nullable":true,"type":"string"},"parcel_barcode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The barcode on the label, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10000001-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"quantity":{"type":"integer"},"weight":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Kilograms, as a decimal string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"5.0\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"}},"title":"OrderListItem","type":"object"}},"components/schemas/OrderListOrder":{"id":"components/schemas/OrderListOrder","kind":"json-schema","title":"OrderListOrder","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One order in a list. Each result carries more fields than these: the others are"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"used by Quiqup's own tools and can change without notice, so do not rely on them."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Timestamps are in UAE time ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+04:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"carrier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Quiqup"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"collection_attempts":{"nullable":true,"type":"integer"},"collection_time":{"nullable":true,"properties":{"collection_after":{"format":"date-time","nullable":true,"type":"string"},"collection_before":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"created_at":{"format":"date-time","type":"string"},"delivery_attempts":{"nullable":true,"type":"integer"},"delivery_failure_reason":{"nullable":true,"type":"string"},"delivery_time":{"nullable":true,"properties":{"delivery_after":{"format":"date-time","nullable":true,"type":"string"},"delivery_before":{"format":"date-time","nullable":true,"type":"string"}},"type":"object"},"destination":{"$ref":"#/components/schemas/OrderListWaypoint"},"forward_order_id":{"description":"On a return order, the id of the order it returns.","nullable":true,"type":"integer"},"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order id, as used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the other order routes."},"children":[]}]}]}],"type":"integer"},"item_quantity_count":{"nullable":true,"type":"integer"},"items":{"items":{"$ref":"#/components/schemas/OrderListItem"},"type":"array"},"origin":{"$ref":"#/components/schemas/OrderListWaypoint"},"partner_order_id":{"description":"Your own reference for the order.","nullable":true,"type":"string"},"payment_amount":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Amount to collect, as a decimal string, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"0.0\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"payment_mode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"return_order_id":{"description":"On an order with a return, the id of the return order.","nullable":true,"type":"integer"},"service_kind":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_same_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_next_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"shipment_number":{"nullable":true,"type":"string"},"state":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delivery_complete"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"state_updated_at":{"format":"date-time","nullable":true,"type":"string"},"submitted_at":{"format":"date-time","nullable":true,"type":"string"},"tracking_url":{"nullable":true,"type":"string"},"updated_at":{"format":"date-time","type":"string"},"uuid":{"format":"uuid","type":"string"},"weight_kg":{"nullable":true,"type":"number"}},"title":"OrderListOrder","type":"object"}},"components/schemas/OrderListResponse":{"id":"components/schemas/OrderListResponse","kind":"json-schema","title":"OrderListResponse","data":{"description":"One page of orders.","example":{"current_page":1,"per_page":1,"results":[{"carrier":"Quiqup","created_at":"2026-10-06T16:46:56.000+04:00","delivery_attempts":1,"delivery_time":{"delivery_after":"2026-10-06T16:47:13.000+04:00","delivery_before":"2026-10-07T23:00:00.000+04:00"},"destination":{"address":{"address1":"1st Road","coordinates":{"lat":25.2048,"lng":55.2708},"country":"AE","town":"Business Bay"},"contact_name":"Customer name","contact_phone":"+971500000000"},"id":10000001,"item_quantity_count":1,"items":[{"dimensions":{"height":10,"length":10,"width":10},"name":"Parcel","parcel_barcode":"10000001-1","quantity":1,"weight":"5.0"}],"partner_order_id":"PARTNER-ORDER-ID","payment_amount":"0.0","payment_mode":"pre_paid","service_kind":"partner_same_day","shipment_number":"10000001-1","state":"delivery_complete","state_updated_at":"2026-10-06T16:55:11.000+04:00","submitted_at":"2026-10-06T16:46:56.000+04:00","updated_at":"2026-10-06T16:55:11.000+04:00","uuid":"00000000-0000-4000-8000-000000000001"}],"total":143,"total_pages":143},"properties":{"current_page":{"type":"integer"},"per_page":{"type":"integer"},"results":{"items":{"$ref":"#/components/schemas/OrderListOrder"},"type":"array"},"total":{"description":"How many orders match. An estimate in some cases, see the operation description.","type":"integer"},"total_pages":{"type":"integer"}},"required":["current_page","per_page","total","total_pages","results"],"title":"OrderListResponse","type":"object"}},"components/schemas/OrderListWaypoint":{"id":"components/schemas/OrderListWaypoint","kind":"json-schema","title":"OrderListWaypoint","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the order is collected ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or delivered ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"properties":{"address":{"$ref":"#/components/schemas/OrderListAddress"},"contact_email":{"nullable":true,"type":"string"},"contact_name":{"nullable":true,"type":"string"},"contact_phone":{"nullable":true,"type":"string"},"notes":{"nullable":true,"type":"string"},"tracking_url":{"description":"Tracking page for this leg of the delivery.","nullable":true,"type":"string"}},"title":"OrderListWaypoint","type":"object"}},"components/schemas/OrderRequest":{"id":"components/schemas/OrderRequest","kind":"json-schema","title":"OrderRequest","data":{"description":"Request params for a single order","example":{"destination":{"address":{"address1":"1st Road","address2":"104G","country":"UAE","town":"Dubai"},"contact_email":"customer@example.com","contact_name":"Customer name","contact_phone":"+971599999999","notes":""},"items":[{"name":"Parcel 1","parcel_barcode":"","quantity":1}],"kind":"partner_same_day","origin":{"address":{"address1":"1st Road","address2":"104G","country":"UAE","town":"Dubai"},"contact_name":"Warehouse contact","contact_phone":"+971500000000"},"partner_order_id":"PARTNER-ORDER-ID","payment_mode":"pre_paid","products":[{"barcode":"1234654-kt","country_of_origin":"CN","description":"Running shoe red","height":12,"hs_code":"64041100","length":30,"quantity":1,"selling_price":58.3,"sku":"SKU-RUN-001","weight":0.8,"width":20}]},"properties":{"billing_identifier":{"description":"Creates the order in another account that Quiqup has linked to yours. Omit it unless Quiqup set one up for you: a value not linked to your account is ignored, with no error, and the order is created in your own account.","nullable":true,"type":"string"},"destination":{"$ref":"#/components/schemas/OrderRequestAddress"},"disallowed_payment_types":{"$ref":"#/components/schemas/OrderRequestDisallowedPaymentTypes"},"items":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The parcels, one entry per box or bag. A label is printed per item. The goods inside go in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"products"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderRequestItem"},"minItems":1,"type":"array"},"kind":{"$ref":"#/components/schemas/OrderRequestKind"},"metadata":{"$ref":"#/components/schemas/OrderRequestMetadata"},"notes":{"$ref":"#/components/schemas/OrderRequestNotes"},"origin":{"$ref":"#/components/schemas/OrderRequestAddress"},"partner_order_id":{"description":"Your own reference, shown in Quiqdash and used to reconcile invoices and cash collected. Not checked for uniqueness: send a unique value.","type":"string"},"payment_amount":{"$ref":"#/components/schemas/OrderRequestPaymentAmountValue"},"payment_mode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pre_paid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the default: nothing to collect) or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (the courier collects "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_amount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"cash_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"card_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are retired: still accepted, but do not build on them."},"children":[]}]}]}],"enum":["pre_paid","cash_on_delivery","card_on_delivery","paid_on_delivery"],"type":"string"},"products":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The goods being shipped. Optional on domestic orders; required on export orders, where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hs_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"country_of_origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"weight"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selling_price"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" clear customs."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderRequestProduct"},"type":"array"},"ready_for_collection":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to release the order in the same call, instead of calling "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT /orders/{id}/ready_for_collection"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response can still show "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and if the release fails the order is created anyway and stays "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pending"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": check "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"boolean"},"reason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Why the parcel is coming back. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"registration_numbers":{"description":"Registration numbers for customs declarations (e.g. MIRSAL2). Optional.","items":{"$ref":"#/components/schemas/OrderRequestRegistrationNumber"},"nullable":true,"type":"array"},"required_documents":{"$ref":"#/components/schemas/OrderRequestRequiredDocuments"},"scheduled_for":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_4hr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order, the earliest time Quiqup should collect it: an ISO 8601 date-time in UTC, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"2026-11-02T06:00:00Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". On a Last-mile account the order is released for collection when it is created; on a Fulfilment account it stays pending until it is released. It is not collected before this time. It must not be in the past and must fall between 04:00 and 14:59 UTC (08:00 to 18:59 Dubai time); otherwise the order is rejected with 400 and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[order][scheduled_for] is incorrect"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Send it with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix: the hour is checked as written, so the hour of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"10:00:00+04:00"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is checked as 10:00 UTC. Only checked when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_4hr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; omit it to have the order collected as soon as possible."},"children":[]}]}]}],"example":"2026-11-02T06:00:00Z","nullable":true,"type":"string"},"service_kind":{"$ref":"#/components/schemas/OrderRequestKind"},"uuid":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your idempotency key: generate one per order and resend the same value on a retry. Resending a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" your account already used returns the original order with 200, unchanged (the new body is ignored), and no second order is created. A malformed "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"uuid"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or one another account used, is rejected with 422. Omit it and Quiqup generates one."},"children":[]}]}]}],"format":"uuid","nullable":true,"type":"string"}},"required":["origin","destination","items"],"title":"OrderRequest","type":"object"}},"components/schemas/OrderRequestAddress":{"id":"components/schemas/OrderRequestAddress","kind":"json-schema","title":"OrderRequestAddress","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A pickup ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or delivery ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") point and its contact."},"children":[]}]}]}],"properties":{"address":{"properties":{"address1":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Building and street, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Example Tower, 1st Road"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":320,"minLength":1,"type":"string"},"address2":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Area or unit, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Business Bay"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Office 104"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"apartment_number":{"description":"Apartment number","nullable":true,"type":"string"},"building_name":{"description":"Building name","nullable":true,"type":"string"},"city":{"description":"City the address is located in","nullable":true,"type":"string"},"coordinates":{"$ref":"#/components/schemas/OrderRequestAddressCoordinates"},"coords":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The point as exactly two numbers, longitude FIRST: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[lng, lat]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[55.2708, 25.2048]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Any other length is ignored and the address is located from its text."},"children":[]}]}]}],"example":[55.2708,25.2048],"nullable":true,"type":"array"},"country":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The country, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UAE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". An order (other than a return) whose destination country differs from its pickup country is made an export."},"children":[]}]}]}],"nullable":true,"type":"string"},"ksa_national_address":{"description":"KSA National Address","nullable":true,"type":"string"},"notes":{"$ref":"#/components/schemas/OrderRequestNotes"},"postcode":{"description":"ZIP or postal code the address is located in","nullable":true,"type":"string"},"town":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Town or city, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Dubai"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"}},"required":["address1"],"title":"Address","type":"object"},"contact_email":{"description":"The customer's email. Needed on export orders.","type":"string"},"contact_name":{"description":"Who the courier asks for.","type":"string"},"contact_phone":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With the country code, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"+971500000000"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"emirate":{"description":"Emirate","nullable":true,"type":"string"},"notes":{"$ref":"#/components/schemas/OrderRequestNotes"}},"required":["contact_name","contact_phone","address"],"title":"OrderRequestAddress","type":"object"}},"components/schemas/OrderRequestAddressCoordinates":{"id":"components/schemas/OrderRequestAddressCoordinates","kind":"json-schema","title":"OrderRequestAddressCoordinates","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The point, as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{lat, lng}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Same as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"coords"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"; send one or the other. Without a valid point Quiqup locates the address from its text."},"children":[]}]}]}],"nullable":true,"properties":{"lat":{"$ref":"#/components/schemas/OrderRequestAnyValue"},"lng":{"$ref":"#/components/schemas/OrderRequestAnyValue"}},"required":["lat","lng"],"title":"OrderRequestAddressCoordinates","type":"object"}},"components/schemas/OrderRequestAnyValue":{"id":"components/schemas/OrderRequestAnyValue","kind":"json-schema","title":"OrderRequestAnyValue","data":{"anyOf":[{"nullable":true,"type":"string"},{"nullable":true,"type":"number"}],"nullable":true,"title":"OrderRequestAnyValue","type":"object"}},"components/schemas/OrderRequestDisallowedPaymentTypes":{"id":"components/schemas/OrderRequestDisallowedPaymentTypes","kind":"json-schema","title":"OrderRequestDisallowedPaymentTypes","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Payment methods to refuse on a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"paid_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" order, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[\"cash\"]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to accept card only. The order's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"allowed_payment_types"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is what is left."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderRequestDisallowedPaymentTypesValues"},"nullable":true,"title":"OrderRequestDisallowedPaymentTypes","type":"array"}},"components/schemas/OrderRequestDisallowedPaymentTypesValues":{"id":"components/schemas/OrderRequestDisallowedPaymentTypesValues","kind":"json-schema","title":"OrderRequestDisallowedPaymentTypesValues","data":{"description":"A way the customer may not pay on delivery.","enum":["cash","card"],"title":"OrderRequestDisallowedPaymentTypesValues","type":"string"}},"components/schemas/OrderRequestItem":{"id":"components/schemas/OrderRequestItem","kind":"json-schema","title":"OrderRequestItem","data":{"description":"One parcel: one box or bag, with its own label.","properties":{"metadata":{"properties":{},"title":"ItemMetadata","type":"object"},"name":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A label for the parcel, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Parcel 1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Keep it short. Defaults to the barcode."},"children":[]}]}]}],"type":"string"},"parcel_barcode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leave it empty and Quiqup generates the barcode ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{order id}-1"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"-2"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", ...) and prints it on the label. Send one only if you print your own labels; two parcels of an order cannot share one."},"children":[]}]}]}],"nullable":true,"type":"string"},"quantity":{"description":"Send 1. One entry is one parcel, not a count of boxes.","type":"integer"}},"title":"OrderRequestItem","type":"object"}},"components/schemas/OrderRequestItemsInfo":{"id":"components/schemas/OrderRequestItemsInfo","kind":"json-schema","title":"OrderRequestItemsInfo","data":{"properties":{"quantity":{"description":"Quantity","type":"integer"},"sku":{"description":"SKU","type":"string"}},"title":"OrderRequestItemsInfo","type":"object"}},"components/schemas/OrderRequestKind":{"id":"components/schemas/OrderRequestKind","kind":"json-schema","title":"OrderRequestKind","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service. Omit it and your account's default service is used, normally "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"partner_same_day"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The services and their delivery promises are described at https://developer-docs.quiqup.com/docs/lastmile/create-an-order. An account can only use the services agreed with Quiqup."},"children":[]}]}]}],"enum":["partner_next_day","partner_same_day","partner_return","partner_standard","partner_on_demand","partner_4hr","partner_store","partner_fulfillment","partner_q_commerce","partner_export"],"title":"OrderRequestKind","type":"string"}},"components/schemas/OrderRequestMetadata":{"id":"components/schemas/OrderRequestMetadata","kind":"json-schema","title":"OrderRequestMetadata","data":{"nullable":true,"properties":{"items_info":{"description":"Items Info Metadata","items":{"$ref":"#/components/schemas/OrderRequestItemsInfo"},"type":"array"}},"title":"OrderRequestMetadata","type":"object"}},"components/schemas/OrderRequestNotes":{"id":"components/schemas/OrderRequestNotes","kind":"json-schema","title":"OrderRequestNotes","data":{"description":"Free-text notes for the courier.","nullable":true,"title":"OrderRequestNotes","type":"string"}},"components/schemas/OrderRequestPaymentAmountValue":{"id":"components/schemas/OrderRequestPaymentAmountValue","kind":"json-schema","title":"OrderRequestPaymentAmountValue","data":{"anyOf":[{"nullable":false,"type":"string"},{"nullable":false,"type":"number"}],"nullable":false,"title":"OrderRequestPaymentAmountValue","type":"object"}},"components/schemas/OrderRequestProduct":{"id":"components/schemas/OrderRequestProduct","kind":"json-schema","title":"OrderRequestProduct","data":{"description":"Request params for a single product","properties":{"barcode":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The product's own barcode (EAN, UPC, GTIN), not the parcel's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parcel_barcode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"country_of_origin":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 3166-1 alpha-2 code, e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Required on export orders."},"children":[]}]}]}],"nullable":true,"type":"string"},"dangerous_goods":{"description":"The product dangerous goods","nullable":true,"type":"boolean"},"description":{"description":"The product name. Keep it short: 18 characters is safe for every export carrier.","nullable":true,"type":"string"},"height":{"description":"Centimetres.","nullable":true,"type":"number"},"hs_code":{"description":"Harmonised System code. Required on export orders.","nullable":true,"type":"string"},"length":{"description":"Centimetres.","nullable":true,"type":"number"},"quantity":{"description":"How many of this product are in the shipment.","nullable":true,"type":"integer"},"selling_price":{"description":"Unit price, used as the customs value. Required on export orders.","nullable":true,"type":"number"},"sku":{"description":"Your stock code.","nullable":true,"type":"string"},"weight":{"description":"Kilograms. Required on export orders.","nullable":true,"type":"number"},"width":{"description":"Centimetres.","nullable":true,"type":"number"}},"title":"OrderRequestProduct","type":"object"}},"components/schemas/OrderRequestRegistrationNumber":{"id":"components/schemas/OrderRequestRegistrationNumber","kind":"json-schema","title":"OrderRequestRegistrationNumber","data":{"description":"Registration number for customs declarations (e.g., MIRSAL2)","properties":{"issuer_country_code":{"description":"ISO country code of the issuer (e.g., AE)","nullable":true,"type":"string"},"type_code":{"description":"The type code of the registration number (e.g., MIRSAL2)","nullable":true,"type":"string"},"value":{"description":"The registration number value","nullable":true,"type":"string"}},"title":"OrderRequestRegistrationNumber","type":"object"}},"components/schemas/OrderRequestRequiredDocuments":{"id":"components/schemas/OrderRequestRequiredDocuments","kind":"json-schema","title":"OrderRequestRequiredDocuments","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Leave it out or send "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The proof of delivery your account is set up to require is added to every order automatically."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/OrderRequestRequiredDocumentsValues"},"nullable":true,"title":"OrderRequestRequiredDocuments","type":"array"}},"components/schemas/OrderRequestRequiredDocumentsValues":{"id":"components/schemas/OrderRequestRequiredDocumentsValues","kind":"json-schema","title":"OrderRequestRequiredDocumentsValues","data":{"enum":["customer_identification_photo"],"title":"OrderRequestRequiredDocumentsValues","type":"string"}},"components/schemas/OrderResponse":{"id":"components/schemas/OrderResponse","kind":"json-schema","title":"OrderResponse","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One order, wrapped in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":{"order":{"allowed_payment_types":["cash","card"],"billing_identifier":null,"brand_name":"Example Brand","collection_attempts":0,"collection_time":{"collection_after":"2026-10-06T16:47:00.000+04:00","collection_before":"2026-10-06T18:47:00.000+04:00"},"created_at":"2026-10-06T16:46:56.000+04:00","delivery_attempts":0,"delivery_time":{"delivery_after":"2026-10-06T16:46:56.000+04:00","delivery_before":"2026-10-07T23:00:00.000+04:00"},"destination":{"address":{"address1":"1st Road","address2":"104G","coordinates":{"lat":25.2048,"lng":55.2708},"country":"UAE","id":"2000002","town":"Dubai"},"contact_email":"customer@example.com","contact_name":"Customer name","contact_phone":"+971500000000","id":"3000002","tracking_url":"https://track-ae.quiqup.com/00000000000000000000000000000002","zone":{"sector":"Business Bay"}},"id":10000001,"item_quantity_count":1,"items":[{"id":"4000001","name":"Parcel 1","parcel_barcode":"10000001-1","parcel_barcode_generated_by":"quiqup","quantity":1}],"kind":"partner_same_day","origin":{"address":{"address1":"Example Warehouse, Street 1","address2":"Al Quoz Industrial Area 4","coordinates":{"lat":25.135,"lng":55.23},"country":"UAE","id":"2000001","town":"Dubai"},"contact_name":"Warehouse contact","contact_phone":"+971500000000","id":"3000001","tracking_url":"https://track-ae.quiqup.com/00000000000000000000000000000001"},"partner_order_id":"PARTNER-ORDER-ID","payment_amount":"0.0","payment_mode":"pre_paid","region_name":"Dubai","required_documents":[],"service_kind":"partner_same_day","state":"pending","state_updated_at":"2026-10-06T16:46:56.000+04:00","submitted_at":"2026-10-06T16:46:56.000+04:00","tracking_url":"https://track-parcel.quiqup.com/00000000-0000-4000-8000-000000000001","user":{"email":"merchant@example.com","fullname":"Example Merchant","id":15},"uuid":"00000000-0000-4000-8000-000000000001"}},"properties":{"order":{"$ref":"#/components/schemas/Order"}},"required":["order"],"title":"OrderResponse","type":"object"}},"components/schemas/OrderWebhookEvent":{"id":"components/schemas/OrderWebhookEvent","kind":"json-schema","title":"OrderWebhookEvent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The payload Quiqup POSTs to your webhook endpoint when an order changes state."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registration, signature verification, timeouts, retries, replay and the receiver rules are documented once, in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/docs/webhooks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Read that page before building a receiver."},"children":[]}]}]}],"properties":{"action":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"payload":{"properties":{"allowed_payment_types":{"items":{"type":"string"},"type":"array"},"billing_identifier":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set only when the order was created with one. Otherwise empty or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"nullable":true,"type":"string"},"brand_name":{"type":"string"},"business_contact_id":{"type":"string"},"business_partner_id":{"description":"The id of the account that owns the order. Use it to route events when one receiver serves several accounts.","type":"string"},"cancelled_at":{"format":"date-time","nullable":true,"type":"string"},"client_order_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order id again, the same value as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"integer"},"collection_after":{"format":"date-time","nullable":true,"type":"string"},"collection_attempts":{"type":"integer"},"collection_before":{"format":"date-time","nullable":true,"type":"string"},"core_api_user_id":{"type":"integer"},"courier_id":{"type":"integer"},"created_at":{"format":"date-time","type":"string"},"currency":{"type":"string"},"delivered_at":{"format":"date-time","nullable":true,"type":"string"},"delivery_after":{"format":"date-time","nullable":true,"type":"string"},"delivery_attempts":{"type":"integer"},"delivery_before":{"format":"date-time","nullable":true,"type":"string"},"delivery_failure_reason":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Empty or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" until a delivery fails."},"children":[]}]}]}],"nullable":true,"type":"string"},"destination":{"$ref":"#/components/schemas/OrderWebhookWaypoint"},"display_items_info":{"type":"boolean"},"external_order_id":{"type":"string"},"failed_at":{"format":"date-time","nullable":true,"type":"string"},"fragile":{"type":"boolean"},"id":{"type":"integer"},"item_quantity_count":{"type":"integer"},"items":{"items":{"properties":{"id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A string, as on the create and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" responses."},"children":[]}]}]}],"type":"string"},"name":{"type":"string"},"parcel_barcode":{"type":"string"},"parcel_barcode_generated_by":{"type":"string"},"quantity":{"type":"integer"},"sku":{"type":"string"},"weight":{"type":"number"}},"type":"object"},"type":"array"},"kind":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can arrive empty in a webhook. Read the service from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"},"metadata":{"type":"object"},"mission_id":{"type":"string"},"notes":{"nullable":true,"type":"string"},"origin":{"$ref":"#/components/schemas/OrderWebhookWaypoint"},"otp_code":{"type":"string"},"partner_order_id":{"description":"Your reference. Empty for orders created in Quiqdash.","type":"string"},"payment_amount":{"description":"A number here, where the API responses send it as a string.","type":"number"},"payment_mode":{"type":"string"},"region":{"type":"string"},"region_name":{"type":"string"},"required_documents":{"items":{"type":"string"},"type":"array"},"scheduled_for":{"format":"date-time","nullable":true,"type":"string"},"service_kind":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The service the order was created with, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sent to Create an order."},"children":[]}]}]}],"type":"string"},"sku_info":{"nullable":true,"type":"string"},"state":{"type":"string"},"state_updated_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the state changed, in UTC with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and fractional seconds. Order events by this field."},"children":[]}]}]}],"format":"date-time","type":"string"},"submitted_at":{"format":"date-time","type":"string"},"total_amount":{"type":"number"},"tracking_url":{"type":"string"},"uuid":{"type":"string"},"weight":{"type":"number"},"weight_unit":{"type":"string"}},"type":"object"},"sent_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When Quiqup dispatched the delivery, in UTC with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Z"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", to the second. Not when the state changed."},"children":[]}]}]}],"format":"date-time","type":"string"},"type":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"order"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The event name is not in the body; switch on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payload.state"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string"}},"type":"object"}},"components/schemas/OrderWebhookWaypoint":{"id":"components/schemas/OrderWebhookWaypoint","kind":"json-schema","title":"OrderWebhookWaypoint","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"origin"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"destination"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OrderWebhookEvent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Narrower than the waypoint on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET /orders/{order_id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"address":{"properties":{"address1":{"type":"string"},"address2":{"nullable":true,"type":"string"},"apartment_number":{"nullable":true,"type":"string"},"building_name":{"nullable":true,"type":"string"},"coordinates":{"properties":{"lat":{"type":"number"},"lng":{"type":"number"}},"type":"object"},"country":{"type":"string"},"id":{"type":"integer"},"town":{"nullable":true,"type":"string"}},"type":"object"},"arrived_at":{"format":"date-time","nullable":true,"type":"string"},"contact_name":{"type":"string"},"contact_phone":{"type":"string"},"finished_at":{"format":"date-time","nullable":true,"type":"string"},"id":{"type":"integer"},"notes":{"nullable":true,"type":"string"},"signature":{"properties":{"url":{"nullable":true,"type":"string"}},"type":"object"},"tracking_token":{"type":"string"},"tracking_url":{"type":"string"}},"type":"object"}},"components/schemas/Product":{"id":"components/schemas/Product","kind":"json-schema","title":"Product","data":{"properties":{"barcode":{"description":"Product barcode (EAN, UPC, GTIN)","type":"string"},"country_of_origin":{"description":"The product country of origin","type":"string"},"dangerous_goods":{"description":"The product dangerous goods","type":"boolean"},"description":{"description":"The product description","type":"string"},"height":{"description":"The product height","type":"number"},"hs_code":{"description":"The product HS code","type":"string"},"length":{"description":"The product length","type":"number"},"quantity":{"description":"The product quantity","type":"integer"},"selling_price":{"description":"The product selling price","type":"number"},"sku":{"description":"The product SKU","type":"string"},"weight":{"description":"The product weight","type":"number"},"width":{"description":"The product width","type":"number"}},"title":"Product","type":"object"}},"components/schemas/ProjectionPending":{"id":"components/schemas/ProjectionPending","kind":"json-schema","title":"ProjectionPending","data":{"description":"The change was recorded; the order could not be read back in time.","example":{"order_id":"10000001","status":"pending_projection"},"properties":{"order_id":{"description":"The order id from the path.","type":"string"},"status":{"enum":["pending_projection"],"type":"string"}},"required":["order_id","status"],"title":"ProjectionPending","type":"object"}},"components/schemas/Unauthorized":{"id":"components/schemas/Unauthorized","kind":"json-schema","title":"Unauthorized","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token was rejected. Always this exact body, never the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ApiError"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" envelope."},"children":[]}]}]}],"example":{"error":"unauthorized"},"properties":{"error":{"enum":["unauthorized"],"type":"string"}},"required":["error"],"title":"Unauthorized","type":"object"}},"schema_0":{"kind":"json-schema","data":{"type":"string"},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"format":"binary","type":"string"},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"type":"object","properties":{"Content-Disposition":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=10000001.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"attachment; filename=s2026-01-15.pdf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a batch."},"children":[]}]}]}]}}},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"properties":{"code":{"enum":["unauthenticated"],"type":"string"},"details":{"nullable":true,"type":"object"},"message":{"type":"string"}},"type":"object"},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"format":"date","type":"string"},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"minimum":1,"type":"integer"},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"enum":["created_at_asc","state_updated_at_asc","state_updated_at_desc","delivery_before_asc","delivery_before_desc","delivery_attempts_asc","delivery_attempts_desc"],"type":"string"},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array"},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"anyOf":[{"$ref":"#/components/schemas/ApiError"},{"$ref":"#/components/schemas/ErrorMessage"}]},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"example":10000001,"type":"integer"},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"example":"true","type":"string"},"id":"schema_11"}},"exampleStore":{"paths/~1order_label~1{order_ids}/get/responses/401/content/application~1json/example":{"value":{"code":"unauthenticated","details":null,"message":"invalid auth param"},"id":"paths/~1order_label~1{order_ids}/get/responses/401/content/application~1json/example"}},"securitySchemeStore":{"bearerToken":{"id":"bearerToken","type":"http","scheme":"bearer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A Bearer token generated in Quiqdash under Organization > API keys. The usual path."},"children":[]}]}]}]},"oauthToken":{"id":"oauthToken","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client credentials, issued by Quiqup on request. Only needed by platforms whose setup screens require a Client ID and Client Secret."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The token URL follows the environment: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api.staging.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on staging, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"https://api-ae.quiqup.com/oauth/token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on production."},"children":[]}]}]}],"flows":{"clientCredentials":{"scopes":{},"tokenUrl":"https://api.staging.quiqup.com/oauth/token"}}}},"servers":[{"url":"https://api-ae.quiqup.com","description":"Production"},{"url":"https://api.staging.quiqup.com","description":"Staging"}],"specType":"openapi"},"options":{"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/apis/orders.json?download"},{"url":"/_bundle/apis/orders.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Last-mile Orders API","description":"Create and manage Last-mile orders on `api-ae.quiqup.com`.\n\nThe order operations in this reference are generated from the API's own code, so they always describe what the API accepts and returns. For a walkthrough, see [Create an order](/docs/lastmile/create-an-order).\n\nTwo responses are not JSON: the label download returns a PDF, and the webhook is a request Quiqup sends to you, shown as a callback on Create an order. See [Webhooks](/docs/webhooks)."}},"baseSlug":"/apis/orders","routesMapping":{}}