{"items":[{"type":"link","label":"Fulfilment API","link":"/openapi","routeSlug":"/openapi","content":{"contentType":"overview","meta":{"name":"Fulfilment API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"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":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"description":"Production","url":"https://platform-api.quiqup.com"},{"description":"Staging","url":"https://platform-api.staging.quiqup.com"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Fulfilment API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"This is the API documentation for the Fulfilment API."}],"sectionId":"/openapi"}],"sectionId":"/openapi"}]}]}},{"type":"group","label":"Fulfilment Inventory","link":"/openapi/fulfilment-inventory","routeSlug":"/openapi/fulfilment-inventory","items":[{"label":"Get Inventory Batch\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch","routeSlug":"/openapi/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch","metadata":{"seo":{"title":"Get Inventory Batch\n","description":"Get a Single Batch"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetInventoryBatch","name":"Get Inventory Batch\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1batches~1{batchId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inventory Batch\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inventory/get:fulfilment_public_api.getinventorybatch/request/get-a-single-batch","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch#fulfilment-inventory/get:fulfilment_public_api.getinventorybatch/request/get-a-single-batch"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Single Batch"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.getinventorybatch/request/description","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch#fulfilment-inventory/get:fulfilment_public_api.getinventorybatch/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves details for a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"single inventory batch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by its unique batch ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.getinventorybatch/request/use-cases","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch#fulfilment-inventory/get:fulfilment_public_api.getinventorybatch/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Inspecting a specific batch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for available and unusable quantities. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Verifying batch expiry and manufacturing dates"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"batchId","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1batches~1{batchId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/batches/{batchId}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"batchId","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/batches/{batchId}","href":"fulfilment-inventory/get:fulfilment_public_api.getinventorybatch","openApiOperationId":"GET:fulfilment_public_api.GetInventoryBatch","summary":"Get Inventory Batch\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1batches~1{batchId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch"}],"panels":[]}]},"httpPath":"/api/fulfilment/batches/{batchId}"},{"label":"Get Inventory\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inventory/get:fulfilment_public_api.listinventory","routeSlug":"/openapi/fulfilment-inventory/get:fulfilment_public_api.listinventory","metadata":{"seo":{"title":"Get Inventory\n","description":"List All Inventory"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.ListInventory","name":"Get Inventory\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inventory/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inventory\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inventory/get:fulfilment_public_api.listinventory/request/list-all-inventory","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.listinventory#fulfilment-inventory/get:fulfilment_public_api.listinventory/request/list-all-inventory"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List All Inventory"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.listinventory/request/description","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.listinventory#fulfilment-inventory/get:fulfilment_public_api.listinventory/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"list of all inventory items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" stored in the fulfilment centre under your account. Clients can "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter the results"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using query parameters such as SKU or product ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.listinventory/request/use-cases","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.listinventory#fulfilment-inventory/get:fulfilment_public_api.listinventory/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Checking stock levels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before placing new orders."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Filtering inventory"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to track specific products."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Verifying stock availability"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for customer fulfilment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_36","description":"Maximum number of items to return per page (1-100)\n"},{"name":"page","in":"query","schemaId":"schema_36","description":"Page number to return (starts at 1)\n"},{"name":"sku","in":"query","schemaId":"schema_33","description":"Filter inventory by product SKU\n"},{"name":"product_name","in":"query","schemaId":"schema_33","description":"Filter inventory by product name\n"},{"name":"vendor","in":"query","schemaId":"schema_33","description":"Filter inventory by vendor name\n"},{"name":"sort","in":"query","schemaId":"schema_33","description":"Field to sort results by\n"},{"name":"sort_desc","in":"query","schemaId":"schema_37","description":"Sort in descending order if true\n"}],"pointer":"/paths/~1api~1fulfilment~1inventory/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inventory","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_36","style":"form","explode":true},{"name":"page","in":"query","schemaId":"schema_36","style":"form","explode":true},{"name":"sku","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"product_name","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"vendor","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"sort","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"sort_desc","in":"query","schemaId":"schema_37","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inventory","href":"fulfilment-inventory/get:fulfilment_public_api.listinventory","openApiOperationId":"GET:fulfilment_public_api.ListInventory","summary":"Get Inventory\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inventory/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inventory/get:fulfilment_public_api.listinventory"}],"panels":[]}]},"httpPath":"/api/fulfilment/inventory"},{"label":"Adjust Stock\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inventory/post:fulfilment_public_api.adjuststock","routeSlug":"/openapi/fulfilment-inventory/post:fulfilment_public_api.adjuststock","metadata":{"seo":{"title":"Adjust Stock\n","description":"Adjust Stock for a Specific Bucket"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.AdjustStock","name":"Adjust Stock\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inventory~1adjustments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Adjust Stock\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inventory/post:fulfilment_public_api.adjuststock/request/adjust-stock-for-a-specific-bucket","deepLinkHash":"/fulfilment-inventory/post:fulfilment_public_api.adjuststock#fulfilment-inventory/post:fulfilment_public_api.adjuststock/request/adjust-stock-for-a-specific-bucket"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adjust Stock for a Specific Bucket"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/post:fulfilment_public_api.adjuststock/request/description","deepLinkHash":"/fulfilment-inventory/post:fulfilment_public_api.adjuststock#fulfilment-inventory/post:fulfilment_public_api.adjuststock/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"manual stock adjustments"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific inventory bucket. The adjustment is applied as a delta (positive or negative) and recorded as an inventory movement."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/post:fulfilment_public_api.adjuststock/request/use-cases","deepLinkHash":"/fulfilment-inventory/post:fulfilment_public_api.adjuststock#fulfilment-inventory/post:fulfilment_public_api.adjuststock/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Writing off damaged stock"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from the damaged bucket. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Correcting stock discrepancies"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after physical counts. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Moving stock to QC hold"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for quality inspection."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39","pointer":"/paths/~1api~1fulfilment~1inventory~1adjustments/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/inventory/adjustments","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_39"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/inventory/adjustments","href":"fulfilment-inventory/post:fulfilment_public_api.adjuststock","openApiOperationId":"POST:fulfilment_public_api.AdjustStock","summary":"Adjust Stock\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_39"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inventory~1adjustments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inventory/post:fulfilment_public_api.adjuststock"}],"panels":[]}]},"httpPath":"/api/fulfilment/inventory/adjustments"},{"label":"Get Inventory By SKU\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku","routeSlug":"/openapi/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku","metadata":{"seo":{"title":"Get Inventory By SKU\n","description":"Get Inventory for a Specific Product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetInventoryBySku","name":"Get Inventory By SKU\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inventory By SKU\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inventory/get:fulfilment_public_api.getinventorybysku/request/get-inventory-for-a-specific-product","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku#fulfilment-inventory/get:fulfilment_public_api.getinventorybysku/request/get-inventory-for-a-specific-product"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Inventory for a Specific Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.getinventorybysku/request/description","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku#fulfilment-inventory/get:fulfilment_public_api.getinventorybysku/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"inventory details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific product using its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"productId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response includes "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stock availability, storage location, and last update timestamp"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.getinventorybysku/request/use-cases","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku#fulfilment-inventory/get:fulfilment_public_api.getinventorybysku/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Checking real-time stock levels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific product."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Verifying if a product is available"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in a fulfilment centre."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Monitoring stock movements"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to optimise replenishment."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inventory/{sku}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"sku","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inventory/{sku}","href":"fulfilment-inventory/get:fulfilment_public_api.getinventorybysku","openApiOperationId":"GET:fulfilment_public_api.GetInventoryBySku","summary":"Get Inventory By SKU\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_41"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku"}],"panels":[]}]},"httpPath":"/api/fulfilment/inventory/{sku}"},{"label":"List Inventory Batches\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches","routeSlug":"/openapi/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches","metadata":{"seo":{"title":"List Inventory Batches\n","description":"List Batches for a Product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.ListInventoryBatches","name":"List Inventory Batches\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}~1batches/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Inventory Batches\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inventory/get:fulfilment_public_api.listinventorybatches/request/list-batches-for-a-product","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches#fulfilment-inventory/get:fulfilment_public_api.listinventorybatches/request/list-batches-for-a-product"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List Batches for a Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.listinventorybatches/request/description","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches#fulfilment-inventory/get:fulfilment_public_api.listinventorybatches/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"batch-level inventory data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific product identified by its SKU. Each batch includes its batch number, expiry date, manufacturing date, and quantity breakdown."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inventory/get:fulfilment_public_api.listinventorybatches/request/use-cases","deepLinkHash":"/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches#fulfilment-inventory/get:fulfilment_public_api.listinventorybatches/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Viewing batch-level stock breakdown"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a batch-managed product. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering batches by expiry date"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to identify stock expiring soon. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Looking up a specific batch"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by batch number."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}~1batches/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"batch_number","in":"query","schemaId":"schema_33","description":"Filter by batch number (exact match)\n"},{"name":"expiring_before","in":"query","schemaId":"schema_33","description":"Filter batches expiring on or before this date (YYYY-MM-DD)\n"}],"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}~1batches/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inventory/{sku}/batches","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"sku","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[{"name":"batch_number","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"expiring_before","in":"query","schemaId":"schema_33","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inventory/{sku}/batches","href":"fulfilment-inventory/get:fulfilment_public_api.listinventorybatches","openApiOperationId":"GET:fulfilment_public_api.ListInventoryBatches","summary":"List Inventory Batches\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}},"schemaId":"schema_42"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inventory~1{sku}~1batches/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_42","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches"}],"panels":[]}]},"httpPath":"/api/fulfilment/inventory/{sku}/batches"}],"content":{"contentType":"group","meta":{"name":"Fulfilment Inventory"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fulfilment Inventory","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/fulfilment/batches/{batchId}","summary":"Get Inventory Batch\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybatch","deprecated":false},{"title":"/api/fulfilment/inventory","summary":"Get Inventory\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inventory/get:fulfilment_public_api.listinventory","deprecated":false},{"title":"/api/fulfilment/inventory/adjustments","summary":"Adjust Stock\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-inventory/post:fulfilment_public_api.adjuststock","deprecated":false},{"title":"/api/fulfilment/inventory/{sku}","summary":"Get Inventory By SKU\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inventory/get:fulfilment_public_api.getinventorybysku","deprecated":false},{"title":"/api/fulfilment/inventory/{sku}/batches","summary":"List Inventory Batches\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inventory/get:fulfilment_public_api.listinventorybatches","deprecated":false}]}]}]}]}},{"type":"group","label":"Fulfilment Inbound","link":"/openapi/fulfilment-inbound","routeSlug":"/openapi/fulfilment-inbound","items":[{"label":"Book Inbound Delivery\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/post:fulfilment_public_api.bookinbound","routeSlug":"/openapi/fulfilment-inbound/post:fulfilment_public_api.bookinbound","metadata":{"seo":{"title":"Book Inbound Delivery\n","description":"Book an Inbound Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.BookInbound","name":"Book Inbound Delivery\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbound~1book/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Book Inbound Delivery\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/book-an-inbound-delivery","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound#fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/book-an-inbound-delivery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Book an Inbound Delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/description","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound#fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"book an inbound delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to a warehouse. The system handles the complete lifecycle of inbound deliveries from booking to goods receipt."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/use-cases","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound#fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Scheduling warehouse deliveries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inventory restocking - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Booking collection slots"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for pickup from suppliers - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Managing inbound logistics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with proper documentation - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking delivery status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through the fulfillment system"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/required-information","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound#fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/required-information"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📋 Required Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Time Slot"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Start and end times for the delivery window - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attendees"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List of people who will be present for the delivery - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": List of products being delivered with quantities"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: The warehouse is automatically determined from your account's facility configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/optional-information","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound#fulfilment-inbound/post:fulfilment_public_api.bookinbound/request/optional-information"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📄 Optional Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Pickup Details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": If collection is required from a supplier - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Supporting files like invoices or manifests - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Custom Labels"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Human-readable slot identifiers"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43","pointer":"/paths/~1api~1fulfilment~1inbound~1book/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/inbound/book","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbound/book","href":"fulfilment-inbound/post:fulfilment_public_api.bookinbound","openApiOperationId":"POST:fulfilment_public_api.BookInbound","summary":"Book Inbound Delivery\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbound~1book/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbound/book"},{"label":"Get Inbound Delivery\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinbound","routeSlug":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinbound","metadata":{"seo":{"title":"Get Inbound Delivery\n","description":"Get Single Inbound Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetInbound","name":"Get Inbound Delivery\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbound~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inbound Delivery\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbound/request/get-single-inbound-delivery","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbound#fulfilment-inbound/get:fulfilment_public_api.getinbound/request/get-single-inbound-delivery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Single Inbound Delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbound/request/description","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbound#fulfilment-inbound/get:fulfilment_public_api.getinbound/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"specific inbound delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by its ID. You can view detailed delivery information and track individual delivery progress."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbound/request/use-cases","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbound#fulfilment-inbound/get:fulfilment_public_api.getinbound/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Viewing specific delivery details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for detailed tracking - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking delivery status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for operational planning - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Accessing delivery documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and supporting files - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitoring individual delivery progress"},"children":[]}]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inbound~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inbound/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbound/{id}","href":"fulfilment-inbound/get:fulfilment_public_api.getinbound","openApiOperationId":"GET:fulfilment_public_api.GetInbound","summary":"Get Inbound Delivery\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbound~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/get:fulfilment_public_api.getinbound"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbound/{id}"},{"label":"Get Inbound State History\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory","routeSlug":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory","metadata":{"seo":{"title":"Get Inbound State History\n","description":"Get Inbound State History"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetInboundStateHistory","name":"Get Inbound State History\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbound~1{id}~1state-history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inbound State History\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory/request/get-inbound-state-history","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory#fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory/request/get-inbound-state-history"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Inbound State History"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory/request/description","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory#fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"state change history"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific inbound delivery. The history tracks all status transitions from booking to completion."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory/request/use-cases","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory#fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Tracking delivery progress"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" through different stages"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Auditing status changes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for compliance and reporting"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Debugging issues"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by reviewing the state transition timeline"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Understanding delivery lifecycle"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" events"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inbound~1{id}~1state-history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inbound/{id}/state-history","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbound/{id}/state-history","href":"fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory","openApiOperationId":"GET:fulfilment_public_api.GetInboundStateHistory","summary":"Get Inbound State History\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}},"schemaId":"schema_46"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbound~1{id}~1state-history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_46","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_46"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbound/{id}/state-history"},{"label":"List Inbound Deliveries\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinbounds","routeSlug":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinbounds","metadata":{"seo":{"title":"List Inbound Deliveries\n","description":"List All Inbound Deliveries"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetInbounds","name":"List Inbound Deliveries\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbounds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Inbound Deliveries\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbounds/request/list-all-inbound-deliveries","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbounds#fulfilment-inbound/get:fulfilment_public_api.getinbounds/request/list-all-inbound-deliveries"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List All Inbound Deliveries"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbounds/request/description","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbounds#fulfilment-inbound/get:fulfilment_public_api.getinbounds/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"all inbound deliveries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the authenticated user. You can view delivery history and track multiple deliveries across different time slots."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbounds/request/use-cases","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbounds#fulfilment-inbound/get:fulfilment_public_api.getinbounds/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Viewing delivery history"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inventory management - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tracking multiple deliveries"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" across different time slots - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Monitoring delivery status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for planning purposes - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auditing inbound logistics"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for reporting"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_36","description":"Maximum number of items to return per page (1-100)\n"},{"name":"page","in":"query","schemaId":"schema_36","description":"Page number to return (starts at 1)\n"},{"name":"sort","in":"query","schemaId":"schema_33","description":"Field to sort results by\n"},{"name":"sort_desc","in":"query","schemaId":"schema_37","description":"Sort in descending order if true\n"},{"name":"state","in":"query","schemaId":"schema_33","description":"Filter by inbound status\n"},{"name":"ids","in":"query","schemaId":"schema_47","description":"Filter by inbound IDs\n"},{"name":"asn_id","in":"query","schemaId":"schema_33","description":"Filter by WMS ASN ID\n"},{"name":"type","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter by inbound type (inbound, client_return, facility_return)"},"children":[]}]}]}]},{"name":"client_id","in":"query","schemaId":"schema_33","description":"Filter by client ID (admin only)\n"},{"name":"slot_from","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter to inbounds whose delivery slot STARTS on or after this date (YYYY-MM-DD, UTC). This is the arrival date, not the booking date. Inclusive, and usable without slot_to. Unscheduled (PENDING) inbounds have no arrival date and are excluded by this filter."},"children":[]}]}]}]},{"name":"slot_to","in":"query","schemaId":"schema_33","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter to inbounds whose delivery slot STARTS on or before this date (YYYY-MM-DD, UTC). Inclusive — the whole of this day counts as inside the range — and usable without slot_from. Sending a slot_from later than slot_to is rejected with 400."},"children":[]}]}]}]}],"pointer":"/paths/~1api~1fulfilment~1inbounds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inbounds","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_36","style":"form","explode":true},{"name":"page","in":"query","schemaId":"schema_36","style":"form","explode":true},{"name":"sort","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"sort_desc","in":"query","schemaId":"schema_37","style":"form","explode":true},{"name":"state","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"ids","in":"query","schemaId":"schema_47","style":"form","explode":true},{"name":"asn_id","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"type","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"client_id","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"slot_from","in":"query","schemaId":"schema_33","style":"form","explode":true},{"name":"slot_to","in":"query","schemaId":"schema_33","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbounds","href":"fulfilment-inbound/get:fulfilment_public_api.getinbounds","openApiOperationId":"GET:fulfilment_public_api.GetInbounds","summary":"List Inbound Deliveries\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbounds/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_48"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/get:fulfilment_public_api.getinbounds"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbounds"},{"label":"Update Inbound Delivery\n","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/patch:fulfilment_public_api.updateinbound","routeSlug":"/openapi/fulfilment-inbound/patch:fulfilment_public_api.updateinbound","metadata":{"seo":{"title":"Update Inbound Delivery\n","description":"Update an Existing Inbound Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH:fulfilment_public_api.UpdateInbound","name":"Update Inbound Delivery\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Inbound Delivery\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/patch:fulfilment_public_api.updateinbound/request/update-an-existing-inbound-delivery","deepLinkHash":"/fulfilment-inbound/patch:fulfilment_public_api.updateinbound#fulfilment-inbound/patch:fulfilment_public_api.updateinbound/request/update-an-existing-inbound-delivery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update an Existing Inbound Delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/patch:fulfilment_public_api.updateinbound/request/description","deepLinkHash":"/fulfilment-inbound/patch:fulfilment_public_api.updateinbound#fulfilment-inbound/patch:fulfilment_public_api.updateinbound/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update an existing inbound delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with courier details, gate pass information, and/or schedule a PENDING inbound."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/patch:fulfilment_public_api.updateinbound/request/use-cases","deepLinkHash":"/fulfilment-inbound/patch:fulfilment_public_api.updateinbound#fulfilment-inbound/patch:fulfilment_public_api.updateinbound/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Adding courier/gate pass details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (plate number, courier name, contact) to an inbound - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attaching documents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" such as emirates ID, vehicle registration, or gate passes - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduling a PENDING inbound"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by providing slot times and attendees"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49","pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/fulfilment/inbounds/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_49"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbounds/{id}","href":"fulfilment-inbound/patch:fulfilment_public_api.updateinbound","openApiOperationId":"PATCH:fulfilment_public_api.UpdateInbound","summary":"Update Inbound Delivery\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_49"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/patch:fulfilment_public_api.updateinbound"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbounds/{id}"},{"label":"Cancel Inbound Delivery\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/post:fulfilment_public_api.cancelinbound","routeSlug":"/openapi/fulfilment-inbound/post:fulfilment_public_api.cancelinbound","metadata":{"seo":{"title":"Cancel Inbound Delivery\n","description":"Cancel an Inbound Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.CancelInbound","name":"Cancel Inbound Delivery\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1cancel/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Cancel Inbound Delivery\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/cancel-an-inbound-delivery","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.cancelinbound#fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/cancel-an-inbound-delivery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Cancel an Inbound Delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/description","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.cancelinbound#fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancel an inbound delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. Cancellation is a soft delete - the record remains in the database with status "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CANCELLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The system handles cleanup of the WMS ASN, scheduling event, and facility notification."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/use-cases","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.cancelinbound#fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Cancelling a delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that is no longer needed - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rescheduling"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by cancelling and rebooking with new details"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/restrictions","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.cancelinbound#fulfilment-inbound/post:fulfilment_public_api.cancelinbound/request/restrictions"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only inbounds in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"BOOKED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IN_PROGRESS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status can be cancelled - You can only cancel your own inbounds (unless you are an admin)"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1cancel/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51","pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1cancel/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/inbounds/{id}/cancel","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_51"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbounds/{id}/cancel","href":"fulfilment-inbound/post:fulfilment_public_api.cancelinbound","openApiOperationId":"POST:fulfilment_public_api.CancelInbound","summary":"Cancel Inbound Delivery\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_51"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52"}},"schemaId":"schema_52"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1cancel/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_52","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/post:fulfilment_public_api.cancelinbound"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbounds/{id}/cancel"},{"label":"Get Inbound Items\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinbounditems","routeSlug":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getinbounditems","metadata":{"seo":{"title":"Get Inbound Items\n","description":"List GRN Line Items"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetInboundItems","name":"Get Inbound Items\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1items/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Inbound Items\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbounditems/request/list-grn-line-items","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbounditems#fulfilment-inbound/get:fulfilment_public_api.getinbounditems/request/list-grn-line-items"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List GRN Line Items"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbounditems/request/description","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbounditems#fulfilment-inbound/get:fulfilment_public_api.getinbounditems/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"line items"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (GRN details) for a specific inbound delivery. Each item includes SKU, quantities (expected, received, usable, unusable, quarantine), batch number, expiry date, and manufacturing date."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getinbounditems/request/use-cases","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getinbounditems#fulfilment-inbound/get:fulfilment_public_api.getinbounditems/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Reviewing received quantities"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" against expected quantities. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Checking batch and expiry details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for received goods. - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Auditing GRN data"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific inbound."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1items/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/inbounds/{id}/items","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbounds/{id}/items","href":"fulfilment-inbound/get:fulfilment_public_api.getinbounditems","openApiOperationId":"GET:fulfilment_public_api.GetInboundItems","summary":"Get Inbound Items\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1items/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/get:fulfilment_public_api.getinbounditems"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbounds/{id}/items"},{"label":"Schedule Inbound Delivery\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound","routeSlug":"/openapi/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound","metadata":{"seo":{"title":"Schedule Inbound Delivery\n","description":"Schedule a Pending Inbound Delivery"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.ScheduleInbound","name":"Schedule Inbound Delivery\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1schedule/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Schedule Inbound Delivery\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/post:fulfilment_public_api.scheduleinbound/request/schedule-a-pending-inbound-delivery","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound#fulfilment-inbound/post:fulfilment_public_api.scheduleinbound/request/schedule-a-pending-inbound-delivery"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Schedule a Pending Inbound Delivery"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.scheduleinbound/request/description","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound#fulfilment-inbound/post:fulfilment_public_api.scheduleinbound/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"schedule a previously unscheduled (PENDING) inbound delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by providing slot times and attendees. The inbound will transition from PENDING to BOOKED and the full scheduling workflow (ASN creation, calendar booking, notifications) will be triggered."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/post:fulfilment_public_api.scheduleinbound/request/use-cases","deepLinkHash":"/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound#fulfilment-inbound/post:fulfilment_public_api.scheduleinbound/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Scheduling a delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that was created without dates - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Setting delivery times"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a pending inbound after coordination with the warehouse"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1schedule/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54","pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1schedule/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/inbounds/{id}/schedule","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_54"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/inbounds/{id}/schedule","href":"fulfilment-inbound/post:fulfilment_public_api.scheduleinbound","openApiOperationId":"POST:fulfilment_public_api.ScheduleInbound","summary":"Schedule Inbound Delivery\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_54"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1inbounds~1{id}~1schedule/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound"}],"panels":[]}]},"httpPath":"/api/fulfilment/inbounds/{id}/schedule"},{"label":"Get Available Slots\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getavailableslots","routeSlug":"/openapi/fulfilment-inbound/get:fulfilment_public_api.getavailableslots","metadata":{"seo":{"title":"Get Available Slots\n","description":"Get Available Time Slots"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetAvailableSlots","name":"Get Available Slots\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1slots~1available/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Available Slots\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-inbound/get:fulfilment_public_api.getavailableslots/request/get-available-time-slots","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getavailableslots#fulfilment-inbound/get:fulfilment_public_api.getavailableslots/request/get-available-time-slots"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get Available Time Slots"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getavailableslots/request/description","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getavailableslots#fulfilment-inbound/get:fulfilment_public_api.getavailableslots/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"available time slots"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inbound deliveries. You can specify a time range to get all available slots within that period."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The warehouse is resolved automatically from your account's facility. There is no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"warehouse_code"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter; any value sent for it is ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-inbound/get:fulfilment_public_api.getavailableslots/request/use-cases","deepLinkHash":"/fulfilment-inbound/get:fulfilment_public_api.getavailableslots#fulfilment-inbound/get:fulfilment_public_api.getavailableslots/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Checking available delivery slots"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before booking an inbound - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Planning delivery schedules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inventory restocking - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finding suitable time windows"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for warehouse deliveries - "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optimizing delivery planning"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on availability"},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start_time","in":"query","schemaId":"schema_55","required":true},{"name":"end_time","in":"query","schemaId":"schema_55","required":true}],"pointer":"/paths/~1api~1fulfilment~1slots~1available/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/slots/available","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[{"name":"start_time","in":"query","required":true,"schemaId":"schema_55","style":"form","explode":true},{"name":"end_time","in":"query","required":true,"schemaId":"schema_55","style":"form","explode":true}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/slots/available","href":"fulfilment-inbound/get:fulfilment_public_api.getavailableslots","openApiOperationId":"GET:fulfilment_public_api.GetAvailableSlots","summary":"Get Available Slots\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1slots~1available/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-inbound/get:fulfilment_public_api.getavailableslots"}],"panels":[]}]},"httpPath":"/api/fulfilment/slots/available"}],"content":{"contentType":"group","meta":{"name":"Fulfilment Inbound"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fulfilment Inbound","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/fulfilment/inbound/book","summary":"Book Inbound Delivery\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-inbound/post:fulfilment_public_api.bookinbound","deprecated":false},{"title":"/api/fulfilment/inbound/{id}","summary":"Get Inbound Delivery\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inbound/get:fulfilment_public_api.getinbound","deprecated":false},{"title":"/api/fulfilment/inbound/{id}/state-history","summary":"Get Inbound State History\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inbound/get:fulfilment_public_api.getinboundstatehistory","deprecated":false},{"title":"/api/fulfilment/inbounds","summary":"List Inbound Deliveries\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inbound/get:fulfilment_public_api.getinbounds","deprecated":false},{"title":"/api/fulfilment/inbounds/{id}","summary":"Update Inbound Delivery\n","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fulfilment-inbound/patch:fulfilment_public_api.updateinbound","deprecated":false},{"title":"/api/fulfilment/inbounds/{id}/cancel","summary":"Cancel Inbound Delivery\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-inbound/post:fulfilment_public_api.cancelinbound","deprecated":false},{"title":"/api/fulfilment/inbounds/{id}/items","summary":"Get Inbound Items\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inbound/get:fulfilment_public_api.getinbounditems","deprecated":false},{"title":"/api/fulfilment/inbounds/{id}/schedule","summary":"Schedule Inbound Delivery\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-inbound/post:fulfilment_public_api.scheduleinbound","deprecated":false},{"title":"/api/fulfilment/slots/available","summary":"Get Available Slots\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-inbound/get:fulfilment_public_api.getavailableslots","deprecated":false}]}]}]}]}},{"type":"group","label":"Fulfilment Orders","link":"/openapi/fulfilment-orders","routeSlug":"/openapi/fulfilment-orders","items":[{"label":"Create Order\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder","routeSlug":"/openapi/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder","metadata":{"seo":{"title":"Create Order\n","description":"Create a Fulfilment Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.CreateFulfilmentOrder","name":"Create Order\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Order\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/create-a-fulfilment-order","deepLinkHash":"/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder#fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/create-a-fulfilment-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Fulfilment Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/description","deepLinkHash":"/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder#fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to create a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"fulfilment order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"service_kind"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field determines the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"picking & packing SLA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" based on your account's cut-off times and automatically selects the appropriate "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"delivery service"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the carrier."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/available-service-kinds:","deepLinkHash":"/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder#fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/available-service-kinds:"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Available Service Kinds:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"partner_next_day"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Next-day delivery (standard service), available in "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UAE & KSA"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"partner_same_day"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → Same-day delivery, currently "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only available in the UAE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"partner_4hr"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → 4-hour deliveries, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only available in Dubai"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"partner_export"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" → International shipments, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"carrier allocation is rule-based"},"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":"Additionally, return orders can be created by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_return"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/use-cases","deepLinkHash":"/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder#fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Creating a new customer order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for fulfilment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Processing a return order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"is_return: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Handling multi-item orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with various delivery options."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Managing payment-on-delivery orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"payment_mode: paid_on_delivery"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","pointer":"/paths/~1api~1fulfilment~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/orders","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_57"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/orders","href":"fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder","openApiOperationId":"POST:fulfilment_public_api.CreateFulfilmentOrder","summary":"Create Order\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder"}],"panels":[]}]},"httpPath":"/api/fulfilment/orders"},{"label":"Get Order\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder","routeSlug":"/openapi/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder","metadata":{"seo":{"title":"Get Order\n","description":"Get a Fulfilment Order by ID"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetFulfilmentOrder","name":"Get Order\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1orders~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Order\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder/request/get-a-fulfilment-order-by-id","deepLinkHash":"/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder#fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder/request/get-a-fulfilment-order-by-id"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Fulfilment Order by ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder/request/description","deepLinkHash":"/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder#fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves the details of an "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"existing fulfilment order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" using its unique ID."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder/request/use-cases","deepLinkHash":"/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder#fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Checking the status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of a previously created fulfilment order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Retrieving tracking details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to share with customers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Confirming order information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before dispatch or customer communication."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Verifying payment and service type"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an order."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1orders~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/orders/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/orders/{id}","href":"fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder","openApiOperationId":"GET:fulfilment_public_api.GetFulfilmentOrder","summary":"Get Order\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1orders~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder"}],"panels":[]}]},"httpPath":"/api/fulfilment/orders/{id}"},{"label":"Update Order\n","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder","routeSlug":"/openapi/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder","metadata":{"seo":{"title":"Update Order\n","description":"Update a Fulfilment Order"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH:fulfilment_public_api.UpdateFulfilmentOrder","name":"Update Order\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1orders~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Order\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder/request/update-a-fulfilment-order","deepLinkHash":"/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder#fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder/request/update-a-fulfilment-order"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Fulfilment Order"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder/request/description","deepLinkHash":"/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder#fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"update an existing fulfilment order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Depending on the current order status, some fields "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"may not be modifiable"},"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":"For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order is already "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"out for delivery"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the shipping address "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cannot be changed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the order has been "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"picked and packed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", modifications to products are no longer possible."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders that are "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"cancelled or completed"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder/request/use-cases","deepLinkHash":"/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder#fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Updating the shipping address"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before the order is dispatched."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Modifying payment details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before dispatched."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Adjusting product quantities"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before fulfilment begins."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Cancelling an order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if it has not yet been picked and packed."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1orders~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59","pointer":"/paths/~1api~1fulfilment~1orders~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/fulfilment/orders/{id}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_59"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/orders/{id}","href":"fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder","openApiOperationId":"PATCH:fulfilment_public_api.UpdateFulfilmentOrder","summary":"Update Order\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1orders~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder"}],"panels":[]}]},"httpPath":"/api/fulfilment/orders/{id}"}],"content":{"contentType":"group","meta":{"name":"Fulfilment Orders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fulfilment Orders","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/fulfilment/orders","summary":"Create Order\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-orders/post:fulfilment_public_api.createfulfilmentorder","deprecated":false},{"title":"/api/fulfilment/orders/{id}","summary":"Get Order\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-orders/get:fulfilment_public_api.getfulfilmentorder","deprecated":false},{"title":"/api/fulfilment/orders/{id}","summary":"Update Order\n","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fulfilment-orders/patch:fulfilment_public_api.updatefulfilmentorder","deprecated":false}]}]}]}]}},{"type":"group","label":"Fulfilment Products","link":"/openapi/fulfilment-products","routeSlug":"/openapi/fulfilment-products","items":[{"label":"Create Product\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-products/post:fulfilment_public_api.createproduct","routeSlug":"/openapi/fulfilment-products/post:fulfilment_public_api.createproduct","metadata":{"seo":{"title":"Create Product\n","description":"Create a Product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.CreateProduct","name":"Create Product\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1products/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create Product\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-products/post:fulfilment_public_api.createproduct/request/create-a-product","deepLinkHash":"/fulfilment-products/post:fulfilment_public_api.createproduct#fulfilment-products/post:fulfilment_public_api.createproduct/request/create-a-product"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create a Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/post:fulfilment_public_api.createproduct/request/description","deepLinkHash":"/fulfilment-products/post:fulfilment_public_api.createproduct#fulfilment-products/post:fulfilment_public_api.createproduct/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"create a new product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the fulfilment system. Each product must have a "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"unique SKU"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and essential details such as "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pricing, inventory tracking settings, and dimensions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/post:fulfilment_public_api.createproduct/request/use-cases","deepLinkHash":"/fulfilment-products/post:fulfilment_public_api.createproduct#fulfilment-products/post:fulfilment_public_api.createproduct/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Adding a new product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to the fulfilment system."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Defining product pricing and inventory tracking settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Configuring product dimensions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for warehouse storage and shipping calculations."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60","pointer":"/paths/~1api~1fulfilment~1products/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/products","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_60"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/products","href":"fulfilment-products/post:fulfilment_public_api.createproduct","openApiOperationId":"POST:fulfilment_public_api.CreateProduct","summary":"Create Product\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_60"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1products/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-products/post:fulfilment_public_api.createproduct"}],"panels":[]}]},"httpPath":"/api/fulfilment/products"},{"label":"Bulk Commit Products\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-products/post:fulfilment_public_api.bulkcommitproducts","routeSlug":"/openapi/fulfilment-products/post:fulfilment_public_api.bulkcommitproducts","metadata":{"seo":{"title":"Bulk Commit Products\n","description":"Commit a bulk product upload"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.BulkCommitProducts","name":"Bulk Commit Products\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1products~1bulk~1commit/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Commit Products\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-products/post:fulfilment_public_api.bulkcommitproducts/request/commit-a-bulk-product-upload","deepLinkHash":"/fulfilment-products/post:fulfilment_public_api.bulkcommitproducts#fulfilment-products/post:fulfilment_public_api.bulkcommitproducts/request/commit-a-bulk-product-upload"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Commit a bulk product upload"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parses, validates, and creates/updates products from a CSV or XLSX file. Duplicates are either updated or skipped based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"update_duplicates"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" form field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note: this operation is NOT atomic. Each row is processed individually, so a partial failure will leave some rows committed and others not. The per-row status in the response indicates exactly which rows succeeded or failed, allowing the caller to handle retries."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/products/bulk/commit","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/products/bulk/commit","href":"fulfilment-products/post:fulfilment_public_api.bulkcommitproducts","openApiOperationId":"POST:fulfilment_public_api.BulkCommitProducts","summary":"Bulk Commit Products\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1products~1bulk~1commit/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-products/post:fulfilment_public_api.bulkcommitproducts"}],"panels":[]}]},"httpPath":"/api/fulfilment/products/bulk/commit"},{"label":"Bulk Validate Products\n","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts","routeSlug":"/openapi/fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts","metadata":{"seo":{"title":"Bulk Validate Products\n","description":"Validate a bulk product upload file"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST:fulfilment_public_api.BulkValidateProducts","name":"Bulk Validate Products\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1products~1bulk~1validate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Bulk Validate Products\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts/request/validate-a-bulk-product-upload-file","deepLinkHash":"/fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts#fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts/request/validate-a-bulk-product-upload-file"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validate a bulk product upload file"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Parses a CSV or XLSX file and validates each row without persisting anything. Returns per-row validation status so the caller can preview before committing."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/api/fulfilment/products/bulk/validate","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/products/bulk/validate","href":"fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts","openApiOperationId":"POST:fulfilment_public_api.BulkValidateProducts","summary":"Bulk Validate Products\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1products~1bulk~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts"}],"panels":[]}]},"httpPath":"/api/fulfilment/products/bulk/validate"},{"label":"Get Product\n","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-products/get:fulfilment_public_api.getproductbysku","routeSlug":"/openapi/fulfilment-products/get:fulfilment_public_api.getproductbysku","metadata":{"seo":{"title":"Get Product\n","description":"Get a Product by SKU"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET:fulfilment_public_api.GetProductBySKU","name":"Get Product\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1products~1{sku}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Product\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-products/get:fulfilment_public_api.getproductbysku/request/get-a-product-by-sku","deepLinkHash":"/fulfilment-products/get:fulfilment_public_api.getproductbysku#fulfilment-products/get:fulfilment_public_api.getproductbysku/request/get-a-product-by-sku"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get a Product by SKU"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/get:fulfilment_public_api.getproductbysku/request/description","deepLinkHash":"/fulfilment-products/get:fulfilment_public_api.getproductbysku#fulfilment-products/get:fulfilment_public_api.getproductbysku/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint retrieves "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"detailed information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" about a specific product using its unique "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sku"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The response includes "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"product metadata, pricing, inventory tracking status, and fulfilment-related details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/get:fulfilment_public_api.getproductbysku/request/use-cases","deepLinkHash":"/fulfilment-products/get:fulfilment_public_api.getproductbysku#fulfilment-products/get:fulfilment_public_api.getproductbysku/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Fetching product details"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to confirm SKU, pricing, and inventory settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Displaying product information"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in an eCommerce system or inventory dashboard."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Ensuring a product is active and available"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" before placing a fulfilment order."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/get:fulfilment_public_api.getproductbysku/request/parameters","deepLinkHash":"/fulfilment-products/get:fulfilment_public_api.getproductbysku#fulfilment-products/get:fulfilment_public_api.getproductbysku/request/parameters"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Parameters"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":": The unique id or sku of the product."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1products~1{sku}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/api/fulfilment/products/{sku}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"sku","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/api/fulfilment/products/{sku}","href":"fulfilment-products/get:fulfilment_public_api.getproductbysku","openApiOperationId":"GET:fulfilment_public_api.GetProductBySKU","summary":"Get Product\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-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":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1products~1{sku}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-products/get:fulfilment_public_api.getproductbysku"}],"panels":[]}]},"httpPath":"/api/fulfilment/products/{sku}"},{"label":"Update Product\n","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/openapi/fulfilment-products/patch:fulfilment_public_api.updateproduct","routeSlug":"/openapi/fulfilment-products/patch:fulfilment_public_api.updateproduct","metadata":{"seo":{"title":"Update Product\n","description":"Update a Product"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PATCH:fulfilment_public_api.UpdateProduct","name":"Update Product\n","isWebhook":false,"pointer":"/paths/~1api~1fulfilment~1products~1{sku}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Product\n","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"fulfilment-products/patch:fulfilment_public_api.updateproduct/request/update-a-product","deepLinkHash":"/fulfilment-products/patch:fulfilment_public_api.updateproduct#fulfilment-products/patch:fulfilment_public_api.updateproduct/request/update-a-product"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update a Product"},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/patch:fulfilment_public_api.updateproduct/request/description","deepLinkHash":"/fulfilment-products/patch:fulfilment_public_api.updateproduct#fulfilment-products/patch:fulfilment_public_api.updateproduct/request/description"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"📌 Description"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This endpoint allows you to "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"partially update an existing product"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Unlike "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POST"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which is used to create new products, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"only modifies specified fields"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an existing product."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"fulfilment-products/patch:fulfilment_public_api.updateproduct/request/use-cases","deepLinkHash":"/fulfilment-products/patch:fulfilment_public_api.updateproduct#fulfilment-products/patch:fulfilment_public_api.updateproduct/request/use-cases"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"🔹 Use Cases"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","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":"Updating product pricing"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" without affecting other attributes."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Changing product status"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (e.g., from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"active"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"archived"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"Modifying SKU or barcode"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" while keeping other details intact."},"children":[]}]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"OAuth2","scopes":[],"type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"sku","in":"path","schemaId":"schema_33","required":true}],"pointer":"/paths/~1api~1fulfilment~1products~1{sku}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60","pointer":"/paths/~1api~1fulfilment~1products~1{sku}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/api/fulfilment/products/{sku}","servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"parameters":{"path":[{"name":"sku","in":"path","required":true,"schemaId":"schema_33","style":"simple","explode":false}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_60"}},"responseCodes":["200","default"],"pointer":"/api/fulfilment/products/{sku}","href":"fulfilment-products/patch:fulfilment_public_api.updateproduct","openApiOperationId":"PATCH:fulfilment_public_api.UpdateProduct","summary":"Update Product\n"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/openapi","description":"Mock server","isMockServer":true},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}],"schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_60"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61"},{"code":"default","description":"Error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}},"schemaId":"schema_35"}],"pointer":"/paths/~1api~1fulfilment~1products~1{sku}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_61"}}},{"code":"default","schemaId":"schema_35","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_35"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/fulfilment-products/patch:fulfilment_public_api.updateproduct"}],"panels":[]}]},"httpPath":"/api/fulfilment/products/{sku}"}],"content":{"contentType":"group","meta":{"name":"Fulfilment Products"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Fulfilment Products","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/api/fulfilment/products","summary":"Create Product\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-products/post:fulfilment_public_api.createproduct","deprecated":false},{"title":"/api/fulfilment/products/bulk/commit","summary":"Bulk Commit Products\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-products/post:fulfilment_public_api.bulkcommitproducts","deprecated":false},{"title":"/api/fulfilment/products/bulk/validate","summary":"Bulk Validate Products\n","prefix":{"name":"post","color":"post"},"badges":[],"link":"/fulfilment-products/post:fulfilment_public_api.bulkvalidateproducts","deprecated":false},{"title":"/api/fulfilment/products/{sku}","summary":"Get Product\n","prefix":{"name":"get","color":"get"},"badges":[],"link":"/fulfilment-products/get:fulfilment_public_api.getproductbysku","deprecated":false},{"title":"/api/fulfilment/products/{sku}","summary":"Update Product\n","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/fulfilment-products/patch:fulfilment_public_api.updateproduct","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/data.Coordinate":{"id":"components/schemas/data.Coordinate","kind":"json-schema","title":"data.Coordinate","data":{"properties":{"latitude":{"title":"Geographic latitude\n","type":"number"},"longitude":{"title":"Geographic longitude\n","type":"number"}},"required":["latitude","longitude"],"type":"object"}},"components/schemas/datatypes.JSONType_data.Dimensions":{"id":"components/schemas/datatypes.JSONType_data.Dimensions","kind":"json-schema","title":"JSONType give a generic data type for json encoded data.\n","data":{"title":"JSONType give a generic data type for json encoded data.\n","type":"object"}},"components/schemas/pagination.PaginationMeta":{"id":"components/schemas/pagination.PaginationMeta","kind":"json-schema","title":"pagination.PaginationMeta","data":{"properties":{"next":{"$ref":"#/components/schemas/pagination.PaginationRequest"},"next_url":{"type":"string"},"prev":{"$ref":"#/components/schemas/pagination.PaginationRequest"},"prev_url":{"type":"string"},"total":{"format":"int64","type":"integer"}},"required":["total"],"type":"object"}},"components/schemas/pagination.PaginationRequest":{"id":"components/schemas/pagination.PaginationRequest","kind":"json-schema","title":"pagination.PaginationRequest","data":{"properties":{"limit":{"format":"int64","type":"integer"},"page":{"format":"int64","type":"integer"},"sort":{"type":"string"},"sort_desc":{"type":"boolean"}},"required":["limit","page","sort","sort_desc"],"type":"object"}},"components/schemas/types.AddressRequest":{"id":"components/schemas/types.AddressRequest","kind":"json-schema","title":"types.AddressRequest","data":{"properties":{"address1":{"title":"Primary street address.\n","type":"string"},"address2":{"title":"Additional address details (e.g., suite, apt number).\n","type":"string"},"city":{"title":"City of the address.\n","type":"string"},"coordinate":{"allOf":[{"$ref":"#/components/schemas/data.Coordinate"}],"title":"Geographic coordinates.\n"},"country":{"title":"Country name.\n","type":"string"},"country_code":{"title":"ISO2 Country code (required).\n","type":"string"},"email":{"title":"Email address associated with the address for contact.\n","type":"string"},"first_name":{"title":"First name of the person associated with the address.\n","type":"string"},"ksa_national_address":{"title":"National address code (e.g., Saudi Arabia's national address system).\n","type":"string"},"last_name":{"title":"Last name of the person associated with the address.\n","type":"string"},"name":{"title":"Full name used for addressing.\n","type":"string"},"notes":{"description":"Optional: Can include special instructions for the courier Maximum length: 500 characters\n","title":"Notes provides additional delivery instructions or information for this address.\n","type":"string"},"phone":{"title":"Phone number.\n","type":"string"},"postcode":{"title":"Postal code (could be used instead of or in addition to zip).\n","type":"string"},"state":{"title":"State, if applicable (could be similar to province).\n","type":"string"}},"required":["first_name","address1","city","country_code","email","phone"],"type":"object"}},"components/schemas/types.AvailableSlot":{"id":"components/schemas/types.AvailableSlot","kind":"json-schema","title":"AvailableSlot represents a simplified time slot with only start and end times\n","data":{"properties":{"end_time":{"format":"date-time","type":"string"},"start_time":{"format":"date-time","type":"string"}},"required":["start_time","end_time"],"title":"AvailableSlot represents a simplified time slot with only start and end times\n","type":"object"}},"components/schemas/types.Coordinate":{"id":"components/schemas/types.Coordinate","kind":"json-schema","title":"types.Coordinate","data":{"properties":{"latitude":{"title":"Latitude of the location (between -90 and 90 degrees)\n","type":"number"},"longitude":{"title":"Longitude of the location (between -180 and 180 degrees)\n","type":"number"}},"required":["latitude","longitude"],"type":"object"}},"components/schemas/types.CreateFulfilmentOrderAddressResponse":{"id":"components/schemas/types.CreateFulfilmentOrderAddressResponse","kind":"json-schema","title":"types.CreateFulfilmentOrderAddressResponse","data":{"properties":{"address1":{"title":"Primary street address.\n","type":"string"},"address2":{"title":"Additional address details (e.g., suite, apt number).\n","type":"string"},"city":{"title":"City of the address.\n","type":"string"},"coordinate":{"allOf":[{"$ref":"#/components/schemas/types.Coordinate"}],"title":"Geographic coordinates.\n"},"country":{"title":"Country name.\n","type":"string"},"country_code":{"title":"ISO2 Country code (required).\n","type":"string"},"created_at":{"format":"date-time","title":"Timestamp of when the address was created.\n","type":"string"},"email":{"title":"Email address associated with the address for contact.\n","type":"string"},"first_name":{"title":"First name of the person associated with the address.\n","type":"string"},"ksa_national_address":{"title":"National address code (e.g., Saudi Arabia's national address system).\n","type":"string"},"last_name":{"description":"Optional: Contact person's last name\n","title":"Last name of the contact person\n","type":"string"},"name":{"title":"Full name used for addressing.\n","type":"string"},"notes":{"title":"Notes contains additional delivery instructions or information for this address.\n","type":"string"},"phone":{"title":"Phone number.\n","type":"string"},"postcode":{"title":"Postal code (could be used instead of or in addition to zip).\n","type":"string"},"state":{"title":"State, if applicable (could be similar to province).\n","type":"string"},"updated_at":{"format":"date-time","title":"Timestamp of when the address was last updated.\n","type":"string"}},"type":"object"}},"components/schemas/types.Currency":{"id":"components/schemas/types.Currency","kind":"json-schema","title":"types.Currency","data":{"enum":["AED","SAR"],"type":"string"}},"components/schemas/types.DeliveryOption":{"id":"components/schemas/types.DeliveryOption","kind":"json-schema","title":"types.DeliveryOption","data":{"enum":["customer_identification_photo"],"type":"string"}},"components/schemas/types.Dimensions":{"id":"components/schemas/types.Dimensions","kind":"json-schema","title":"types.Dimensions","data":{"properties":{"height":{"title":"Height of the item in specified unit\n","type":"number"},"length":{"title":"Length of the item in specified unit\n","type":"number"},"unit":{"title":"Unit of measurement (e.g., cm, m)\n","type":"string"},"width":{"title":"Width of the item in specified unit\n","type":"number"}},"required":["height","width","length","unit"],"type":"object"}},"components/schemas/types.ExpiryGroup":{"id":"components/schemas/types.ExpiryGroup","kind":"json-schema","title":"types.ExpiryGroup","data":{"properties":{"expiry_date":{"format":"date-time","title":"Date when the product batch expires\n","type":"string"},"quantity":{"format":"int64","title":"Quantity of items in this expiry batch\n","type":"integer"}},"required":["expiry_date","quantity"],"type":"object"}},"components/schemas/types.Inbound":{"id":"components/schemas/types.Inbound","kind":"json-schema","title":"Inbound represents a single inbound delivery\n","data":{"properties":{"arrival_week":{"format":"date-time","title":"Week-start date for week-only bookings that have no exact slot yet\n","type":"string"},"asn_id":{"title":"ASN (Advance Shipment Notice) ID\n","type":"string"},"attendees":{"items":{"type":"string"},"title":"List of people who will be present for the delivery\n","type":"array"},"client_id":{"title":"Client ID that owns this inbound\n","type":"string"},"container_count":{"format":"int64","title":"Number of containers in the shipment\n","type":"integer"},"container_load":{"title":"Container load: \"full\" or \"half\"\n","type":"string"},"container_number":{"title":"Carrier-assigned container number\n","type":"string"},"container_size":{"title":"Container size: \"20ft\" or \"40ft\"\n","type":"string"},"courier_contact":{"title":"Contact number of the courier or driver\n","type":"string"},"courier_name":{"title":"Name of the courier or driver making the delivery\n","type":"string"},"created_at":{"format":"date-time","title":"When the inbound was created\n","type":"string"},"documents":{"items":{"$ref":"#/components/schemas/types.InboundDocument"},"title":"List of documents associated with the inbound\n","type":"array"},"error_message":{"title":"Error message if the inbound encountered any issues\n","type":"string"},"id":{"title":"Unique identifier for the inbound booking\n","type":"string"},"items":{"items":{"$ref":"#/components/schemas/types.InboundItemResponse"},"title":"List of items in the inbound delivery\n","type":"array"},"notes":{"title":"Free-text notes captured at booking time\n","type":"string"},"packaging_count":{"format":"int64","title":"Number of boxes or pallets in the shipment\n","type":"integer"},"packaging_type":{"title":"How the goods are packaged: \"boxes\" or \"pallet\"\n","type":"string"},"partner_inbound_id":{"title":"Client-provided reference ID for the inbound delivery\n","type":"string"},"pickup_address":{"allOf":[{"$ref":"#/components/schemas/types.PickupAddress"}],"title":"Pickup address if collection is required\n"},"pickup_contact":{"allOf":[{"$ref":"#/components/schemas/types.PickupContact"}],"title":"Pickup contact information if collection is required\n"},"pickup_window":{"title":"Pickup time window (e.g., \"9:00 AM - 12:00 PM\")\n","type":"string"},"plate_number":{"title":"Vehicle plate number of the courier/delivery truck\n","type":"string"},"requires_collection":{"title":"Whether this inbound requires collection from a pickup location\n","type":"boolean"},"services":{"allOf":[{"$ref":"#/components/schemas/types.InboundServices"}],"title":"Added-value services requested for this inbound\n"},"slot_end_at":{"format":"date-time","title":"Scheduled end time for the delivery slot\n","type":"string"},"slot_start_at":{"format":"date-time","title":"Scheduled start time for the delivery slot\n","type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/types.InboundStatus"}],"title":"Current status of the inbound booking\n"},"tracking_url":{"title":"Courier tracking URL for the incoming shipment\n","type":"string"},"transport_mode":{"title":"Mode of transport bringing the goods in: \"van\", \"truck\" or \"container\"\n","type":"string"},"type":{"title":"Type of inbound: \"inbound\", \"client_return\", or \"facility_return\"\n","type":"string"},"updated_at":{"format":"date-time","title":"When the inbound was last updated\n","type":"string"},"volume_cbm":{"title":"Total shipment volume in cubic metres\n","type":"number"},"warehouse_code":{"title":"Target warehouse code\n","type":"string"}},"required":["id","type","status","warehouse_code","created_at","updated_at"],"title":"Inbound represents a single inbound delivery\n","type":"object"}},"components/schemas/types.InboundDocument":{"id":"components/schemas/types.InboundDocument","kind":"json-schema","title":"InboundDocument represents a document related to the delivery\n","data":{"properties":{"content_base64":{"description":"Optional: Provide this to upload the file content directly\n","title":"Base64-encoded file content for direct upload\n","type":"string"},"document_type":{"description":"Required: Type of document being uploaded\n","title":"Type of document\n","type":"string"},"file_name":{"description":"Required: Original filename\n","title":"Name of the file\n","type":"string"},"file_size":{"description":"Optional: File size for validation\n","format":"int64","title":"Size of the file in bytes\n","type":"integer"},"file_url":{"description":"Required: Accessible URL to the document\n","title":"URL where the document is stored\n","type":"string"},"mime_type":{"description":"Optional: MIME type for proper handling\n","title":"MIME type of the file\n","type":"string"}},"required":["document_type","file_name","file_url"],"title":"InboundDocument represents a document related to the delivery\n","type":"object"}},"components/schemas/types.InboundItem":{"id":"components/schemas/types.InboundItem","kind":"json-schema","title":"InboundItem represents an item being delivered\n","data":{"properties":{"batch_number":{"description":"Optional: For tracking specific batches\n","title":"Batch number for the item\n","type":"string"},"expiry_date":{"description":"Optional: For perishable items\n","format":"date-time","title":"Expiry date of the item\n","type":"string"},"manufacturing_date":{"description":"Optional: For tracking item age\n","format":"date-time","title":"Manufacturing date of the item\n","type":"string"},"original_order_ids":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required (non-empty) when inbound type is \"client_return\" or \"facility_return\""},"children":[]}]}]}],"items":{"type":"string"},"title":"Original order IDs this item was returned from\n","type":"array"},"quantity":{"description":"Required: Must be greater than 0\n","format":"int64","title":"Quantity of the item being delivered\n","type":"integer"},"sku":{"description":"Required: Must be a valid SKU\n","title":"Stock Keeping Unit of the item\n","type":"string"},"unit_price":{"description":"Required: For cost tracking purposes\n","title":"Unit price of the item\n","type":"number"},"uom":{"description":"Optional: Standard unit like \"kg\", \"pieces\", etc.\n","title":"Unit of measurement for the item\n","type":"string"},"uom_units":{"description":"Optional: How many units make up the UOM\n","format":"int64","title":"Number of units in the UOM\n","type":"integer"}},"required":["sku","quantity","unit_price"],"title":"InboundItem represents an item being delivered\n","type":"object"}},"components/schemas/types.InboundItemResponse":{"id":"components/schemas/types.InboundItemResponse","kind":"json-schema","title":"InboundItemResponse represents an item in an inbound delivery response\n","data":{"properties":{"batch_number":{"title":"Batch number for the item\n","type":"string"},"created_at":{"format":"date-time","title":"When the item record was created\n","type":"string"},"expiry_date":{"title":"Expiry date of the item\n","type":"string"},"id":{"title":"Unique identifier for the item\n","type":"string"},"manufacturing_date":{"title":"Manufacturing date of the item\n","type":"string"},"original_order_ids":{"items":{"type":"string"},"title":"Original order IDs this item was returned from (only for client_return or\nfacility_return type)\n","type":"array"},"quantity":{"format":"int64","title":"Expected quantity\n","type":"integer"},"quarantine_quantity":{"format":"int64","title":"Quantity in quarantine for further inspection\n","type":"integer"},"received_qty":{"format":"int64","title":"Actual received quantity\n","type":"integer"},"sku":{"title":"Stock Keeping Unit of the item\n","type":"string"},"unit_price":{"title":"Unit price of the item\n","type":"string"},"unusable_quantity":{"format":"int64","title":"Unusable quantity (damaged, defective, etc.)\n","type":"integer"},"uom":{"title":"Unit of measurement (e.g., \"kg\", \"pieces\")\n","type":"string"},"uom_units":{"format":"int64","title":"Number of units in the UOM\n","type":"integer"},"updated_at":{"format":"date-time","title":"When the item record was last updated\n","type":"string"},"usable_quantity":{"format":"int64","title":"Usable quantity after quality control\n","type":"integer"}},"required":["sku","quantity"],"title":"InboundItemResponse represents an item in an inbound delivery response\n","type":"object"}},"components/schemas/types.InboundServices":{"id":"components/schemas/types.InboundServices","kind":"json-schema","title":"InboundServices represents the added-value services requested for an inbound\n","data":{"properties":{"barcode_printing":{"title":"Whether barcode printing was requested\n","type":"boolean"},"customs_clearance":{"title":"Whether customs clearance was requested\n","type":"boolean"},"lab_testing":{"title":"Whether lab testing was requested\n","type":"boolean"},"stickering":{"title":"Whether stickering was requested\n","type":"boolean"}},"title":"InboundServices represents the added-value services requested for an inbound\n","type":"object"}},"components/schemas/types.InboundState":{"id":"components/schemas/types.InboundState","kind":"json-schema","title":"InboundState represents the current state of inbound inventory\n","data":{"title":"InboundState represents the current state of inbound inventory\n","type":"string"}},"components/schemas/types.InboundStateHistory":{"id":"components/schemas/types.InboundStateHistory","kind":"json-schema","title":"InboundStateHistory represents a historical record of inbound state changes\n","data":{"properties":{"changed_by":{"title":"Who or what triggered the change\n","type":"string"},"created_at":{"format":"date-time","title":"When the state change occurred\n","type":"string"},"id":{"title":"Unique identifier for the history record\n","type":"string"},"inbound_id":{"title":"Inbound ID this history record belongs to\n","type":"string"},"new_status":{"allOf":[{"$ref":"#/components/schemas/types.InboundStatus"}],"title":"New status after the change\n"},"old_status":{"allOf":[{"$ref":"#/components/schemas/types.InboundStatus"}],"title":"Previous status before the change\n"},"reason":{"title":"Reason for the state change\n","type":"string"},"source":{"title":"Source of the state change (e.g., \"webhook\", \"pull\", \"manual\")\n","type":"string"},"wms_status":{"title":"WMS status from the warehouse management system\n","type":"string"}},"required":["id","inbound_id","old_status","new_status","created_at"],"title":"InboundStateHistory represents a historical record of inbound state changes\n","type":"object"}},"components/schemas/types.InboundStatus":{"id":"components/schemas/types.InboundStatus","kind":"json-schema","title":"InboundStatus represents the status of an inbound booking\n","data":{"title":"InboundStatus represents the status of an inbound booking\n","type":"string"}},"components/schemas/types.InventoryBatchResponse":{"id":"components/schemas/types.InventoryBatchResponse","kind":"json-schema","title":"InventoryBatchResponse represents a single inventory batch.\n","data":{"properties":{"available":{"format":"int64","title":"Available quantity in this batch\n","type":"integer"},"batch_number":{"title":"Batch number / lot number\n","type":"string"},"created_at":{"format":"date-time","title":"When the batch record was created\n","type":"string"},"expiry_date":{"title":"Expiry date of the batch (YYYY-MM-DD)\n","type":"string"},"id":{"title":"Unique identifier for the batch\n","type":"string"},"manufacturing_date":{"title":"Manufacturing date of the batch (YYYY-MM-DD)\n","type":"string"},"unusable":{"format":"int64","title":"Unusable quantity in this batch\n","type":"integer"},"updated_at":{"format":"date-time","title":"When the batch record was last updated\n","type":"string"}},"required":["id","batch_number","available","unusable","created_at","updated_at"],"title":"InventoryBatchResponse represents a single inventory batch.\n","type":"object"}},"components/schemas/types.InventoryItem":{"id":"components/schemas/types.InventoryItem","kind":"json-schema","title":"InventoryItem represents an inventory item with detailed information.\n","data":{"properties":{"available":{"format":"int64","title":"Current available quantity\n","type":"integer"},"cost":{"title":"Cost of the inventory item\n","type":"string"},"created_at":{"format":"date-time","title":"Timestamp when the record was created\n","type":"string"},"damaged":{"format":"int64","title":"Quantity of damaged items\n","type":"integer"},"expiry_groups":{"items":{"$ref":"#/components/schemas/types.ExpiryGroup"},"title":"Groups of inventory by expiry date\n","type":"array"},"inbound_state":{"allOf":[{"$ref":"#/components/schemas/types.InboundState"}],"title":"Current inbound state\n"},"product":{"allOf":[{"$ref":"#/components/schemas/types.Product"}],"title":"Detailed product information\n"},"product_id":{"title":"Reference to the associated product\n","type":"string"},"qc_hold":{"format":"int64","title":"Quantity of items on QC hold\n","type":"integer"},"reserved":{"format":"int64","title":"Quantity of reserved items (in picking)\n","type":"integer"},"total":{"format":"int64","title":"Total quantity across all buckets (available + damaged + reserved + qc_hold)\n","type":"integer"},"tracked":{"title":"Whether inventory tracking is enabled\n","type":"boolean"},"updated_at":{"format":"date-time","title":"Timestamp when the record was last updated\n","type":"string"},"vendor":{"title":"Vendor or brand name of the product\n","type":"string"}},"title":"InventoryItem represents an inventory item with detailed information.\n","type":"object"}},"components/schemas/types.OrderProduct":{"id":"components/schemas/types.OrderProduct","kind":"json-schema","title":"types.OrderProduct","data":{"properties":{"barcode":{"description":"Optional: If not provided, uses the value from the product catalog\n","title":"Barcode is the product barcode (EAN, UPC, ISBN, etc.)\n","type":"string"},"dangerous_goods":{"description":"Optional: if omitted, inherits the product catalog's classification; set true to mark it dangerous for this order\n","title":"DangerousGoods flags the product as dangerous goods (hazmat)\n","type":"boolean"},"quantity":{"description":"Required: Must be at least 1 Minimum value: 1\n","format":"int64","title":"Quantity specifies the number of units to be delivered\n","type":"integer"},"sku":{"description":"Required: Must be a valid SKU from your product catalog Maximum length: 100 characters\n","title":"SKU (Stock Keeping Unit) uniquely identifies the product\n","type":"string"}},"required":["sku","quantity"],"type":"object"}},"components/schemas/types.OrderProductResponse":{"id":"components/schemas/types.OrderProductResponse","kind":"json-schema","title":"types.OrderProductResponse","data":{"properties":{"barcode":{"title":"Product barcode (EAN, UPC, ISBN, etc.)\n","type":"string"},"country_of_origin":{"title":"ISO2 Country code where the product was manufactured\n","type":"string"},"dangerous_goods":{"title":"DangerousGoods indicates whether the product is classified as dangerous goods\n(hazmat)\n","type":"boolean"},"description":{"title":"Detailed description of the product\n","type":"string"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/types.Dimensions"}],"title":"Physical dimensions of the product\n"},"hs_code":{"title":"Harmonized System Code for customs classification\n","type":"string"},"name":{"title":"Name of the product\n","type":"string"},"quantity":{"format":"int64","title":"Number of units ordered\n","type":"integer"},"selling_price":{"title":"Price at which the product is sold to customers\n","type":"number"},"sku":{"title":"Stock Keeping Unit - unique identifier for the product\n","type":"string"},"weight":{"title":"Weight of a single unit\n","type":"number"},"weight_unit":{"title":"Unit of weight measurement (e.g., kg, g)\n","type":"string"}},"type":"object"}},"components/schemas/types.OrderProductUpdate":{"id":"components/schemas/types.OrderProductUpdate","kind":"json-schema","title":"OrderProductUpdate is used for updating products in existing orders\n","data":{"description":"It includes additional fields that can be overridden during updates\n","properties":{"barcode":{"description":"Optional: If not provided, uses the value from the product catalog\n","title":"Barcode overrides the product barcode (EAN, UPC, ISBN, etc.) for this order\n","type":"string"},"country_of_origin":{"description":"Optional: If not provided, uses the value from the product catalog\n","title":"CountryOfOrigin overrides the product's country of origin for this order\n","type":"string"},"dangerous_goods":{"description":"Optional: if omitted, inherits the product catalog's classification; a catalogued dangerous good is not downgraded\n","title":"DangerousGoods marks the product as dangerous goods (hazmat) for this order\n","type":"boolean"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/types.RequestDimensions"}],"description":"Optional: If not provided, uses the value from the product catalog\n","title":"Dimensions overrides the product's dimensions for this order\n"},"hs_code":{"description":"Optional: If not provided, uses the value from the product catalog\n","title":"HSCode overrides the product's HS code for this order\n","type":"string"},"quantity":{"description":"Required: Must be at least 1 Minimum value: 1\n","format":"int64","title":"Quantity specifies the number of units to be delivered\n","type":"integer"},"selling_price":{"description":"Optional: If not provided, uses the price from the product catalog\n","title":"SellingPrice overrides the product's selling price for this order\n","type":"number"},"sku":{"description":"Required: Must be a valid SKU from your product catalog Maximum length: 100 characters\n","title":"SKU (Stock Keeping Unit) uniquely identifies the product\n","type":"string"},"weight":{"description":"Optional: If not provided, uses the value from the product catalog\n","title":"Weight overrides the product's weight for this order\n","type":"number"},"weight_unit":{"description":"Optional: If not provided, uses the value from the product catalog\n","title":"WeightUnit specifies the unit of measurement for weight\n","type":"string"}},"required":["sku","quantity"],"title":"OrderProductUpdate is used for updating products in existing orders\n","type":"object"}},"components/schemas/types.OrderReference":{"id":"components/schemas/types.OrderReference","kind":"json-schema","title":"OrderReference is a flexible label/value pair for attaching your own external\n","data":{"description":"identifiers to an order (e.g. a marketplace order id). These are stored against the order and can be used to look it up later.\n","properties":{"is_unique":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"same label+value. A duplicate is rejected at creation time. Defaults to false."},"children":[]}]}]}],"title":"IsUnique, when true, guarantees no other order on your account can reuse the\n","type":"boolean"},"label":{"title":"Label is the reference key (e.g. \"marketplace_order_id\"). Required.\n","type":"string"},"value":{"title":"Value is the reference value. Required.\n","type":"string"}},"required":["label","value","is_unique"],"title":"OrderReference is a flexible label/value pair for attaching your own external\n","type":"object"}},"components/schemas/types.OrderStatus":{"id":"components/schemas/types.OrderStatus","kind":"json-schema","title":"OrderStatus represents the possible states of an order\n","data":{"enum":["pending","ready_for_collection","picking_started","out_for_collection","out_for_return","at_depot","received_at_depot","in_transit","out_for_delivery","collection_failed","on_hold","scheduled","wms_on_hold","return_to_origin","returned_to_origin","cancelled","collected","delivery_complete","delivery_failed","problematic"],"title":"OrderStatus represents the possible states of an order\n","type":"string"}},"components/schemas/types.ParcelResponse":{"id":"components/schemas/types.ParcelResponse","kind":"json-schema","title":"types.ParcelResponse","data":{"properties":{"dimensions":{"allOf":[{"$ref":"#/components/schemas/types.Dimensions"}],"title":"Physical dimensions of the parcel (length, width, height)\n"},"id":{"title":"Unique identifier for the parcel\n","type":"string"},"name":{"title":"Name or description of the parcel\n","type":"string"},"notes":{"title":"Additional notes or handling instructions for the parcel\n","type":"string"},"parcel_barcode":{"title":"Unique barcode assigned to the parcel for tracking\n","type":"string"},"quantity":{"format":"int64","title":"Number of items in the parcel\n","type":"integer"},"weight":{"title":"Weight of the parcel in kilograms\n","type":"number"}},"type":"object"}},"components/schemas/types.PaymentMode":{"id":"components/schemas/types.PaymentMode","kind":"json-schema","title":"types.PaymentMode","data":{"enum":["pre_paid","paid_on_delivery"],"type":"string"}},"components/schemas/types.PickupAddress":{"id":"components/schemas/types.PickupAddress","kind":"json-schema","title":"PickupAddress represents the pickup location for collection\n","data":{"properties":{"address1":{"description":"Required: Full street address\n","title":"Primary street address\n","type":"string"},"address2":{"description":"Optional: Building, floor, suite, etc.\n","title":"Secondary address details\n","type":"string"},"city":{"description":"Required: City where pickup is located\n","title":"City name\n","type":"string"},"coordinate":{"allOf":[{"$ref":"#/components/schemas/types.Coordinate"}],"description":"Optional: Latitude and longitude\n","title":"Geographic coordinates\n"},"country":{"description":"Required: Full country name\n","title":"Country name\n","type":"string"},"country_code":{"description":"Required: Two-letter country code\n","title":"ISO2 country code\n","type":"string"},"landmark":{"description":"Optional: Nearby landmark for easier identification\n","title":"Landmark near the pickup location\n","type":"string"},"name":{"description":"Required: Business name or location identifier\n","title":"Name of the pickup location\n","type":"string"},"postcode":{"description":"Optional: ZIP or postal code\n","title":"Postal code\n","type":"string"},"state":{"description":"Optional: State or province name\n","title":"State or province\n","type":"string"}},"required":["name","address1","city","country","country_code"],"title":"PickupAddress represents the pickup location for collection\n","type":"object"}},"components/schemas/types.PickupContact":{"id":"components/schemas/types.PickupContact","kind":"json-schema","title":"PickupContact represents the contact person for pickup\n","data":{"properties":{"company":{"description":"Optional: Company the contact person works for\n","title":"Company name\n","type":"string"},"email":{"description":"Optional: Email for additional communication\n","title":"Email address of the contact person\n","type":"string"},"instructions":{"description":"Optional: Any special instructions for the pickup\n","title":"Special instructions for pickup\n","type":"string"},"name":{"description":"Required: Name of the person to contact\n","title":"Full name of the contact person\n","type":"string"},"phone":{"description":"Required: Must be in E.164 format\n","title":"Phone number of the contact person\n","type":"string"}},"required":["name","phone"],"title":"PickupContact represents the contact person for pickup\n","type":"object"}},"components/schemas/types.Product":{"id":"components/schemas/types.Product","kind":"json-schema","title":"types.Product","data":{"properties":{"availability_status":{"format":"int64","title":"Current total available quantity of the product\n","type":"integer"},"barcode":{"title":"Product barcode (EAN, UPC, ISBN, etc.)\n","type":"string"},"batch_management":{"title":"Whether batch management is enabled for this product\n","type":"boolean"},"cost_price":{"title":"Cost price of the product\n","type":"number"},"country_code_of_origin":{"title":"ISO2 Country code of origin (required).\n","type":"string"},"created_at":{"format":"date-time","title":"Creation timestamp\n","type":"string"},"currency":{"allOf":[{"$ref":"#/components/schemas/types.Currency"}],"title":"Currency of the product\n"},"description":{"title":"Description of the product\n","type":"string"},"dimensions":{"allOf":[{"$ref":"#/components/schemas/datatypes.JSONType_data.Dimensions"}],"title":"Product dimensions\n"},"expiry_management":{"title":"Whether expiry management is enabled for this product\n","type":"boolean"},"harmonized_system_code":{"title":"Harmonized System Code (HS Code)\n","type":"string"},"id":{"title":"Unique identifier for the product\n","type":"string"},"image":{"title":"Images of the product\n","type":"string"},"inbound_expiry_threshold_days":{"format":"int64","title":"Minimum days of shelf life required when receiving inbound stock\n","type":"integer"},"inventory_tracked":{"title":"If false means inventory can not be tracked/updated\n","type":"boolean"},"name":{"title":"Name of the product\n","type":"string"},"outbound_expiry_threshold_days":{"format":"int64","title":"Minimum days of shelf life required when picking outbound stock\n","type":"integer"},"partner_product_id":{"title":"Partner's unique identifier for the product\n","type":"string"},"platform_price":{"title":"Platform price for international orders (overrides sales channel price when\nenabled)\n","type":"number"},"requires_shipping":{"title":"Indicates whether the product requires shipping services (virtual products do\nnot require shipping)\n","type":"boolean"},"retail_price":{"title":"Retail price of the product\n","type":"number"},"selling_price":{"title":"Selling price of the product\n","type":"number"},"sku":{"title":"Stock Keeping Unit\n","type":"string"},"status":{"allOf":[{"$ref":"#/components/schemas/types.ProductStatus"}],"title":"Product availability status\n"},"total_sales":{"title":"Total lifetime sales quantity of this product\n","type":"number"},"track_expiry":{"title":"Track expiry of the product, default to false\n","type":"boolean"},"type":{"title":"Category of the product\n","type":"string"},"updated_at":{"format":"date-time","title":"Last update timestamp\n","type":"string"},"vendor":{"title":"Vendor or brand name\n","type":"string"},"weight":{"title":"Weight of a single unit of the product\n","type":"number"},"weight_unit":{"title":"Unit of weight measurement (kg or g)\n","type":"string"}},"type":"object"}},"components/schemas/types.ProductStatus":{"id":"components/schemas/types.ProductStatus","kind":"json-schema","title":"Product API types\n","data":{"enum":["active","archived","draft"],"title":"Product API types\n","type":"string"}},"components/schemas/types.RegistrationNumber":{"id":"components/schemas/types.RegistrationNumber","kind":"json-schema","title":"RegistrationNumber represents a customs/VAT registration number\n","data":{"properties":{"issuer_country_code":{"title":"IssuerCountryCode is the ISO 3166-1 alpha-2 country code, defaults to \"AE\"\n","type":"string"},"type_code":{"title":"TypeCode is the type of registration (e.g., MIRSAL2)\n","type":"string"},"value":{"title":"Value is the registration number value\n","type":"string"}},"required":["type_code","value","issuer_country_code"],"title":"RegistrationNumber represents a customs/VAT registration number\n","type":"object"}},"components/schemas/types.RequestDimensions":{"id":"components/schemas/types.RequestDimensions","kind":"json-schema","title":"types.RequestDimensions","data":{"properties":{"height":{"title":"Height of the product in specified unit\n","type":"number"},"length":{"title":"Length of the product in specified unit\n","type":"number"},"unit":{"title":"Unit of measurement for dimensions (cm or m)\n","type":"string"},"width":{"title":"Width of the product in specified unit\n","type":"number"}},"required":["length","width","height","unit"],"type":"object"}},"components/schemas/types.ServiceKind":{"id":"components/schemas/types.ServiceKind","kind":"json-schema","title":"ServiceKind represents the type of delivery service\n","data":{"enum":["partner_next_day","partner_same_day","partner_4hr","partner_export","partner_store","partner_return"],"title":"ServiceKind represents the type of delivery service\n","type":"string"}},"schema_33":{"kind":"json-schema","data":{"type":"string"},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"properties":{"batch":{"$ref":"#/components/schemas/types.InventoryBatchResponse"}},"required":["batch"],"type":"object"},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"externalDocs":{"url":"https://pkg.go.dev/encore.dev/beta/errs#Error"},"properties":{"code":{"description":"Error code","example":"not_found","externalDocs":{"url":"https://pkg.go.dev/encore.dev/beta/errs#ErrCode"},"type":"string"},"details":{"description":"Error details","type":"object"},"message":{"description":"Error message","type":"string"}},"title":"APIError","type":"object"},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"format":"int64","type":"integer"},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"properties":{"inventory":{"items":{"$ref":"#/components/schemas/types.InventoryItem"},"title":"Array of inventory items\n","type":"array"},"pagination":{"$ref":"#/components/schemas/pagination.PaginationMeta"}},"required":["inventory","pagination"],"type":"object"},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"properties":{"bucket":{"title":"Bucket to adjust: available, damaged, reserved, qc_hold\n","type":"string"},"notes":{"title":"Optional notes about the adjustment\n","type":"string"},"quantity_change":{"format":"int64","title":"Quantity change (positive to add, negative to remove)\n","type":"integer"},"reason":{"title":"Reason for adjustment: damage, correction, write_off, qc_fail, other\n","type":"string"},"sku":{"title":"SKU of the product to adjust\n","type":"string"}},"required":["sku","bucket","quantity_change","reason"],"type":"object"},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"properties":{"available":{"format":"int64","type":"integer"},"damaged":{"format":"int64","type":"integer"},"qc_hold":{"format":"int64","type":"integer"},"reserved":{"format":"int64","type":"integer"},"sku":{"title":"The updated inventory item\n","type":"string"},"total":{"format":"int64","type":"integer"}},"required":["sku","available","damaged","reserved","qc_hold","total"],"type":"object"},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"properties":{"available":{"format":"int64","title":"Current available quantity in stock\n","type":"integer"},"cost":{"title":"Cost of the inventory item\n","type":"string"},"created_at":{"format":"date-time","title":"Timestamp when the inventory record was created\n","type":"string"},"damaged":{"format":"int64","title":"Quantity of damaged items\n","type":"integer"},"expiry_groups":{"items":{"$ref":"#/components/schemas/types.ExpiryGroup"},"title":"Groups of inventory by expiry date\n","type":"array"},"inbound_state":{"$ref":"#/components/schemas/types.InboundState"},"product":{"$ref":"#/components/schemas/types.Product"},"product_id":{"title":"Reference to the associated product\n","type":"string"},"qc_hold":{"format":"int64","title":"Quantity of items on QC hold\n","type":"integer"},"reserved":{"format":"int64","title":"Quantity of reserved items (in picking)\n","type":"integer"},"total":{"format":"int64","title":"Total quantity across all buckets (available + damaged + reserved + qc_hold)\n","type":"integer"},"tracked":{"title":"Whether inventory tracking is enabled for this item\n","type":"boolean"},"updated_at":{"format":"date-time","title":"Timestamp when the inventory record was last updated\n","type":"string"},"vendor":{"title":"Vendor or brand name of the product\n","type":"string"}},"type":"object"},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"properties":{"batches":{"items":{"$ref":"#/components/schemas/types.InventoryBatchResponse"},"title":"Array of inventory batches\n","type":"array"}},"required":["batches"],"type":"object"},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"properties":{"attendees":{"description":"Optional: Required when slot times are provided. At least one attendee must be specified.\n","items":{"type":"string"},"title":"List of attendees who will be present for the delivery\n","type":"array"},"courier_contact":{"description":"Optional: For coordination during delivery\n","title":"Contact number of the courier or driver\n","type":"string"},"courier_name":{"description":"Optional: For gate pass and identification purposes\n","title":"Name of the courier or driver making the delivery\n","type":"string"},"documents":{"description":"Optional: Supporting documents like invoices, manifests, etc.\n","items":{"$ref":"#/components/schemas/types.InboundDocument"},"title":"List of documents related to the delivery\n","type":"array"},"items":{"description":"Required: At least one item must be specified\n","items":{"$ref":"#/components/schemas/types.InboundItem"},"title":"List of items being delivered\n","type":"array"},"partner_inbound_id":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Strongly recommended for unscheduled (PENDING) inbounds — without it, each retry or double-submit creates a separate inbound with its own ASN sequence. For scheduled inbounds, duplicates are prevented by the slot time combination."},"children":[]}]}]}],"title":"Client-provided reference ID for the inbound delivery.\n","type":"string"},"pickup_address":{"$ref":"#/components/schemas/types.PickupAddress"},"pickup_contact":{"$ref":"#/components/schemas/types.PickupContact"},"plate_number":{"description":"Optional: For gate pass and security purposes\n","title":"Vehicle plate number of the courier/delivery truck\n","type":"string"},"slot_end_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: When provided, must be after slot_start_at. Required when slot_start_at is provided."},"children":[]}]}]}],"format":"date-time","title":"End time of the delivery slot\n","type":"string"},"slot_start_at":{"description":"Optional: When provided, must be a valid future timestamp. If omitted, the inbound is created as PENDING.\n","format":"date-time","title":"Start time of the delivery slot\n","type":"string"},"type":{"description":"Optional: Defaults to \"inbound\" if not specified\n","title":"Type of inbound: \"inbound\" (default), \"client_return\", or \"facility_return\"\n","type":"string"}},"required":["items"],"type":"object"},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"properties":{"already_existed":{"description":"Optional: True when returning an existing inbound instead of creating a new one\n","title":"Indicates if an inbound with the same unique fields (client_id, warehouse_code,\ntime slots) already existed\n","type":"boolean"},"asn_id":{"description":"Optional: Generated ASN ID for warehouse systems\n","title":"ASN (Advance Shipment Notice) ID\n","type":"string"},"inbound_id":{"description":"Generated by the system\n","title":"Unique identifier for the inbound booking\n","type":"string"},"status":{"$ref":"#/components/schemas/types.InboundStatus"}},"required":["inbound_id","status"],"type":"object"},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"properties":{"inbound":{"$ref":"#/components/schemas/types.Inbound"}},"required":["inbound"],"type":"object"},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"properties":{"history":{"items":{"$ref":"#/components/schemas/types.InboundStateHistory"},"title":"List of state history records for the inbound\n","type":"array"}},"required":["history"],"type":"object"},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"items":{"type":"string"},"type":"array"},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"properties":{"inbounds":{"items":{"$ref":"#/components/schemas/types.Inbound"},"title":"List of inbound deliveries for the user\n","type":"array"},"pagination":{"$ref":"#/components/schemas/pagination.PaginationMeta"}},"required":["inbounds","pagination"],"type":"object"},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"properties":{"attendees":{"description":"Optional: Required when slot times are provided for scheduling\n","items":{"type":"string"},"title":"List of attendees who will be present for the delivery\n","type":"array"},"courier_contact":{"description":"Optional: For coordination during delivery\n","title":"Contact number of the courier or driver\n","type":"string"},"courier_name":{"description":"Optional: For gate pass and identification purposes\n","title":"Name of the courier or driver making the delivery\n","type":"string"},"documents":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: Supporting documents like emirates_id, vehicle_registration, gate_pass, etc."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/types.InboundDocument"},"title":"List of documents to attach to the inbound delivery\n","type":"array"},"plate_number":{"description":"Optional: For gate pass and security purposes\n","title":"Vehicle plate number of the courier/delivery truck\n","type":"string"},"slot_end_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: When provided with slot_start_at, schedules a PENDING inbound to BOOKED"},"children":[]}]}]}],"format":"date-time","title":"End time of the delivery slot\n","type":"string"},"slot_start_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: When provided with slot_end_at, schedules a PENDING inbound to BOOKED"},"children":[]}]}]}],"format":"date-time","title":"Start time of the delivery slot\n","type":"string"}},"type":"object"},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"properties":{"asn_id":{"title":"ASN (Advance Shipment Notice) ID\n","type":"string"},"inbound_id":{"title":"Unique identifier for the inbound booking\n","type":"string"},"status":{"$ref":"#/components/schemas/types.InboundStatus"}},"required":["inbound_id","status"],"type":"object"},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"properties":{"reason":{"description":"Optional: Helpful for audit trail\n","title":"Reason for cancelling the inbound\n","type":"string"}},"type":"object"},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"properties":{"message":{"title":"Confirmation message\n","type":"string"}},"required":["message"],"type":"object"},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"properties":{"items":{"items":{"$ref":"#/components/schemas/types.InboundItemResponse"},"title":"Array of inbound items\n","type":"array"}},"required":["items"],"type":"object"},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"properties":{"attendees":{"description":"Optional: If provided, attendees will be associated with the inbound\n","items":{"type":"string"},"title":"List of attendees who will be present for the delivery\n","type":"array"},"slot_end_at":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required: Must be after slot_start_at"},"children":[]}]}]}],"format":"date-time","title":"End time of the delivery slot\n","type":"string"},"slot_start_at":{"description":"Required: Must be a valid future timestamp\n","format":"date-time","title":"Start time of the delivery slot\n","type":"string"}},"required":["slot_start_at","slot_end_at","attendees"],"type":"object"},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"format":"date-time","type":"string"},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"properties":{"slots":{"items":{"$ref":"#/components/schemas/types.AvailableSlot"},"type":"array"}},"required":["slots"],"type":"object"},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"properties":{"billing_address":{"$ref":"#/components/schemas/types.AddressRequest"},"billing_identifier":{"description":"Optional: Used for internal billing reference\n","title":"BillingIdentifier is a custom identifier for billing purposes\n","type":"string"},"carrier":{"description":"Optional: Used to specify which carrier should handle the delivery\n","title":"Carrier specifies the delivery carrier for the order\n","type":"string"},"currency":{"title":"Currency is the 3-letter ISO currency code for the order (e.g., AED)\n","type":"string"},"delivery_options":{"description":"Optional: Array of special delivery requirements\n","items":{"$ref":"#/components/schemas/types.DeliveryOption"},"title":"DeliveryOptions specifies special delivery instructions\n","type":"array"},"incoterm":{"description":"Optional: Used for international shipments to define delivery terms\n","title":"Incoterm specifies the international commercial terms for the order\n","type":"string"},"initial_order_id":{"description":"Optional: When provided for return orders, the original order will be validated\n","title":"InitialOrderID references the original order for return deliveries\n","type":"string"},"is_return":{"description":"Optional: Set to true for return deliveries\n","title":"IsReturn indicates if this is a return order\n","type":"boolean"},"mark_as_ready_for_collection":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional: Only applicable for return orders (is_return=true). When set to true, the order will be created with \"ready_for_collection\" status instead of \"pending\""},"children":[]}]}]}],"title":"MarkAsReadyForCollection indicates if the order should be automatically marked\nas ready for collection\n","type":"boolean"},"notes":{"description":"Optional: Maximum 255 characters\n","title":"Notes contains any additional delivery instructions\n","type":"string"},"origin_address":{"$ref":"#/components/schemas/types.AddressRequest"},"partner_order_id":{"description":"Required: Must be unique across all orders\n","title":"PartnerOrderID is your unique reference for the order\n","type":"string"},"payment_amount":{"title":"PaymentAmount is the total amount to be collected from the customer\n","type":"number"},"payment_mode":{"$ref":"#/components/schemas/types.PaymentMode"},"products":{"items":{"$ref":"#/components/schemas/types.OrderProduct"},"title":"Products is an array of products to be delivered\n","type":"array"},"references":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"order, e.g. a marketplace order id. Set is_unique=true on a reference to prevent another order on your account from reusing the same label+value. Optional."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/types.OrderReference"},"title":"References lets you attach your own external identifiers (label/value pairs) to\nthe\n","type":"array"},"registration_numbers":{"description":"Optional: Used for customs clearance in international shipments\n","items":{"$ref":"#/components/schemas/types.RegistrationNumber"},"title":"RegistrationNumbers contains customs/VAT registration numbers (e.g., Mirsal 2\nVAT code)\n","type":"array"},"service_kind":{"$ref":"#/components/schemas/types.ServiceKind"},"shipping_address":{"$ref":"#/components/schemas/types.AddressRequest"}},"required":["service_kind","currency","payment_amount","shipping_address","origin_address","partner_order_id","payment_mode"],"type":"object"},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"properties":{"billing_address":{"$ref":"#/components/schemas/types.CreateFulfilmentOrderAddressResponse"},"carrier":{"title":"Delivery carrier for the order\n","type":"string"},"created_at":{"format":"date-time","title":"Timestamp when the order was created\n","type":"string"},"currency":{"title":"3-letter ISO currency code (e.g., AED, SAR)\n","type":"string"},"delivery_options":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values: leave_at_door, customer_identification_photo"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/types.DeliveryOption"},"title":"Special delivery requirements\n","type":"array"},"errors":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"title":"Array of error messages if any issues occurred\n","type":"array"},"id":{"title":"Unique identifier for the fulfilment order\n","type":"string"},"incoterm":{"title":"International commercial terms for the order\n","type":"string"},"initial_order_id":{"title":"Reference to the original order ID for returns\n","type":"string"},"is_return":{"title":"Indicates if this is a return order\n","type":"boolean"},"notes":{"title":"Additional delivery instructions or comments\n","type":"string"},"origin_address":{"$ref":"#/components/schemas/types.CreateFulfilmentOrderAddressResponse"},"parcels":{"items":{"$ref":"#/components/schemas/types.ParcelResponse"},"title":"List of parcels associated with the order\n","type":"array"},"partner_order_id":{"title":"Your unique reference for the order\n","type":"string"},"payment_amount":{"title":"Total amount to be collected from the customer\n","type":"number"},"payment_mode":{"$ref":"#/components/schemas/types.PaymentMode"},"picking_order_created":{"title":"Indicates if a picking order has been created\n","type":"boolean"},"products":{"items":{"$ref":"#/components/schemas/types.OrderProductResponse"},"title":"List of products included in the order\n","type":"array"},"references":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Echoes back whatever was sent in the create request's `references`."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/types.OrderReference"},"title":"External identifiers attached to the order at creation (label/value pairs).\n","type":"array"},"service_kind":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Possible values: partner_next_day, partner_same_day, partner_4hr, partner_export, partner_store"},"children":[]}]}]}],"title":"Type of delivery service requested\n","type":"string"},"shipping_address":{"$ref":"#/components/schemas/types.CreateFulfilmentOrderAddressResponse"},"status":{"$ref":"#/components/schemas/types.OrderStatus"},"status_reason":{"title":"Reason for the current status (e.g., why an order was cancelled)\n","type":"string"},"tracking_url":{"title":"URL for basic order tracking\n","type":"string"},"tracking_url_advance":{"title":"URL for advanced order tracking with more details\n","type":"string"},"updated_at":{"format":"date-time","title":"Timestamp when the order was last updated\n","type":"string"},"uuid":{"title":"UUID of the fulfilment order\n","type":"string"}},"type":"object"},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"properties":{"billing_address":{"$ref":"#/components/schemas/types.AddressRequest"},"carrier":{"description":"Optional: Used to specify which carrier should handle the delivery\n","title":"Carrier updates the delivery carrier for the order\n","type":"string"},"incoterm":{"description":"Optional: Used for international shipments to define delivery terms\n","title":"Incoterm updates the international commercial terms for the order\n","type":"string"},"origin_address":{"$ref":"#/components/schemas/types.AddressRequest"},"payment_amount":{"title":"PaymentAmount updates the amount to be collected\n","type":"number"},"payment_mode":{"$ref":"#/components/schemas/types.PaymentMode"},"products":{"description":"For updates, products can include additional fields to override catalog values\n","items":{"$ref":"#/components/schemas/types.OrderProductUpdate"},"title":"Products updates the list of products to be delivered\n","type":"array"},"service_kind":{"$ref":"#/components/schemas/types.ServiceKind"},"shipping_address":{"$ref":"#/components/schemas/types.AddressRequest"},"status":{"title":"Status updates the current status of the order\n","type":"string"}},"required":["status","service_kind","products","shipping_address","billing_address","origin_address","payment_amount","payment_mode"],"type":"object"},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"properties":{"availability_status":{"format":"int64","title":"Current availability status of the product (1: available, 0: unavailable)\n","type":"integer"},"barcode":{"title":"Product barcode (EAN, UPC, ISBN, etc.)\n","type":"string"},"batch_management":{"title":"Whether batch management is enabled for this product. Omit to preserve; send\ntrue/false to set.\n","type":"boolean"},"clear_platform_price":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"omitting platform_price alone no longer clears it, because the write layer now preserves the stored value so storefront syncs and re-cache jobs cannot silently wipe it (sc-29021). Sending a platform_price value still sets it; this flag only matters when no value is sent."},"children":[]}]}]}],"title":"ClearPlatformPrice, when true, removes an existing platform price. Send this to\nunset it:\n","type":"boolean"},"cost_price":{"title":"Cost of acquiring/manufacturing the product\n","type":"number"},"country_code_of_origin":{"title":"ISO2 Country code where product was manufactured\n","type":"string"},"currency":{"$ref":"#/components/schemas/types.Currency"},"description":{"title":"Detailed description of the product\n","type":"string"},"dimensions":{"$ref":"#/components/schemas/types.RequestDimensions"},"expiry_management":{"title":"Whether expiry management is enabled for this product. Omit to preserve;\nsend true/false to set.\n","type":"boolean"},"harmonized_system_code":{"title":"Harmonized System Code for customs\n","type":"string"},"image":{"title":"URL of the product image\n","type":"string"},"inbound_expiry_threshold_days":{"format":"int64","title":"Minimum days of shelf life required when receiving inbound stock\n","type":"integer"},"inventory_tracked":{"title":"Whether inventory levels are tracked\n","type":"boolean"},"name":{"title":"Name of the product\n","type":"string"},"outbound_expiry_threshold_days":{"format":"int64","title":"Minimum days of shelf life required when picking outbound stock\n","type":"integer"},"partner_product_id":{"title":"Partner's unique identifier for the product\n","type":"string"},"platform_price":{"title":"Platform price for international orders (overrides sales channel price when\nenabled)\n","type":"number"},"requires_shipping":{"title":"Indicates whether the product requires shipping services\n","type":"boolean"},"retail_price":{"title":"Recommended retail price\n","type":"number"},"selling_price":{"title":"Price at which the product is sold to customers\n","type":"number"},"sku":{"title":"Unique Stock Keeping Unit identifier\n","type":"string"},"status":{"$ref":"#/components/schemas/types.ProductStatus"},"total_sales":{"title":"Total lifetime sales quantity of this product\n","type":"number"},"track_expiry":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"stored value rather than resetting it to false — send true/false to change it (sc-29021)."},"children":[]}]}]}],"title":"Whether to track expiry dates for this product. Pointer so that omitting it\npreserves the\n","type":"boolean"},"type":{"title":"Type of product (e.g. physical, digital)\n","type":"string"},"vendor":{"title":"Name of the product vendor/manufacturer\n","type":"string"},"weight":{"title":"Weight of a single unit of the product\n","type":"number"},"weight_unit":{"title":"Unit of weight measurement (kg or g)\n","type":"string"}},"required":["selling_price","currency","sku","availability_status"],"type":"object"},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"properties":{"availability_status":{"format":"int64","title":"Current total available quantity of the product\n","type":"integer"},"barcode":{"title":"Product barcode (EAN, UPC, ISBN, etc.)\n","type":"string"},"batch_management":{"title":"Whether batch management is enabled for this product\n","type":"boolean"},"cost_price":{"title":"Cost price of the product\n","type":"number"},"country_code_of_origin":{"title":"ISO2 Country code of origin (required).\n","type":"string"},"created_at":{"format":"date-time","title":"Creation timestamp\n","type":"string"},"currency":{"$ref":"#/components/schemas/types.Currency"},"description":{"title":"Description of the product\n","type":"string"},"dimensions":{"$ref":"#/components/schemas/datatypes.JSONType_data.Dimensions"},"expiry_management":{"title":"Whether expiry management is enabled for this product\n","type":"boolean"},"harmonized_system_code":{"title":"Harmonized System Code (HS Code)\n","type":"string"},"id":{"title":"Unique identifier for the product\n","type":"string"},"image":{"title":"Images of the product\n","type":"string"},"inbound_expiry_threshold_days":{"format":"int64","title":"Minimum days of shelf life required when receiving inbound stock\n","type":"integer"},"inventory_tracked":{"title":"If false means inventory can not be tracked/updated\n","type":"boolean"},"name":{"title":"Name of the product\n","type":"string"},"outbound_expiry_threshold_days":{"format":"int64","title":"Minimum days of shelf life required when picking outbound stock\n","type":"integer"},"partner_product_id":{"title":"Partner's unique identifier for the product\n","type":"string"},"platform_price":{"title":"Platform price for international orders (overrides sales channel price when\nenabled)\n","type":"number"},"requires_shipping":{"title":"Indicates whether the product requires shipping services (virtual products do\nnot require shipping)\n","type":"boolean"},"retail_price":{"title":"Retail price of the product\n","type":"number"},"selling_price":{"title":"Selling price of the product\n","type":"number"},"sku":{"title":"Stock Keeping Unit\n","type":"string"},"status":{"$ref":"#/components/schemas/types.ProductStatus"},"total_sales":{"title":"Total lifetime sales quantity of this product\n","type":"number"},"track_expiry":{"title":"Track expiry of the product, default to false\n","type":"boolean"},"type":{"title":"Category of the product\n","type":"string"},"updated_at":{"format":"date-time","title":"Last update timestamp\n","type":"string"},"vendor":{"title":"Vendor or brand name\n","type":"string"},"weight":{"title":"Weight of a single unit of the product\n","type":"number"},"weight_unit":{"title":"Unit of weight measurement (kg or g)\n","type":"string"}},"type":"object"},"id":"schema_61"}},"exampleStore":{},"securitySchemeStore":{"OAuth2":{"id":"OAuth2","type":"oauth2","flows":{"clientCredentials":{"scopes":{"public":"Public API access"},"tokenUrl":"https://platform-api.quiqup.com/oauth/token"}}}},"servers":[{"url":"/_mock/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://platform-api.quiqup.com","description":"Production"},{"url":"https://platform-api.staging.quiqup.com","description":"Staging"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/openapi.json?download"},{"url":"/_bundle/openapi.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Fulfilment API","description":"This is the API documentation for the Fulfilment API."}},"baseSlug":"/openapi","routesMapping":{}}