Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.
Specify additional fields of the DeliveryException objects nested under items to be included in the response. See the selecting fields page for more information.
Specify additional fields of the DeliveryItemLot objects nested under items to be included in the response. See the selecting fields page for more information.
Specify additional fields of the DeliveryItemLocation objects nested under items to be included in the response. See the selecting fields page for more information.
Lists of referenced objects included by specifying optional fields.
See the selecting fields page for more information.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"ShipStream Developer Center","colors":{"primary":"#2a81c4","light":"#2a81c4","dark":"#2a81c4"},"logo":{"light":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=a0df5ad1d65033e45435fe663a71e67e","dark":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/dark.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=b83b5ebc8570308bd06c53fdc32eb950","href":"https://shipstream.io"},"favicon":{"light":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/favicon-light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=85c67af04fff1dac7f40844baf8c28d6","dark":"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/favicon-dark.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=72f5d317204ffe6e66245125e71f9831"},"appearance":{"default":"light"},"navbar":{"links":[{"href":"mailto:help@shipstream.io","label":"Support"}],"primary":{"type":"button","label":"Get Started","href":"https://shipstream.io"}},"footer":{"socials":{"github":"https://github.com/shipstream","linkedin":"https://linkedin.com/company/shipstream-llc"}},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://help.shipstream.io"},{"anchor":"Release Notes","icon":"newspaper","href":"https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview"},{"anchor":"Warehouse Designer","icon":"compass","href":"https://flow.shipstream.io"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"shipstream","hasAudioNarration":false,"actualSubdomain":"shipstream","customDomains":["docs.shipstream.io"],"gitSource":{"type":"github","owner":"colinmollenhour","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6acebedfad8927365d8e6b61","collectionId":"239e8646-2b14-4b40-9c87-6d42a5b1848a","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6acebedfad8927365d8e6b61"},"feedback":{"thumbs":true,"edits":false},"entitlements":{},"buildId":"6acebedfad8927365d8e6b61","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"Global API Reference","count":143},{"language":"default","tag":"Inventory API v1","count":86},{"language":"default","tag":"Shipping API v1","count":37},{"language":"default","tag":"Merchant API Reference","count":31},{"language":"default","tag":"Retailers","count":26},{"language":"default","tag":"Slotting Rules","count":12},{"language":"default","tag":"Common Features","count":11},{"language":"default","tag":"Product Profiles","count":10},{"language":"default","tag":"System API v1","count":10},{"language":"default","tag":"Shipping","count":10}]},"assistantConfig":{},"hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"global-api/endpoint/v1/receiving/{type}/{id}/get","slug":"/global-api/endpoint/v1/receiving/{type}/{id}/get","pageMetadata":{"title":"Get one Delivery","openapi":"GET /v1/receiving/{type}/{id}","description":"Returns a single `ASN`, `RMA`, or `Other` object specified by its `type` \u0026 `id` path parameters.","href":"/global-api/endpoint/v1/receiving/{type}/{id}/get"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns a single \", _jsx(_components.code, {\n children: \"ASN\"\n }), \", \", _jsx(_components.code, {\n children: \"RMA\"\n }), \", or \", _jsx(_components.code, {\n children: \"Other\"\n }), \" object specified by its \", _jsx(_components.code, {\n children: \"type\"\n }), \" \u0026 \", _jsx(_components.code, {\n children: \"id\"\n }), \" path parameters.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Get one Delivery","openapi":"GET /v1/receiving/{type}/{id}","description":"Returns a single `ASN`, `RMA`, or `Other` object specified by its `type` \u0026 `id` path parameters.","href":"/global-api/endpoint/v1/receiving/{type}/{id}/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get one Delivery","description":"Returns a single `ASN`, `RMA`, or `Other` object specified by its `type` \u0026 `id` path parameters.","tags":["Deliveries"],"operationId":"getDelivery","parameters":["5391f495-22d7-45c5-94a5-ac75130e6aa4","722b3366-25f2-402f-93cd-033a012b3cc3","d8f562ee-c02a-4d81-8379-2ec2b8372eab","693b0f18-54cb-4ce8-8172-9008944db9a9","7ffe8815-693a-4aad-9247-89738acc9d73","34a21bf0-6722-4dc5-b65c-917233f98a1b","3a9ea240-fe75-470c-905b-8f1c7ab01c74","bcf4d245-d3c7-4439-a311-8df93ea795dc","b2839e9f-b569-47c1-849f-dce229239e33","b758cbfd-9a47-491f-8d2b-3d35ce7dcbcd","12bf0696-28c4-42af-a14e-5fa7ad5e0fd8"],"responses":{"200":"c23f363f-8e7a-47e9-9531-ec303e9ecc80","400":"6b52a24a-c585-48ed-a0ec-b56fdc0f65d0","404":"eee82d95-5a0f-478c-a339-8179a73a7d4d","500":"0bdf9654-2d23-4db9-90b7-cac770b9610a"},"method":"get","type":"path","servers":["c54ede43-9c1a-41e5-bd59-dd40a08d5ddf"],"security":["cdd0ed69-efb4-45cc-8b4d-1bf2ea905a01"],"path":"/v1/receiving/{type}/{id}","baseUrlOptions":["https://{base_url_domain}/api/global"],"title":"Get one Delivery","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5391f495-22d7-45c5-94a5-ac75130e6aa4":{"in":"path","name":"type","required":true,"schema":{"type":"string","enum":["asn","rma","other"],"isRequired":true,"description":"Specify the delivery type to which your operations will be restricted.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Specify the delivery type to which your operations will be restricted."},"722b3366-25f2-402f-93cd-033a012b3cc3":{"name":"fields","in":"query","required":false,"description":"Specify additional fields of the `ASN` OR `RMA` object to be included in the response.\nSee the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Delivery","type":"array","items":{"type":"string","enum":["basic","all","customer_name","carrier_name","authorized_at","delivered_at","receive_by","processed_at","putaway_at","completed_at","ready_to_process_at","merchant_rma_number","merchant_status","carrier_tracking_number","merchant_order_number","item_count","container_count","label_count","exception_count","processing_comments","special_requirements","is_auto_commit","order","created_at","updated_at","supplier_name","expected_at","merchant_reference","supplier_invoice_reference","supplier_order_reference","shipment_type","bill_of_lading","tracking_numbers","standard_carrier_alpha_code","status_history","items"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `ASN` OR `RMA` object to be included in the response.\nSee the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"d8f562ee-c02a-4d81-8379-2ec2b8372eab":{"name":"fields:merchant","in":"query","required":false,"description":"Specify additional fields of the `Merchant` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Merchant","type":"array","items":{"type":"string","enum":["basic","all","code","name","status","created_at","updated_at","brands","default_brand","custom_fields"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `Merchant` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"693b0f18-54cb-4ce8-8172-9008944db9a9":{"name":"fields:warehouse","in":"query","required":false,"description":"Specify additional fields of the `Warehouse` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Warehouse","description":"Specify additional fields of the `Warehouse` object to be included in the response.","type":"array","items":{"type":"string","enum":["basic","all","id","name","is_active","abbreviation"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"7ffe8815-693a-4aad-9247-89738acc9d73":{"name":"fields:status_history","in":"query","required":false,"description":"Specify additional fields of the `DeliveryStatusHistory` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"DeliveryStatusHistory","type":"array","items":{"type":"string","enum":["all","delivery_item","status","exception","exception_status","comment","user","created_at","package"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `DeliveryStatusHistory` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"34a21bf0-6722-4dc5-b65c-917233f98a1b":{"name":"fields:items","in":"query","required":false,"description":"Specify additional fields of the `DeliveryItem` objects to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"DeliveryItem","type":"array","items":{"type":"string","enum":["basic","all","product","quantity","qty_expected","qty_received","qty_shortage","qty_overage","qty_processed","qty_putaway","qty_committed","qty_returned","is_sku_merge_email_sent","lots","locations","exceptions"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `DeliveryItem` objects to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"3a9ea240-fe75-470c-905b-8f1c7ab01c74":{"name":"fields:items.exceptions","in":"query","required":false,"description":"Specify additional fields of the `DeliveryException` objects nested under items to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"DeliveryException","type":"array","items":{"type":"string","enum":["basic","all","container","lot","status","sign","reason","comment","quantity"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `DeliveryException` objects nested under items to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"bcf4d245-d3c7-4439-a311-8df93ea795dc":{"name":"fields:items.lots","in":"query","required":false,"description":"Specify additional fields of the `DeliveryItemLot` objects nested under items to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"DeliveryItemLot","type":"array","items":{"type":"string","enum":["all","lot","qty_counted","qty_putaway"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `DeliveryItemLot` objects nested under items to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"b2839e9f-b569-47c1-849f-dce229239e33":{"name":"fields:items.locations","in":"query","required":false,"description":"Specify additional fields of the `DeliveryItemLocation` objects nested under items to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"DeliveryItemLocation","type":"array","items":{"type":"string","enum":["all","location","qty_putaway","qty_committed"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `DeliveryItemLocation` objects nested under items to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"b758cbfd-9a47-491f-8d2b-3d35ce7dcbcd":{"name":"fields:containers","in":"query","required":false,"description":"Specify additional fields of the `DeliveryContainer` objects to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"DeliveryContainer","type":"array","items":{"type":"string","enum":["basic","all","label","type","status","weight","length","width","height","total_skus","total_qty","contents"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"description":"Specify additional fields of the `DeliveryContainer` objects to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"12bf0696-28c4-42af-a14e-5fa7ad5e0fd8":{"in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int32","minimum":1,"isRequired":true,"description":"The `id` of the referenced `Delivery`.","uniqueKey":"","typeLabel":"integer\u003cint32>"},"description":"The `id` of the referenced `Delivery`."}},"responses":{"c23f363f-8e7a-47e9-9531-ec303e9ecc80":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"oneOf":[{"type":"object","title":"ASN","description":"An `ASN` (Advanced Shipping Notification) delivery object.","required":["type","warehouse"],"properties":{"type":{"type":"string","enum":["ASN"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.0.type","typeLabel":"enum\u003cstring>"},"warehouse":{"oneOf":[{"type":"object","title":"WarehouseRef","description":"The `Warehouse` which is the destination for this delivery.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.0.warehouse.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.0.warehouse.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"resource.oneOf.0.warehouse.oneOf.0","typeLabel":"WarehouseRef · object"},{"type":"null","title":"WarehouseRef","description":"The `Warehouse` which is the destination for this delivery.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"isRequired":true,"uniqueKey":"resource.oneOf.0.warehouse.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resource.oneOf.0.warehouse","typeLabel":"WarehouseRef · object | null"},"id":{"type":"integer","readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.id","typeLabel":"integer"},"supplier_name":{"oneOf":[{"type":"string","description":"Name of the supplier.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.0.supplier_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the supplier.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.0.supplier_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.supplier_name","typeLabel":"string | null"},"expected_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the ASN delivery is expected in RFC 3339 section 5.6 notation.","uniqueKey":"resource.oneOf.0.expected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the ASN delivery is expected in RFC 3339 section 5.6 notation.","uniqueKey":"resource.oneOf.0.expected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.expected_at","typeLabel":"string\u003cdate-time> | null"},"merchant_reference":{"oneOf":[{"type":"string","description":"The \"Merchant Reference\" property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.merchant_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The \"Merchant Reference\" property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.merchant_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.merchant_reference","typeLabel":"string | null"},"supplier_invoice_reference":{"oneOf":[{"type":"string","description":"Unique reference number that will help to identify the invoice of a specific supplier.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.supplier_invoice_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique reference number that will help to identify the invoice of a specific supplier.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.supplier_invoice_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.supplier_invoice_reference","typeLabel":"string | null"},"supplier_order_reference":{"oneOf":[{"type":"string","description":"Unique reference number that will help to identify the order of a specific supplier.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.supplier_order_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"Unique reference number that will help to identify the order of a specific supplier.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.supplier_order_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.supplier_order_reference","typeLabel":"string | null"},"shipment_type":{"oneOf":[{"type":"string","description":"The shipment type that the carrier will use for delivery.","enum":["international_maritime_freight","international_air_freight","ftl_freight","ltl_freight","parcel","other"],"uniqueKey":"resource.oneOf.0.shipment_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"The shipment type that the carrier will use for delivery.","enum":["international_maritime_freight","international_air_freight","ftl_freight","ltl_freight","parcel","other"],"uniqueKey":"resource.oneOf.0.shipment_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.shipment_type","typeLabel":"enum\u003cstring> | null"},"bill_of_lading":{"oneOf":[{"type":"string","description":"The legal document used in freight shipping issued by the carrier which details the goods being shipped and the destination. This will not be available for Parcel or Other/Unknown shipment types.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.bill_of_lading.oneOf.0","typeLabel":"string"},{"type":"null","description":"The legal document used in freight shipping issued by the carrier which details the goods being shipped and the destination. This will not be available for Parcel or Other/Unknown shipment types.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.bill_of_lading.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.bill_of_lading","typeLabel":"string | null"},"standard_carrier_alpha_code":{"oneOf":[{"type":"string","description":"The SCAC (Standard Carrier Alpha Code) is typically marked on a shipper's containers and useful for identifying the carrier for International Maritime Freight type shipments. This should be 2 to 4 characters for a specific carrier.","minLength":4,"maxLength":4,"uniqueKey":"resource.oneOf.0.standard_carrier_alpha_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The SCAC (Standard Carrier Alpha Code) is typically marked on a shipper's containers and useful for identifying the carrier for International Maritime Freight type shipments. This should be 2 to 4 characters for a specific carrier.","minLength":4,"maxLength":4,"uniqueKey":"resource.oneOf.0.standard_carrier_alpha_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.standard_carrier_alpha_code","typeLabel":"string | null"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which this delivery belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"resource.oneOf.0.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.0.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.0.merchant","typeLabel":"MerchantRef · object"},"increment_id":{"type":"string","example":"11000020","description":"Unique identifier for the `Delivery`.","readOnly":true,"uniqueKey":"resource.oneOf.0.increment_id","typeLabel":"string"},"state":{"type":"string","description":"This describes the high-level, overall progress of the delivery.","enum":["new","processing","putting_away","pending_commit","complete","canceled"],"readOnly":true,"uniqueKey":"resource.oneOf.0.state","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"This describes the low-level details of the current process of the delivery.","enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"readOnly":true,"uniqueKey":"resource.oneOf.0.status","typeLabel":"enum\u003cstring>"},"progress_percent":{"type":"integer","description":"The overall delivery completion progress from 0 to 100 percent.","minimum":0,"maximum":100,"readOnly":true,"uniqueKey":"resource.oneOf.0.progress_percent","typeLabel":"integer"},"carrier_name":{"type":"string","description":"The name of the carrier assigned to the delivery.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.0.carrier_name","typeLabel":"string"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the \"Delivered At\" field in the ShipStream UI. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the \"Delivered At\" field in the ShipStream UI. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.delivered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.delivered_at","typeLabel":"string\u003cdate-time> | null"},"receive_by":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was received in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.receive_by.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was received in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.receive_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.receive_by","typeLabel":"string\u003cdate-time> | null"},"processed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was processed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.processed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was processed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.processed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.processed_at","typeLabel":"string\u003cdate-time> | null"},"putaway_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was put away in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.putaway_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was put away in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.putaway_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.putaway_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was completed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was completed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.completed_at","typeLabel":"string\u003cdate-time> | null"},"ready_to_process_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.ready_to_process_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.0.ready_to_process_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.ready_to_process_at","typeLabel":"string\u003cdate-time> | null"},"merchant_status":{"oneOf":[{"type":"string","description":"The merchant status for a delivery.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.merchant_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant status for a delivery.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.0.merchant_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.merchant_status","typeLabel":"string | null"},"item_count":{"type":"integer","description":"The quantity of delivery items.","readOnly":true,"uniqueKey":"resource.oneOf.0.item_count","typeLabel":"integer"},"container_count":{"type":"integer","description":"The quantity of delivery containers.","readOnly":true,"uniqueKey":"resource.oneOf.0.container_count","typeLabel":"integer"},"label_count":{"type":"integer","description":"The quantity of delivery labels.","readOnly":true,"uniqueKey":"resource.oneOf.0.label_count","typeLabel":"integer"},"exception_count":{"type":"integer","description":"The quantity of delivery exceptions.","readOnly":true,"uniqueKey":"resource.oneOf.0.exception_count","typeLabel":"integer"},"processing_comments":{"oneOf":[{"type":"string","description":"Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.","minLength":1,"maxLength":1000,"uniqueKey":"resource.oneOf.0.processing_comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.","minLength":1,"maxLength":1000,"uniqueKey":"resource.oneOf.0.processing_comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.processing_comments","typeLabel":"string | null"},"special_requirements":{"type":"array","description":"Special delivery requirements are set in the ShipStream Configurations.","items":{"type":"string","uniqueKey":"resource.oneOf.0.special_requirements.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.oneOf.0.special_requirements","typeLabel":"string[]"},"is_auto_commit":{"type":"boolean","description":"This is a flag indicating whether or not inventory can be commited automatically. 0 - Disabled, 1 - Enabled, 2 - Use default from config.","uniqueKey":"resource.oneOf.0.is_auto_commit","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"resource.oneOf.0.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"resource.oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"resource.oneOf.0.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"resource.oneOf.0.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.updated_at","typeLabel":"string\u003cdate-time> | null"},"tracking_numbers":{"type":"array","description":"The tracking numbers associated with the delivery.","items":{"type":"string","uniqueKey":"resource.oneOf.0.tracking_numbers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.oneOf.0.tracking_numbers","typeLabel":"string[]"},"status_history":{"type":"array","description":"A log of updates, comments and status changes added to this object.","readOnly":true,"items":{"type":"object","title":"DeliveryStatusHistory","description":"A `DeliveryStatusHistory` represents a status history of a delivery.","properties":{"delivery_item":{"type":"object","title":"DeliveryItem","description":"The item being delivered which includes inventory quantities and stock movement information. ","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item.exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].delivery_item","typeLabel":"DeliveryItem · object"},"status":{"type":"string","description":"The status of the delivery at the time the history event was added.","readOnly":true,"enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"exception":{"type":"object","description":"The processing exception of the container in the delivery.","properties":{"type":{"type":"string","enum":["Exception"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].exception.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal id property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].exception.id","typeLabel":"integer"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].exception","typeLabel":"object"},"exception_status":{"type":"string","description":"The status of the processing exception.","enum":["new","pending","approved","rejected","void"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].exception_status","typeLabel":"enum\u003cstring>"},"comment":{"type":"string","description":"An optional description for the history event which can be added programatically.","readOnly":true,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].comment","typeLabel":"string"},"requester":{"oneOf":[{"type":"object","title":"RequesterRef","description":"The requester attributed to the delivery's status history update.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Requester"],"example":"Requester","description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].requester.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].requester.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].requester.oneOf.0","typeLabel":"RequesterRef · object"},{"type":"null","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].requester.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].requester","typeLabel":"RequesterRef · object | null"},"created_at":{"type":"string","description":"The date and time the object was created in RFC 3339 section 5.6 notation.","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"package":{"type":"object","description":"The package associated with the delivery.","properties":{"type":{"type":"string","enum":["Package"],"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].package.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].package.id","typeLabel":"integer"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX].package","typeLabel":"object"}},"uniqueKey":"resource.oneOf.0.status_history.items.[INDEX]","typeLabel":"DeliveryStatusHistory · object"},"uniqueKey":"resource.oneOf.0.status_history","typeLabel":"DeliveryStatusHistory · object[]"},"items":{"type":"array","description":"The items included in this delivery.","readOnly":true,"items":{"title":"DeliveryItem","type":"object","description":"An object to represent `DeliveryItem`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX].exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"resource.oneOf.0.\\items.items.[INDEX]","typeLabel":"DeliveryItem · object"},"uniqueKey":"resource.oneOf.0.\\items","typeLabel":"DeliveryItem · object[]"}},"uniqueKey":"resource.oneOf.0","typeLabel":"ASN · object"},{"type":"object","title":"RMA","description":"An `RMA` (Return Merchandise Authorization) delivery object.","required":["type","warehouse"],"properties":{"type":{"type":"string","enum":["RMA"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.1.type","typeLabel":"enum\u003cstring>"},"warehouse":{"oneOf":[{"type":"object","title":"WarehouseRef","description":"The `Warehouse` which is the destination for this delivery.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.1.warehouse.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.1.warehouse.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"resource.oneOf.1.warehouse.oneOf.0","typeLabel":"WarehouseRef · object"},{"type":"null","title":"WarehouseRef","description":"The `Warehouse` which is the destination for this delivery.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"isRequired":true,"uniqueKey":"resource.oneOf.1.warehouse.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resource.oneOf.1.warehouse","typeLabel":"WarehouseRef · object | null"},"id":{"type":"integer","readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.id","typeLabel":"integer"},"customer_name":{"type":"string","description":"The name of the customer from which the return merchandise authorization (RMA) originated.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.1.customer_name","typeLabel":"string"},"expected_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the return was authorized in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.expected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the return was authorized in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.expected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.expected_at","typeLabel":"string\u003cdate-time> | null"},"merchant_rma_number":{"type":"string","description":"The RMA number defined for the merchant. This field does not have to be unique.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.1.merchant_rma_number","typeLabel":"string"},"carrier_tracking_number":{"type":"string","description":"Carrier tracking number of a spcific delivery","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.1.carrier_tracking_number","typeLabel":"string"},"merchant_order_number":{"type":"string","description":"The Merchant Order Number is used to associate the RMA with a specific merchant order. This field does not have to be unique.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.1.merchant_order_number","typeLabel":"string"},"order":{"oneOf":[{"type":"object","title":"OrderRef","description":"The original order that the RMA is being issued for. ","required":["type","id"],"properties":{"type":{"type":"string","enum":["Order"],"isRequired":true,"uniqueKey":"resource.oneOf.1.order.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.1.order.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.1.order.oneOf.0","typeLabel":"OrderRef · object"},{"type":"null","title":"OrderRef","description":"The original order that the RMA is being issued for. ","required":["type","id"],"properties":{"type":{"type":"string","enum":["Order"]},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"uniqueKey":"resource.oneOf.1.order.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.order","typeLabel":"OrderRef · object | null"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which this delivery belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"resource.oneOf.1.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.1.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.1.merchant","typeLabel":"MerchantRef · object"},"increment_id":{"type":"string","example":"11000020","description":"Unique identifier for the `Delivery`.","readOnly":true,"uniqueKey":"resource.oneOf.1.increment_id","typeLabel":"string"},"state":{"type":"string","description":"This describes the high-level, overall progress of the delivery.","enum":["new","processing","putting_away","pending_commit","complete","canceled"],"readOnly":true,"uniqueKey":"resource.oneOf.1.state","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"This describes the low-level details of the current process of the delivery.","enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"readOnly":true,"uniqueKey":"resource.oneOf.1.status","typeLabel":"enum\u003cstring>"},"progress_percent":{"type":"integer","description":"The overall delivery completion progress from 0 to 100 percent.","minimum":0,"maximum":100,"readOnly":true,"uniqueKey":"resource.oneOf.1.progress_percent","typeLabel":"integer"},"carrier_name":{"type":"string","description":"The name of the carrier assigned to the delivery.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.1.carrier_name","typeLabel":"string"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the \"Delivered At\" field in the ShipStream UI. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the \"Delivered At\" field in the ShipStream UI. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.delivered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.delivered_at","typeLabel":"string\u003cdate-time> | null"},"receive_by":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was received in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.receive_by.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was received in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.receive_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.receive_by","typeLabel":"string\u003cdate-time> | null"},"processed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was processed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.processed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was processed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.processed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.processed_at","typeLabel":"string\u003cdate-time> | null"},"putaway_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was put away in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.putaway_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was put away in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.putaway_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.putaway_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was completed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was completed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.completed_at","typeLabel":"string\u003cdate-time> | null"},"ready_to_process_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.ready_to_process_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.1.ready_to_process_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.ready_to_process_at","typeLabel":"string\u003cdate-time> | null"},"merchant_status":{"oneOf":[{"type":"string","description":"The merchant status for a delivery.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.1.merchant_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant status for a delivery.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.1.merchant_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.merchant_status","typeLabel":"string | null"},"item_count":{"type":"integer","description":"The quantity of delivery items.","readOnly":true,"uniqueKey":"resource.oneOf.1.item_count","typeLabel":"integer"},"container_count":{"type":"integer","description":"The quantity of delivery containers.","readOnly":true,"uniqueKey":"resource.oneOf.1.container_count","typeLabel":"integer"},"label_count":{"type":"integer","description":"The quantity of delivery labels.","readOnly":true,"uniqueKey":"resource.oneOf.1.label_count","typeLabel":"integer"},"exception_count":{"type":"integer","description":"The quantity of delivery exceptions.","readOnly":true,"uniqueKey":"resource.oneOf.1.exception_count","typeLabel":"integer"},"processing_comments":{"oneOf":[{"type":"string","description":"Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.","minLength":1,"maxLength":1000,"uniqueKey":"resource.oneOf.1.processing_comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.","minLength":1,"maxLength":1000,"uniqueKey":"resource.oneOf.1.processing_comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.processing_comments","typeLabel":"string | null"},"special_requirements":{"type":"array","description":"Special delivery requirements are set in the ShipStream Configurations.","items":{"type":"string","uniqueKey":"resource.oneOf.1.special_requirements.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.oneOf.1.special_requirements","typeLabel":"string[]"},"is_auto_commit":{"type":"boolean","description":"This is a flag indicating whether or not inventory can be commited automatically. 0 - Disabled, 1 - Enabled, 2 - Use default from config.","uniqueKey":"resource.oneOf.1.is_auto_commit","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"resource.oneOf.1.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"resource.oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"resource.oneOf.1.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"resource.oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.updated_at","typeLabel":"string\u003cdate-time> | null"},"tracking_numbers":{"type":"array","description":"The tracking numbers associated with the delivery.","items":{"type":"string","uniqueKey":"resource.oneOf.1.tracking_numbers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.oneOf.1.tracking_numbers","typeLabel":"string[]"},"status_history":{"type":"array","description":"A log of updates, comments and status changes added to this object.","readOnly":true,"items":{"type":"object","title":"DeliveryStatusHistory","description":"A `DeliveryStatusHistory` represents a status history of a delivery.","properties":{"delivery_item":{"type":"object","title":"DeliveryItem","description":"The item being delivered which includes inventory quantities and stock movement information. ","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item.exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].delivery_item","typeLabel":"DeliveryItem · object"},"status":{"type":"string","description":"The status of the delivery at the time the history event was added.","readOnly":true,"enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"exception":{"type":"object","description":"The processing exception of the container in the delivery.","properties":{"type":{"type":"string","enum":["Exception"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].exception.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal id property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].exception.id","typeLabel":"integer"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].exception","typeLabel":"object"},"exception_status":{"type":"string","description":"The status of the processing exception.","enum":["new","pending","approved","rejected","void"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].exception_status","typeLabel":"enum\u003cstring>"},"comment":{"type":"string","description":"An optional description for the history event which can be added programatically.","readOnly":true,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].comment","typeLabel":"string"},"requester":{"oneOf":[{"type":"object","title":"RequesterRef","description":"The requester attributed to the delivery's status history update.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Requester"],"example":"Requester","description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].requester.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].requester.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].requester.oneOf.0","typeLabel":"RequesterRef · object"},{"type":"null","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].requester.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].requester","typeLabel":"RequesterRef · object | null"},"created_at":{"type":"string","description":"The date and time the object was created in RFC 3339 section 5.6 notation.","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"package":{"type":"object","description":"The package associated with the delivery.","properties":{"type":{"type":"string","enum":["Package"],"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].package.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].package.id","typeLabel":"integer"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX].package","typeLabel":"object"}},"uniqueKey":"resource.oneOf.1.status_history.items.[INDEX]","typeLabel":"DeliveryStatusHistory · object"},"uniqueKey":"resource.oneOf.1.status_history","typeLabel":"DeliveryStatusHistory · object[]"},"items":{"type":"array","description":"The items included in this delivery.","readOnly":true,"items":{"title":"DeliveryItem","type":"object","description":"An object to represent `DeliveryItem`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX].exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"resource.oneOf.1.\\items.items.[INDEX]","typeLabel":"DeliveryItem · object"},"uniqueKey":"resource.oneOf.1.\\items","typeLabel":"DeliveryItem · object[]"}},"uniqueKey":"resource.oneOf.1","typeLabel":"RMA · object"},{"type":"object","title":"Other","description":"An `Other` delivery object for miscellaneous receiving operations.","required":["type","warehouse"],"properties":{"type":{"type":"string","enum":["Other"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.2.type","typeLabel":"enum\u003cstring>"},"warehouse":{"oneOf":[{"type":"object","title":"WarehouseRef","description":"The `Warehouse` which is the destination for this delivery.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.2.warehouse.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.2.warehouse.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"resource.oneOf.2.warehouse.oneOf.0","typeLabel":"WarehouseRef · object"},{"type":"null","title":"WarehouseRef","description":"The `Warehouse` which is the destination for this delivery.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"isRequired":true,"uniqueKey":"resource.oneOf.2.warehouse.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"resource.oneOf.2.warehouse","typeLabel":"WarehouseRef · object | null"},"id":{"type":"integer","readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.id","typeLabel":"integer"},"sender_name":{"oneOf":[{"type":"string","description":"Name of the sender.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.2.sender_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Name of the sender.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.2.sender_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.sender_name","typeLabel":"string | null"},"expected_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery is expected in RFC 3339 section 5.6 notation.","uniqueKey":"resource.oneOf.2.expected_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery is expected in RFC 3339 section 5.6 notation.","uniqueKey":"resource.oneOf.2.expected_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.expected_at","typeLabel":"string\u003cdate-time> | null"},"merchant_reference":{"oneOf":[{"type":"string","description":"The \"Merchant Reference\" property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.merchant_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"The \"Merchant Reference\" property. Uniqueness based on this field is enforced so an error will be given if a delivery with the same merchant_ref already exists.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.merchant_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.merchant_reference","typeLabel":"string | null"},"sender_reference":{"oneOf":[{"type":"string","description":"A reference number from the sender.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.sender_reference.oneOf.0","typeLabel":"string"},{"type":"null","description":"A reference number from the sender.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.sender_reference.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.sender_reference","typeLabel":"string | null"},"sender_reference_alt":{"oneOf":[{"type":"string","description":"An alternate reference number from the sender.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.sender_reference_alt.oneOf.0","typeLabel":"string"},{"type":"null","description":"An alternate reference number from the sender.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.sender_reference_alt.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.sender_reference_alt","typeLabel":"string | null"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which this delivery belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"resource.oneOf.2.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.2.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.2.merchant","typeLabel":"MerchantRef · object"},"increment_id":{"type":"string","example":"11000020","description":"Unique identifier for the `Delivery`.","readOnly":true,"uniqueKey":"resource.oneOf.2.increment_id","typeLabel":"string"},"state":{"type":"string","description":"This describes the high-level, overall progress of the delivery.","enum":["new","processing","putting_away","pending_commit","complete","canceled"],"readOnly":true,"uniqueKey":"resource.oneOf.2.state","typeLabel":"enum\u003cstring>"},"status":{"type":"string","description":"This describes the low-level details of the current process of the delivery.","enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"readOnly":true,"uniqueKey":"resource.oneOf.2.status","typeLabel":"enum\u003cstring>"},"progress_percent":{"type":"integer","description":"The overall delivery completion progress from 0 to 100 percent.","minimum":0,"maximum":100,"readOnly":true,"uniqueKey":"resource.oneOf.2.progress_percent","typeLabel":"integer"},"carrier_name":{"type":"string","description":"The name of the carrier assigned to the delivery.","minLength":1,"maxLength":255,"uniqueKey":"resource.oneOf.2.carrier_name","typeLabel":"string"},"delivered_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the \"Delivered At\" field in the ShipStream UI. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.delivered_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was delivered in RFC 3339 section 5.6 notation. This corresponds with the \"Delivered At\" field in the ShipStream UI. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.delivered_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.delivered_at","typeLabel":"string\u003cdate-time> | null"},"receive_by":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was received in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.receive_by.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was received in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.receive_by.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.receive_by","typeLabel":"string\u003cdate-time> | null"},"processed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was processed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.processed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was processed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.processed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.processed_at","typeLabel":"string\u003cdate-time> | null"},"putaway_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was put away in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.putaway_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was put away in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.putaway_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.putaway_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was completed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery was completed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.completed_at","typeLabel":"string\u003cdate-time> | null"},"ready_to_process_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.ready_to_process_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the delivery will be ready to process in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"resource.oneOf.2.ready_to_process_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.ready_to_process_at","typeLabel":"string\u003cdate-time> | null"},"merchant_status":{"oneOf":[{"type":"string","description":"The merchant status for a delivery.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.merchant_status.oneOf.0","typeLabel":"string"},{"type":"null","description":"The merchant status for a delivery.","minLength":1,"maxLength":45,"uniqueKey":"resource.oneOf.2.merchant_status.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.merchant_status","typeLabel":"string | null"},"item_count":{"type":"integer","description":"The quantity of delivery items.","readOnly":true,"uniqueKey":"resource.oneOf.2.item_count","typeLabel":"integer"},"container_count":{"type":"integer","description":"The quantity of delivery containers.","readOnly":true,"uniqueKey":"resource.oneOf.2.container_count","typeLabel":"integer"},"label_count":{"type":"integer","description":"The quantity of delivery labels.","readOnly":true,"uniqueKey":"resource.oneOf.2.label_count","typeLabel":"integer"},"exception_count":{"type":"integer","description":"The quantity of delivery exceptions.","readOnly":true,"uniqueKey":"resource.oneOf.2.exception_count","typeLabel":"integer"},"processing_comments":{"oneOf":[{"type":"string","description":"Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.","minLength":1,"maxLength":1000,"uniqueKey":"resource.oneOf.2.processing_comments.oneOf.0","typeLabel":"string"},{"type":"null","description":"Comments for the delivery are recorded in the History tab of the ShipStream Delivery view. This corresponds to Processing Options > Processing Comments when creating a delivery.","minLength":1,"maxLength":1000,"uniqueKey":"resource.oneOf.2.processing_comments.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.processing_comments","typeLabel":"string | null"},"special_requirements":{"type":"array","description":"Special delivery requirements are set in the ShipStream Configurations.","items":{"type":"string","uniqueKey":"resource.oneOf.2.special_requirements.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.oneOf.2.special_requirements","typeLabel":"string[]"},"is_auto_commit":{"type":"boolean","description":"This is a flag indicating whether or not inventory can be commited automatically. 0 - Disabled, 1 - Enabled, 2 - Use default from config.","uniqueKey":"resource.oneOf.2.is_auto_commit","typeLabel":"boolean"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"resource.oneOf.2.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"resource.oneOf.2.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"resource.oneOf.2.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"resource.oneOf.2.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.updated_at","typeLabel":"string\u003cdate-time> | null"},"tracking_numbers":{"type":"array","description":"The tracking numbers associated with the delivery.","items":{"type":"string","uniqueKey":"resource.oneOf.2.tracking_numbers.items.[INDEX]","typeLabel":"string"},"uniqueKey":"resource.oneOf.2.tracking_numbers","typeLabel":"string[]"},"status_history":{"type":"array","description":"A log of updates, comments and status changes added to this object.","readOnly":true,"items":{"type":"object","title":"DeliveryStatusHistory","description":"A `DeliveryStatusHistory` represents a status history of a delivery.","properties":{"delivery_item":{"type":"object","title":"DeliveryItem","description":"The item being delivered which includes inventory quantities and stock movement information. ","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item.exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].delivery_item","typeLabel":"DeliveryItem · object"},"status":{"type":"string","description":"The status of the delivery at the time the history event was added.","readOnly":true,"enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"exception":{"type":"object","description":"The processing exception of the container in the delivery.","properties":{"type":{"type":"string","enum":["Exception"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].exception.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal id property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].exception.id","typeLabel":"integer"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].exception","typeLabel":"object"},"exception_status":{"type":"string","description":"The status of the processing exception.","enum":["new","pending","approved","rejected","void"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].exception_status","typeLabel":"enum\u003cstring>"},"comment":{"type":"string","description":"An optional description for the history event which can be added programatically.","readOnly":true,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].comment","typeLabel":"string"},"requester":{"oneOf":[{"type":"object","title":"RequesterRef","description":"The requester attributed to the delivery's status history update.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Requester"],"example":"Requester","description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].requester.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].requester.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].requester.oneOf.0","typeLabel":"RequesterRef · object"},{"type":"null","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].requester.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].requester","typeLabel":"RequesterRef · object | null"},"created_at":{"type":"string","description":"The date and time the object was created in RFC 3339 section 5.6 notation.","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"package":{"type":"object","description":"The package associated with the delivery.","properties":{"type":{"type":"string","enum":["Package"],"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].package.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].package.id","typeLabel":"integer"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX].package","typeLabel":"object"}},"uniqueKey":"resource.oneOf.2.status_history.items.[INDEX]","typeLabel":"DeliveryStatusHistory · object"},"uniqueKey":"resource.oneOf.2.status_history","typeLabel":"DeliveryStatusHistory · object[]"},"items":{"type":"array","description":"The items included in this delivery.","readOnly":true,"items":{"title":"DeliveryItem","type":"object","description":"An object to represent `DeliveryItem`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX].exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"resource.oneOf.2.\\items.items.[INDEX]","typeLabel":"DeliveryItem · object"},"uniqueKey":"resource.oneOf.2.\\items","typeLabel":"DeliveryItem · object[]"}},"uniqueKey":"resource.oneOf.2","typeLabel":"Other · object"}],"uniqueKey":"resource","typeLabel":"ASN · object | RMA · object | Other · object"},"included":{"type":"object","description":"Lists of referenced objects included by specifying optional fields.\nSee the [selecting fields](/global-api/selecting-fields) page for more information.","properties":{"DeliveryContainer":{"type":"array","items":{"title":"DeliveryContainer","type":"object","description":"An object to represents a `DeliveryContainer`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryContainer"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryContainer.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"container_type":{"title":"DeliveryContainerType","type":"object","description":"An object to represent `DeliveryContainerType`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryContainerType"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.id","typeLabel":"integer\u003cint32>"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` associated with this delivery container type.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.merchant","typeLabel":"MerchantRef · object"},"delivery_type":{"type":"string","description":"The type of delivery allowed for the container type.","enum":["asn","rma","other_delivery","cancellation","work_order_output"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.delivery_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the delivery container type.","minLength":1,"maxLength":255,"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.name","typeLabel":"string"},"name_plural":{"type":"string","description":"The plural form of the delivery container type name used internally when referring to more than one type.","minLength":1,"maxLength":255,"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.name_plural","typeLabel":"string"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"This defines the weight of the `DeliveryContainerType` in imperial or metric units.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"This defines the weight of the `DeliveryContainerType` in imperial or metric units.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.weight","typeLabel":"Weight · object | null"},"is_default":{"type":"boolean","description":"This indicates whether or not the `DeliveryContainerType` is the default type.","enum":[true,false],"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.is_default","typeLabel":"enum\u003cboolean>"},"is_system":{"type":"boolean","description":"This indicates that the `DeliveryContainerType` is used only for internal system operations.","enum":[true,false],"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type.is_system","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].container_type","typeLabel":"DeliveryContainerType · object"},"damage_type":{"type":"string","description":"This indicates if the container damage is noted or not.","enum":["none","noted","unnoted"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].damage_type","typeLabel":"enum\u003cstring>"},"weight_discrepancy_reason":{"type":"string","description":"A description for why the delivery's weight is not matching the expected value.","enum":["none","shortage_noted","shortage_unnoted","overage|unknown"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].weight_discrepancy_reason","typeLabel":"enum\u003cstring>"},"tare_weight":{"oneOf":[{"type":"object","title":"Weight","description":"The total weight of the delivery container when empty.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.DeliveryContainer.items.[INDEX].tare_weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].tare_weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].tare_weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"The total weight of the delivery container when empty.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].tare_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryContainer.items.[INDEX].tare_weight","typeLabel":"Weight · object | null"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"This defines the full weight of the `DeliveryContainer` in imperial or metric units.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.DeliveryContainer.items.[INDEX].weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"This defines the full weight of the `DeliveryContainer` in imperial or metric units.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryContainer.items.[INDEX].weight","typeLabel":"Weight · object | null"},"weighed_at":{"oneOf":[{"type":"string","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the object was weighed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"included.DeliveryContainer.items.[INDEX].weighed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2019-12-03T21:06:26Z","readOnly":true,"description":"The date and time the object was weighed in RFC 3339 section 5.6 notation. \\\n `Optional Field`","uniqueKey":"included.DeliveryContainer.items.[INDEX].weighed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryContainer.items.[INDEX].weighed_at","typeLabel":"string\u003cdate-time> | null"},"weighed_by":{"type":"object","title":"UserRef","description":"Reference an `OrganizationUser` or `ClientUser` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["OrganizationUser","ClientUser"],"isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].weighed_by.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].weighed_by.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.DeliveryContainer.items.[INDEX].weighed_by","typeLabel":"UserRef · object"},"contents":{"type":"array","description":"A list of `DeliveryContainerContent` objects.","items":{"title":"DeliveryContainerContent","type":"object","description":"An object to represents a `DeliveryContainerContent`.","properties":{"delivery_item":{"title":"DeliveryItem","description":"A reference to a `DeliveryItem` object.","type":"object","properties":{"type":{"type":"string","enum":["DeliveryItem"],"isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].delivery_item.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].delivery_item.id","typeLabel":"integer"}},"required":["type","id"],"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].delivery_item","typeLabel":"DeliveryItem · object"},"qty_counted":{"type":"number","description":"The quantity of contents within a delivery container.","format":"float","uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of items missing from the delivery container.","format":"float","uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_shortage","typeLabel":"number\u003cfloat>"},"qty_counted_per_lot":{"type":"array","description":"The quantity of items in the container counted per delivery container lot.","items":{"type":"object","properties":{"lot":{"oneOf":[{"type":"object","title":"LotRef","description":"A reference to a `Lot` object. The Lot records the time some inventory was originated (first received or\notherwise created) and optionally a lot number and expiration date and may affect the order in which\ninventory is \"burned\" depending on the `LotType`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX].lot.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","example":54,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX].lot.oneOf.0.id","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX].lot.oneOf.0","typeLabel":"LotRef · object"},{"type":"null","title":"LotRef","description":"A reference to a `Lot` object. The Lot records the time some inventory was originated (first received or\notherwise created) and optionally a lot number and expiration date and may affect the order in which\ninventory is \"burned\" depending on the `LotType`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","example":54,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX].lot.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX].lot","typeLabel":"LotRef · object | null"},"quantity":{"type":"number","description":"The quantity of items for the specified delivery container lot.","format":"float","uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX].quantity","typeLabel":"number\u003cfloat>"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot.items.[INDEX]","typeLabel":"object"},"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX].qty_counted_per_lot","typeLabel":"object[]"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents.items.[INDEX]","typeLabel":"DeliveryContainerContent · object"},"uniqueKey":"included.DeliveryContainer.items.[INDEX].contents","typeLabel":"DeliveryContainerContent · object[]"},"condition_note":{"type":"string","description":"A description of the container condition upon reception.","uniqueKey":"included.DeliveryContainer.items.[INDEX].condition_note","typeLabel":"string"},"item_count":{"type":"integer","description":"The quantity of items in the delivery container.","uniqueKey":"included.DeliveryContainer.items.[INDEX].item_count","typeLabel":"integer"}},"uniqueKey":"included.DeliveryContainer.items.[INDEX]","typeLabel":"DeliveryContainer · object"},"uniqueKey":"included.DeliveryContainer","typeLabel":"DeliveryContainer · object[]"},"DeliveryContainerType":{"type":"array","items":{"title":"DeliveryContainerType","type":"object","description":"An object to represent `DeliveryContainerType`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryContainerType"],"uniqueKey":"included.DeliveryContainerType.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryContainerType.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` associated with this delivery container type.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.DeliveryContainerType.items.[INDEX].merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryContainerType.items.[INDEX].merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.DeliveryContainerType.items.[INDEX].merchant","typeLabel":"MerchantRef · object"},"delivery_type":{"type":"string","description":"The type of delivery allowed for the container type.","enum":["asn","rma","other_delivery","cancellation","work_order_output"],"uniqueKey":"included.DeliveryContainerType.items.[INDEX].delivery_type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The name of the delivery container type.","minLength":1,"maxLength":255,"uniqueKey":"included.DeliveryContainerType.items.[INDEX].name","typeLabel":"string"},"name_plural":{"type":"string","description":"The plural form of the delivery container type name used internally when referring to more than one type.","minLength":1,"maxLength":255,"uniqueKey":"included.DeliveryContainerType.items.[INDEX].name_plural","typeLabel":"string"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"This defines the weight of the `DeliveryContainerType` in imperial or metric units.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.DeliveryContainerType.items.[INDEX].weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.DeliveryContainerType.items.[INDEX].weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.DeliveryContainerType.items.[INDEX].weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"This defines the weight of the `DeliveryContainerType` in imperial or metric units.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.DeliveryContainerType.items.[INDEX].weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryContainerType.items.[INDEX].weight","typeLabel":"Weight · object | null"},"is_default":{"type":"boolean","description":"This indicates whether or not the `DeliveryContainerType` is the default type.","enum":[true,false],"uniqueKey":"included.DeliveryContainerType.items.[INDEX].is_default","typeLabel":"enum\u003cboolean>"},"is_system":{"type":"boolean","description":"This indicates that the `DeliveryContainerType` is used only for internal system operations.","enum":[true,false],"uniqueKey":"included.DeliveryContainerType.items.[INDEX].is_system","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.DeliveryContainerType.items.[INDEX]","typeLabel":"DeliveryContainerType · object"},"uniqueKey":"included.DeliveryContainerType","typeLabel":"DeliveryContainerType · object[]"},"DeliveryException":{"type":"array","items":{"title":"DeliveryException","type":"object","description":"An object to represent `DeliveryException`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"included.DeliveryException.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryException.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"container":{"title":"DeliveryContainerRef","type":"object","description":"A reference to `DeliveryContainer` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryContainer"],"uniqueKey":"included.DeliveryException.items.[INDEX].container.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryException.items.[INDEX].container.id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryException.items.[INDEX].container","typeLabel":"DeliveryContainerRef · object"},"lot":{"oneOf":[{"title":"LotRef","type":"object","description":"A reference to a `Lot` object. The Lot records the time some inventory was originated (first received or\notherwise created) and optionally a lot number and expiration date and may affect the order in which\ninventory is \"burned\" depending on the `LotType`.","properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.DeliveryException.items.[INDEX].lot.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","example":54,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryException.items.[INDEX].lot.oneOf.0.id","typeLabel":"integer"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.DeliveryException.items.[INDEX].lot.oneOf.0","typeLabel":"LotRef · object"},{"title":"LotRef","type":"null","description":"A reference to a `Lot` object. The Lot records the time some inventory was originated (first received or\notherwise created) and optionally a lot number and expiration date and may affect the order in which\ninventory is \"burned\" depending on the `LotType`.","properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","example":54,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.DeliveryException.items.[INDEX].lot.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryException.items.[INDEX].lot","typeLabel":"LotRef · object | null"},"status":{"type":"string","description":"The status of the exception.","enum":["new","pending","approved","rejected","void","closed"],"uniqueKey":"included.DeliveryException.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"sign":{"type":"integer","description":"The sign indicating shortage (-1), overage (1), or none (0).","enum":[-1,0,1],"uniqueKey":"included.DeliveryException.items.[INDEX].sign","typeLabel":"enum\u003cinteger>"},"reason":{"oneOf":[{"type":"string","description":"The reason for this exception.","uniqueKey":"included.DeliveryException.items.[INDEX].reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"The reason for this exception.","uniqueKey":"included.DeliveryException.items.[INDEX].reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryException.items.[INDEX].reason","typeLabel":"string | null"},"comment":{"oneOf":[{"type":"string","description":"A comment included with the exception.","uniqueKey":"included.DeliveryException.items.[INDEX].comment.oneOf.0","typeLabel":"string"},{"type":"null","description":"A comment included with the exception.","uniqueKey":"included.DeliveryException.items.[INDEX].comment.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryException.items.[INDEX].comment","typeLabel":"string | null"},"quantity":{"type":"number","description":"The quantity of the exception.","format":"float","uniqueKey":"included.DeliveryException.items.[INDEX].quantity","typeLabel":"number\u003cfloat>"}},"uniqueKey":"included.DeliveryException.items.[INDEX]","typeLabel":"DeliveryException · object"},"uniqueKey":"included.DeliveryException","typeLabel":"DeliveryException · object[]"},"DeliveryItem":{"type":"array","items":{"title":"DeliveryItem","type":"object","description":"An object to represent `DeliveryItem`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"included.DeliveryItem.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItem.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.DeliveryItem.items.[INDEX].product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryItem.items.[INDEX].product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.DeliveryItem.items.[INDEX].product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"included.DeliveryItem.items.[INDEX].qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"included.DeliveryItem.items.[INDEX].is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"included.DeliveryItem.items.[INDEX].lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItem.items.[INDEX].lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryItem.items.[INDEX].lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"included.DeliveryItem.items.[INDEX].lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"included.DeliveryItem.items.[INDEX].locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItem.items.[INDEX].locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryItem.items.[INDEX].locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"included.DeliveryItem.items.[INDEX].locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"included.DeliveryItem.items.[INDEX].exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItem.items.[INDEX].exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryItem.items.[INDEX].exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"included.DeliveryItem.items.[INDEX].exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"included.DeliveryItem.items.[INDEX]","typeLabel":"DeliveryItem · object"},"uniqueKey":"included.DeliveryItem","typeLabel":"DeliveryItem · object[]"},"DeliveryItemLocation":{"type":"array","items":{"title":"DeliveryItemLocation","type":"object","description":"An object to represents a `DeliveryItemLocation`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"included.DeliveryItemLocation.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItemLocation.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"location":{"oneOf":[{"type":"object","title":"LocationRef","description":"A Location describes a user-specified inventory address within a warehouse.","required":["type","id"],"properties":{"type":{"type":"string","description":"This property describes the type of object in the response body.","enum":["Location"],"isRequired":true,"uniqueKey":"included.DeliveryItemLocation.items.[INDEX].location.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":42,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryItemLocation.items.[INDEX].location.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.DeliveryItemLocation.items.[INDEX].location.oneOf.0","typeLabel":"LocationRef · object"},{"type":"null","title":"LocationRef","description":"A Location describes a user-specified inventory address within a warehouse.","required":["type","id"],"properties":{"type":{"type":"string","description":"This property describes the type of object in the response body.","enum":["Location"]},"id":{"type":"integer","format":"int32","example":42,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"additionalProperties":false,"uniqueKey":"included.DeliveryItemLocation.items.[INDEX].location.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryItemLocation.items.[INDEX].location","typeLabel":"LocationRef · object | null"},"qty_putaway":{"type":"number","description":"The quantity of delivery items for \"put-away\" in this location.","format":"float","uniqueKey":"included.DeliveryItemLocation.items.[INDEX].qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of delivery items committed to this location.","format":"float","uniqueKey":"included.DeliveryItemLocation.items.[INDEX].qty_committed","typeLabel":"number\u003cfloat>"}},"uniqueKey":"included.DeliveryItemLocation.items.[INDEX]","typeLabel":"DeliveryItemLocation · object"},"uniqueKey":"included.DeliveryItemLocation","typeLabel":"DeliveryItemLocation · object[]"},"DeliveryItemLot":{"type":"array","items":{"title":"DeliveryItemLot","type":"object","description":"An object to represents a `DeliveryItemLot`.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"included.DeliveryItemLot.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItemLot.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"lot":{"oneOf":[{"type":"object","title":"Lot","description":"A reference to the `Lot` object associated with Warehouse Inventory Location.","properties":{"type":{"type":"string","enum":["Lot"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","uniqueKey":"included.DeliveryItemLot.items.[INDEX].lot.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","example":54,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryItemLot.items.[INDEX].lot.oneOf.0.id","typeLabel":"integer"}},"uniqueKey":"included.DeliveryItemLot.items.[INDEX].lot.oneOf.0","typeLabel":"Lot · object"},{"type":"null","title":"Lot","description":"A reference to the `Lot` object associated with Warehouse Inventory Location.","properties":{"type":{"type":"string","enum":["Lot"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body."},"id":{"type":"integer","example":54,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"uniqueKey":"included.DeliveryItemLot.items.[INDEX].lot.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryItemLot.items.[INDEX].lot","typeLabel":"Lot · object | null"},"qty_counted":{"type":"number","description":"The quantity of delivery items counted.","format":"float","uniqueKey":"included.DeliveryItemLot.items.[INDEX].qty_counted","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of delivery items for \"put-away\"","format":"float","uniqueKey":"included.DeliveryItemLot.items.[INDEX].qty_putaway","typeLabel":"number\u003cfloat>"}},"uniqueKey":"included.DeliveryItemLot.items.[INDEX]","typeLabel":"DeliveryItemLot · object"},"uniqueKey":"included.DeliveryItemLot","typeLabel":"DeliveryItemLot · object[]"},"DeliveryStatusHistory":{"type":"array","items":{"title":"DeliveryStatusHistory","type":"object","description":"A `DeliveryStatusHistory` represents a status history of a delivery.","properties":{"delivery_item":{"type":"object","title":"DeliveryItem","description":"The item being delivered which includes inventory quantities and stock movement information. ","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItem"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.id","typeLabel":"integer\u003cint32>"},"product":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.product.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.product.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.product","typeLabel":"ProductRef · object"},"quantity":{"type":"number","description":"The quantity of items in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.quantity","typeLabel":"number\u003cfloat>"},"qty_expected":{"type":"number","description":"The quantity of items expected in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_expected","typeLabel":"number\u003cfloat>"},"qty_received":{"type":"number","description":"The quantity of items received at the time of delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_received","typeLabel":"number\u003cfloat>"},"qty_shortage":{"type":"number","description":"The quantity of missing items in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_shortage","typeLabel":"number\u003cfloat>"},"qty_overage":{"type":"number","description":"The quantity of extra items in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_overage","typeLabel":"number\u003cfloat>"},"qty_processed":{"type":"number","description":"The quantity of items processed in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_processed","typeLabel":"number\u003cfloat>"},"qty_putaway":{"type":"number","description":"The quantity of items in \"put-away\".","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_putaway","typeLabel":"number\u003cfloat>"},"qty_committed":{"type":"number","description":"The quantity of items committed in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_committed","typeLabel":"number\u003cfloat>"},"qty_returned":{"type":"number","description":"The quantity of items returned in the delivery.","format":"float","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.qty_returned","typeLabel":"number\u003cfloat>"},"is_sku_merge_email_sent":{"type":"boolean","description":"A flag indicating if the SKU merge email was sent.","enum":[true,false],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.is_sku_merge_email_sent","typeLabel":"enum\u003cboolean>"},"lots":{"type":"array","description":"The item lot associated with the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLotRef","type":"object","description":"A reference to `DeliveryItemLot` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLot"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.lots.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.lots.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.lots.items.[INDEX]","typeLabel":"DeliveryItemLotRef · object"},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.lots","typeLabel":"DeliveryItemLotRef · object[]"},"locations":{"type":"array","description":"The location assigned to the delivery item.","readOnly":true,"items":{"title":"DeliveryItemLocationRef","type":"object","description":"A reference to `DeliveryItemLocation` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryItemLocation"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.locations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.locations.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.locations.items.[INDEX]","typeLabel":"DeliveryItemLocationRef · object"},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.locations","typeLabel":"DeliveryItemLocationRef · object[]"},"exceptions":{"type":"array","description":"An array of exceptions for the delivery item.","readOnly":true,"items":{"title":"DeliveryExceptionRef","type":"object","description":"A reference to `DeliveryException` object.","properties":{"type":{"type":"string","readOnly":true,"enum":["DeliveryException"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.exceptions.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.exceptions.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.exceptions.items.[INDEX]","typeLabel":"DeliveryExceptionRef · object"},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item.exceptions","typeLabel":"DeliveryExceptionRef · object[]"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].delivery_item","typeLabel":"DeliveryItem · object"},"status":{"type":"string","description":"The status of the delivery at the time the history event was added.","readOnly":true,"enum":["new","accepting","accepted","ready_to_process","processing","processing_exception","processed","putting_away","put_away","complete","canceled","void"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"exception":{"type":"object","description":"The processing exception of the container in the delivery.","properties":{"type":{"type":"string","enum":["Exception"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].exception.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal id property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].exception.id","typeLabel":"integer"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].exception","typeLabel":"object"},"exception_status":{"type":"string","description":"The status of the processing exception.","enum":["new","pending","approved","rejected","void"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].exception_status","typeLabel":"enum\u003cstring>"},"comment":{"type":"string","description":"An optional description for the history event which can be added programatically.","readOnly":true,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].comment","typeLabel":"string"},"requester":{"oneOf":[{"type":"object","title":"RequesterRef","description":"The requester attributed to the delivery's status history update.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Requester"],"example":"Requester","description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].requester.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].requester.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].requester.oneOf.0","typeLabel":"RequesterRef · object"},{"type":"null","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].requester.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].requester","typeLabel":"RequesterRef · object | null"},"created_at":{"type":"string","description":"The date and time the object was created in RFC 3339 section 5.6 notation.","format":"date-time","example":"2017-07-21T17:32:28Z","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"package":{"type":"object","description":"The package associated with the delivery.","properties":{"type":{"type":"string","enum":["Package"],"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].package.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].package.id","typeLabel":"integer"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX].package","typeLabel":"object"}},"uniqueKey":"included.DeliveryStatusHistory.items.[INDEX]","typeLabel":"DeliveryStatusHistory · object"},"uniqueKey":"included.DeliveryStatusHistory","typeLabel":"DeliveryStatusHistory · object[]"},"Lot":{"type":"array","items":{"oneOf":[{"title":"Lot","type":"object","description":"The Lot records the time some inventory was originated (first received or\notherwise created) and optionally a lot number and expiration date and may affect the order in which\ninventory is \"burned\" depending on the `LotType`.","properties":{"type":{"type":"string","enum":["Lot"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","uniqueKey":"included.Lot.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","example":54,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"included.Lot.items.[INDEX].oneOf.0.id","typeLabel":"integer"}},"uniqueKey":"included.Lot.items.[INDEX].oneOf.0","typeLabel":"Lot · object"},{"title":"Lot","type":"null","description":"The Lot records the time some inventory was originated (first received or\notherwise created) and optionally a lot number and expiration date and may affect the order in which\ninventory is \"burned\" depending on the `LotType`.","properties":{"type":{"type":"string","enum":["Lot"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body."},"id":{"type":"integer","example":54,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup."}},"uniqueKey":"included.Lot.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Lot.items.[INDEX]","typeLabel":"Lot · object | null"},"uniqueKey":"included.Lot","typeLabel":"(Lot · object | null)[]"},"Merchant":{"type":"array","items":{"title":"Merchant","type":"object","description":"A `Merchant` represents an entity that owns a distinct pool of inventory and line of business.","properties":{"type":{"type":"string","enum":["Merchant"],"readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","readOnly":true,"example":4,"uniqueKey":"included.Merchant.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"code":{"type":"string","description":"Merchant code may only contain letters (a-z), numbers (0-9) or underscore(_), the first character must be a letter.","minLength":1,"maxLength":32,"example":"acme_inc","uniqueKey":"included.Merchant.items.[INDEX].code","typeLabel":"string"},"name":{"type":"string","description":"Any string which uniquely identifies a Merchant.","minLength":1,"maxLength":64,"example":"ACME Inc.","uniqueKey":"included.Merchant.items.[INDEX].name","typeLabel":"string"},"status":{"oneOf":[{"type":"string","enum":["active","inactive","suspended","archived"],"default":"active","description":"Lifecycle status of the Merchant:\n- `active`: Merchant is operational and available for use\n- `suspended`: Temporarily on hold, can be easily reactivated\n- `inactive`: Long-term offline status, reactivation is possible but may require additional steps\n- `archived`: Soft delete status, manual recovery required","example":"active","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].status.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["active","inactive","suspended","archived"],"default":"active","description":"Lifecycle status of the Merchant:\n- `active`: Merchant is operational and available for use\n- `suspended`: Temporarily on hold, can be easily reactivated\n- `inactive`: Long-term offline status, reactivation is possible but may require additional steps\n- `archived`: Soft delete status, manual recovery required","example":"active","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].status.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Merchant.items.[INDEX].status","typeLabel":"enum\u003cstring> | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Merchant.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Merchant.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"},"brands":{"type":"array","items":{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].brands.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].brands.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Merchant.items.[INDEX].brands.items.[INDEX]","typeLabel":"BrandRef · object"},"description":"A merchant must have one or more brands which may share the same pool of inventory. Brands can be used for\ncustomizing presentation and behaviors and often correspond to distinct lines of business or market presences.\\\n `Optional Field`","readOnly":true,"uniqueKey":"included.Merchant.items.[INDEX].brands","typeLabel":"BrandRef · object[]"},"default_brand":{"type":"object","title":"BrandRef","description":"This is the primary brand used when defining only the merchant for operations such as creating a new product.\\\n `Optional Field`","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].default_brand.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].default_brand.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Merchant.items.[INDEX].default_brand","typeLabel":"BrandRef · object"},"custom_fields":{"oneOf":[{"type":"object","description":"Custom fields associated with the merchant in script format. Each field contains\na code and value, with additional properties depending on the field type.\\\n `Optional Field`","example":{"is_gift":{"value":true},"order_details":{"value":"test details"},"department":{"id":3,"label":"Shipping"},"priority_levels":[{"id":1,"label":"Urgent"},{"id":2,"label":"High"}],"cost_of_goods":{"amount":156.99,"currency":"USD"},"assigned_user":{"value":42}},"additionalProperties":{"oneOf":[{"type":"object","description":"Union type for all possible custom field value formats.","required":["value"],"properties":{"value":{"oneOf":[{"type":"boolean","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.1","typeLabel":"string"},{"type":"number","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.2","typeLabel":"number"},{"type":"integer","description":"The field value. Type varies based on field configuration.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value.oneOf.3","typeLabel":"integer"}],"isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0.value","typeLabel":"boolean | string | number | integer"}},"additionalProperties":false,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","title":"Monetary","description":"Union type for all possible custom field value formats.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.1.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.1.currency","typeLabel":"string"}},"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.1","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"Union type for all possible custom field value formats.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.2","typeLabel":"null"},{"type":"object","description":"Union type for all possible custom field value formats.","required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.3.id","typeLabel":"integer"},"label":{"type":"string","description":"The display label for the selected option.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.3.label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.3","typeLabel":"object"},{"type":"array","items":{"type":"object","description":"A selected option for select type fields.","required":["id","label"],"properties":{"id":{"type":"integer","description":"The option ID.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].id","typeLabel":"integer"},"label":{"type":"string","description":"The display label for the selected option.","isRequired":true,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX].label","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4.items.[INDEX]","typeLabel":"object"},"description":"Union type for all possible custom field value formats.","uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties.oneOf.4","typeLabel":"object[]"}],"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0.additionalProperties","typeLabel":"object · Monetary · object · null · object · object[]"},"uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"included.Merchant.items.[INDEX].custom_fields.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Merchant.items.[INDEX].custom_fields","typeLabel":"object | null"}},"uniqueKey":"included.Merchant.items.[INDEX]","typeLabel":"Merchant · object"},"uniqueKey":"included.Merchant","typeLabel":"Merchant · object[]"},"Product":{"type":"array","items":{"oneOf":[{"type":"object","title":"Product","description":"A Product contains information about a sellable item.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.id","typeLabel":"integer"},"vendor_sku":{"oneOf":[{"type":"string","description":"For informational use only. Displayed during delivery processing to help match products.\\\n `Optional Field`","example":"Vendor-SKU-1AD2","uniqueKey":"included.Product.items.[INDEX].oneOf.0.vendor_sku.oneOf.0","typeLabel":"string"},{"type":"null","description":"For informational use only. Displayed during delivery processing to help match products.\\\n `Optional Field`","example":"Vendor-SKU-1AD2","uniqueKey":"included.Product.items.[INDEX].oneOf.0.vendor_sku.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.vendor_sku","typeLabel":"string | null"},"manufacturer_part_number":{"oneOf":[{"type":"string","description":"The manufacturer's part number for the item. May be required for customs on shipments to EU countries.\\\n `Optional Field`","example":"MPN-1AD2","uniqueKey":"included.Product.items.[INDEX].oneOf.0.manufacturer_part_number.oneOf.0","typeLabel":"string"},{"type":"null","description":"The manufacturer's part number for the item. May be required for customs on shipments to EU countries.\\\n `Optional Field`","example":"MPN-1AD2","uniqueKey":"included.Product.items.[INDEX].oneOf.0.manufacturer_part_number.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.manufacturer_part_number","typeLabel":"string | null"},"external_id":{"oneOf":[{"type":"string","example":"11-993-9048","description":"May be used for external product sync.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.external_id.oneOf.0","typeLabel":"string"},{"type":"null","example":"11-993-9048","description":"May be used for external product sync.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.external_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.external_id","typeLabel":"string | null"},"barcodes":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.0.barcodes.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"A comma separated list of unique packaging feature barcodes.","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.barcodes.oneOf.0","typeLabel":"string[]"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.barcodes.oneOf.1","typeLabel":"null"},{"type":"string","description":"A comma separated list of unique packaging feature barcodes.","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.0.barcodes.oneOf.2","typeLabel":"string"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.0.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.barcodes","typeLabel":"string[] · null · string · null"},"goods_type":{"oneOf":[{"type":"string","enum":["NORMAL","ORM_D","LIMITED_QUANTITIES_COMMODITIES","HAZMAT",null],"description":"This defines the regulations, if any, assigned to a `Product`.\n- `NORMAL` Not Regulated\n- `ORM_D` ORM-D\n- `LIMITED_QUANTITIES_COMMODITIES` Limited Quantities: Consumer Commodity\n- `HAZMAT` Regulated","uniqueKey":"included.Product.items.[INDEX].oneOf.0.goods_type.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["NORMAL","ORM_D","LIMITED_QUANTITIES_COMMODITIES","HAZMAT",null],"description":"This defines the regulations, if any, assigned to a `Product`.\n- `NORMAL` Not Regulated\n- `ORM_D` ORM-D\n- `LIMITED_QUANTITIES_COMMODITIES` Limited Quantities: Consumer Commodity\n- `HAZMAT` Regulated","uniqueKey":"included.Product.items.[INDEX].oneOf.0.goods_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.goods_type","typeLabel":"enum\u003cstring> | null"},"is_available":{"type":"boolean","enum":[true,false],"default":true,"description":"This flag must be `true` to allow the `Product` to be ordered.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.is_available","typeLabel":"enum\u003cboolean>"},"is_visible":{"type":"boolean","enum":[true,false],"default":true,"description":"This flag must be `true` to show the `Product` in the inventory feed.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.is_visible","typeLabel":"enum\u003cboolean>"},"lot_type":{"oneOf":[{"type":"object","title":"LotTypeRef","description":"This `LotType` determines how a `Product` should be \"burned\" and whether lots with dissimilar data\ncan be \"mixed\".\\\n `Optional Field`","required":["type","id"],"properties":{"type":{"type":"string","enum":["LotType"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.lot_type.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int64","description":"The internal `id` property used as a path parameter in a resource lookup.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.lot_type.oneOf.0.id","typeLabel":"integer\u003cint64>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.lot_type.oneOf.0","typeLabel":"LotTypeRef · object"},{"type":"null","uniqueKey":"included.Product.items.[INDEX].oneOf.0.lot_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.lot_type","typeLabel":"LotTypeRef · object | null"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"This object defines the weight of the `Product` in imperial or metric units.\\\n `Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"This object defines the weight of the `Product` in imperial or metric units.\\\n `Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.weight","typeLabel":"Weight · object | null"},"dimensions":{"oneOf":[{"type":"object","title":"Dimensions","description":"This object defines the length, width, and height of the `Product` in imperial or metric units.\\\n `Optional Field`","properties":{"length":{"type":"number","description":"This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.","format":"float","example":8,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions.oneOf.0.length","typeLabel":"number\u003cfloat>"},"width":{"type":"number","description":"This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":6,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions.oneOf.0.width","typeLabel":"number\u003cfloat>"},"height":{"type":"number","description":"This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":4,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions.oneOf.0.height","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions.oneOf.0","typeLabel":"Dimensions · object"},{"type":"null","title":"Dimensions","description":"This object defines the length, width, and height of the `Product` in imperial or metric units.\\\n `Optional Field`","properties":{"length":{"type":"number","description":"This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.","format":"float","example":8},"width":{"type":"number","description":"This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":6},"height":{"type":"number","description":"This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":4},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.dimensions","typeLabel":"Dimensions · object | null"},"volume":{"oneOf":[{"type":"object","title":"Volume","description":"This object defines the cubic size of the `Product` in imperial or metric units.\\\n `Optional Field`","properties":{"value":{"type":"number","description":"This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.","format":"float","example":300,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.volume.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement as a cubic value.","enum":["in^3","mm^3","cm^3","m^3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.volume.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.volume.oneOf.0","typeLabel":"Volume · object"},{"type":"null","title":"Volume","description":"This object defines the cubic size of the `Product` in imperial or metric units.\\\n `Optional Field`","properties":{"value":{"type":"number","description":"This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.","format":"float","example":300},"unit":{"type":"string","description":"The imperical or metric unit of measurement as a cubic value.","enum":["in^3","mm^3","cm^3","m^3"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.volume.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.volume","typeLabel":"Volume · object | null"},"inventory":{"type":"object","title":"Inventory","description":"This object describes how the `Product` Stock is defined, such as real config values, or Virtual Inventory, and how to handle Backorders.\\\n `Optional Field`","properties":{"backorders":{"oneOf":[{"type":"boolean","description":"This determines if `Product` that is no longer in stock may be backordered or whether or not to use ShipStream's scoped configurations.","example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.backorders.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"This determines if `Product` that is no longer in stock may be backordered or whether or not to use ShipStream's scoped configurations.","enum":["use_config"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.backorders.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.backorders","typeLabel":"boolean | enum\u003cstring>"},"dynamic_allocation":{"oneOf":[{"type":"boolean","description":"This will allow the `Product` to source from inventory in other warehouses in real-time if enabled, and can be set to use ShipStream's scoped configurations.","example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.dynamic_allocation.oneOf.0","typeLabel":"boolean"},{"type":"string","description":"This will allow the `Product` to source from inventory in other warehouses in real-time if enabled, and can be set to use ShipStream's scoped configurations.","enum":["use_config"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.dynamic_allocation.oneOf.1","typeLabel":"enum\u003cstring>"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.dynamic_allocation","typeLabel":"boolean | enum\u003cstring>"},"virtual_inventory":{"type":"string","description":"This is the method used to predict an esitmate of inventory available when kitting from the `Product`.","enum":["none","optimistic","realistic","pessimistic"],"example":"optimistic","uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory.virtual_inventory","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.inventory","typeLabel":"Inventory · object"},"export":{"type":"object","title":"Export","description":"This object contains fields for describing and codifying an internationally exportable `Product`.\\\n `Optional Field`","properties":{"description":{"oneOf":[{"type":"string","description":"This is used to describe in detail the `Product` for international shipping and customs regulations.","example":"Plastic children's toy with steel weights and ball bearings","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.description.oneOf.0","typeLabel":"string"},{"type":"null","description":"This is used to describe in detail the `Product` for international shipping and customs regulations.","example":"Plastic children's toy with steel weights and ball bearings","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.description.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.description","typeLabel":"string | null"},"customs_value":{"oneOf":[{"type":"object","title":"Monetary","description":"The value of the products the purpose of calculating duties and taxes in the destination country.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.customs_value.oneOf.0.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.customs_value.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.customs_value.oneOf.0","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"The value of the products the purpose of calculating duties and taxes in the destination country.","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.customs_value.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.customs_value","typeLabel":"Monetary · object | null"},"country_of_manufacture":{"oneOf":[{"type":"string","description":"2 letters Country ISO Code","example":"TW","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.country_of_manufacture.oneOf.0","typeLabel":"string"},{"type":"null","description":"2 letters Country ISO Code","example":"TW","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.country_of_manufacture.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.country_of_manufacture","typeLabel":"string | null"},"hs_base_code":{"oneOf":[{"type":"string","description":"This is the Harmonized System Code (HS Code); a standardized numerical method of classifying traded products. These are 6 digit codes in the format \\#\\#\\#\\#.\\#\\# (e.g. 8471.30) which are associated with a standard HS Code Description, not including country-specific extensions.","example":"8518.30","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_base_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"This is the Harmonized System Code (HS Code); a standardized numerical method of classifying traded products. These are 6 digit codes in the format \\#\\#\\#\\#.\\#\\# (e.g. 8471.30) which are associated with a standard HS Code Description, not including country-specific extensions.","example":"8518.30","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_base_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_base_code","typeLabel":"string | null"},"hs_country_extension":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"country_id":{"type":"string","description":"This is the two-digit ISO (Alpha-2) country code.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_country_extension.oneOf.0.items.[INDEX].country_id","typeLabel":"string"},"extension":{"type":"string","description":"Country-specific extension to the 6-digit Harmonized System code. For imports into the United States this is the last 4 digits of the 10-digit HTS (Harmonized Tariff Schedule) code.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_country_extension.oneOf.0.items.[INDEX].extension","typeLabel":"string"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_country_extension.oneOf.0.items.[INDEX]","typeLabel":"object"},"example":[{"country_id":"TW","extension":"002"},{"country_id":"US","extension":"011"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_country_extension.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"country_id":{"type":"string","description":"This is the two-digit ISO (Alpha-2) country code."},"extension":{"type":"string","description":"Country-specific extension to the 6-digit Harmonized System code. For imports into the United States this is the last 4 digits of the 10-digit HTS (Harmonized Tariff Schedule) code."}}},"example":[{"country_id":"TW","extension":"002"},{"country_id":"US","extension":"011"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_country_extension.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export.hs_country_extension","typeLabel":"object[] | null"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.export","typeLabel":"Export · object"},"regulated_goods":{"type":"object","title":"RegulatedGoods","description":"This object only applies a `Product` using the \"Regulated\" Goods Type, and describes the `Regulation` and container specifications for the `Product`.\\\n `Optional Field`","properties":{"regulation":{"oneOf":[{"title":"Regulation","type":"object","description":"A reference to a `Regulation` by `id`.","properties":{"type":{"type":"string","enum":["Regulation"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.regulation.oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.regulation.oneOf.0.id","typeLabel":"integer"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.regulation.oneOf.0","typeLabel":"Regulation · object"},{"title":"Regulation","type":"null","description":"A reference to a `Regulation` by `id`.","properties":{"type":{"type":"string","enum":["Regulation"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup."}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.regulation.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.regulation","typeLabel":"Regulation · object | null"},"technical_name":{"oneOf":[{"type":"string","description":"Must match against Regulation's Technical Name Pattern if specified.","example":"Hydro Polymer Acetylene Coating","uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.technical_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Must match against Regulation's Technical Name Pattern if specified.","example":"Hydro Polymer Acetylene Coating","uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.technical_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.technical_name","typeLabel":"string | null"},"additional_information":{"oneOf":[{"type":"string","description":"Must match against Regulation's Additional Regulatory Information Pattern if specified.","example":"Flamable Liquid","uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.additional_information.oneOf.0","typeLabel":"string"},{"type":"null","description":"Must match against Regulation's Additional Regulatory Information Pattern if specified.","example":"Flamable Liquid","uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.additional_information.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.additional_information","typeLabel":"string | null"},"net_weight":{"oneOf":[{"title":"Weight","type":"object","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.net_weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.net_weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.net_weight.oneOf.0","typeLabel":"Weight · object"},{"title":"Weight","type":"null","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.net_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.net_weight","typeLabel":"Weight · object | null"},"container_type":{"oneOf":[{"type":"string","description":"The Overpack Container Type can be a combination of material and container type such as Aluminum Box, Steel Drum, or a combination of a material and container type from these two lists:\n - `Material:` Aluminum, Fiberboard, Glass, Plywood, Plastic, Steel, Wood\n - `Container:` Bag, Bottle, Box, Bucket, Cylinder, Drum, Jerrican, Pail","example":"Plastic Box","uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.container_type.oneOf.0","typeLabel":"string"},{"type":"null","description":"The Overpack Container Type can be a combination of material and container type such as Aluminum Box, Steel Drum, or a combination of a material and container type from these two lists:\n - `Material:` Aluminum, Fiberboard, Glass, Plywood, Plastic, Steel, Wood\n - `Container:` Bag, Bottle, Box, Bucket, Cylinder, Drum, Jerrican, Pail","example":"Plastic Box","uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.container_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.container_type","typeLabel":"string | null"},"container_meets_hazmat_specs":{"type":"boolean","description":"This flag indicates that the `RegulatedGoods` container is sufficient for a regulated (HAZMAT) product.","example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.container_meets_hazmat_specs","typeLabel":"boolean"},"regulation_units":{"type":"number","description":"These units are arbitrary and should be relative to the Regulation's Pickup Weight Limit. E.g. it could be in pounds, kilowatt/hours, etc.","format":"float","example":5,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods.regulation_units","typeLabel":"number\u003cfloat>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.regulated_goods","typeLabel":"RegulatedGoods · object"},"packaging":{"type":"object","title":"Packaging","description":"This object defines how the shipping container/box for the `Product` is to be processed and whether there are any special instructions during packing.\\\n `Optional Field`","properties":{"require_packaging":{"type":"boolean","description":"If Yes, packaging will require a Box with \"Satisfies Overbox: Yes\".","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.require_packaging","typeLabel":"enum\u003cboolean>"},"require_weight_check":{"type":"boolean","description":"If Yes, the associated product will require the use of a scale to verify that the package's weight falls within the expected amount. If this is set to No, this step will be skipped by the packer.","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.require_weight_check","typeLabel":"enum\u003cboolean>"},"require_confirmation_per_item":{"type":"boolean","description":"If Yes, Packaging Products with \"One Scan Per: Item\" will require a scan for each item packed rather than just one for the first item in a package.","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.require_confirmation_per_item","typeLabel":"enum\u003cboolean>"},"unit_quantity":{"oneOf":[{"type":"integer","example":1,"description":"Number of individually packaged items contained therein for purposes of special packaging features.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.unit_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","example":1,"description":"Number of individually packaged items contained therein for purposes of special packaging features.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.unit_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.unit_quantity","typeLabel":"integer | null"},"bulk_quantity":{"oneOf":[{"type":"integer","example":10,"description":"Prefer to split into packages when necessary using multiples of this amount.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.bulk_quantity.oneOf.0","typeLabel":"integer"},{"type":"null","example":10,"description":"Prefer to split into packages when necessary using multiples of this amount.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.bulk_quantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.bulk_quantity","typeLabel":"integer | null"},"max_per_package":{"oneOf":[{"type":"integer","example":15,"description":"The maximum quantity of this product to ever include in the same package. \nMultiply by \"Unit Quantity\" to achieve common units between other products with the same \"Ship Separate Tag\" value.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.max_per_package.oneOf.0","typeLabel":"integer"},{"type":"null","example":15,"description":"The maximum quantity of this product to ever include in the same package. \nMultiply by \"Unit Quantity\" to achieve common units between other products with the same \"Ship Separate Tag\" value.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.max_per_package.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.max_per_package","typeLabel":"integer | null"},"is_ship_separately":{"type":"boolean","description":"This item cannot ship in the same package as other items (unless they have the same \"Ship Separate Tag\").","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.is_ship_separately","typeLabel":"enum\u003cboolean>"},"ship_separately_tag":{"oneOf":[{"type":"string","description":"Applies only if \"Ship Separate\" is \"Yes\". Assign the same tag to treat similar products as interchangeable \nwith respect to the \"Ship Separate\" and \"Max Per Package\" attribute.","example":"PVC","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.ship_separately_tag.oneOf.0","typeLabel":"string"},{"type":"null","description":"Applies only if \"Ship Separate\" is \"Yes\". Assign the same tag to treat similar products as interchangeable \nwith respect to the \"Ship Separate\" and \"Max Per Package\" attribute.","example":"PVC","uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.ship_separately_tag.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.ship_separately_tag","typeLabel":"string | null"},"can_tip":{"type":"boolean","description":"If Yes, the item is allowed to be rotated vertically when packed.","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.can_tip","typeLabel":"enum\u003cboolean>"},"can_contain_other_items":{"type":"boolean","description":"If Yes then other smaller items are allowed to be placed within this larger item. This is useful when the item is hollow or is a bin/bucket.","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.can_contain_other_items","typeLabel":"enum\u003cboolean>"},"is_handling_surcharge":{"type":"boolean","description":"The Packaging Surcharge is applicable when shipped without an Overbox.","enum":[true,false],"example":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging.is_handling_surcharge","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.packaging","typeLabel":"Packaging · object"},"custom_fields":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"The custom field code/identifier.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields.items.[INDEX].code","typeLabel":"string"},"value":{"description":"The field value (type depends on field configuration).","uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields.items.[INDEX].value","typeLabel":"any"},"label":{"type":"string","description":"For select fields, the display label of the selected option.","uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields.items.[INDEX].label","typeLabel":"string"},"options":{"type":"object","description":"For multiselect fields, a map of option IDs to labels.","additionalProperties":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields.items.[INDEX].options.additionalProperties","typeLabel":"string"},"uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields.items.[INDEX].options","typeLabel":"object"}},"required":["code"],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields.items.[INDEX]","typeLabel":"object"},"description":"This will set any Product Attributes, pre-defined by the user, for the `Product`.\\\n `Optional Field`","example":[{"code":"color","value":13,"label":"Red and Black"},{"code":"cost_of_goods","value":41.32},{"code":"allow_mailer","value":true}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.custom_fields","typeLabel":"object[]"},"sku":{"type":"string","description":"The Stock Keeping Unit (SKU) is a unique identifier for the `Product`.","example":"SKU-1AD","uniqueKey":"included.Product.items.[INDEX].oneOf.0.sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.Product.items.[INDEX].oneOf.0.name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.is_enabled","typeLabel":"enum\u003cboolean>"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which the product belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.merchant","typeLabel":"MerchantRef · object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.0.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.0.updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.0","typeLabel":"Product · object"},{"type":"object","title":"PackagingContainer","description":"A reference to the `PackagingContainer` object linked with Warehouse Inventory Location.","properties":{"type":{"type":"string","enum":["PackagingContainer"],"description":"This property describes the type of object in the response body.","uniqueKey":"included.Product.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.id","typeLabel":"integer"},"container_options":{"type":"object","properties":{"barcodes":{"oneOf":[{"type":"string","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.barcodes.oneOf.0","typeLabel":"string"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.barcodes.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.barcodes.oneOf.2","typeLabel":"string[]"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.barcodes","typeLabel":"string · null · string[] · null"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"The weight of the container when packed with the shipment items.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"The weight of the container when packed with the shipment items.","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight","typeLabel":"Weight · object | null"},"dimensions":{"oneOf":[{"type":"object","title":"Dimensions","description":"The dimensions of the container in imperial or metric units.","properties":{"length":{"type":"number","description":"This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.","format":"float","example":8,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions.oneOf.0.length","typeLabel":"number\u003cfloat>"},"width":{"type":"number","description":"This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":6,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions.oneOf.0.width","typeLabel":"number\u003cfloat>"},"height":{"type":"number","description":"This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":4,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions.oneOf.0.height","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions.oneOf.0","typeLabel":"Dimensions · object"},{"type":"null","title":"Dimensions","description":"The dimensions of the container in imperial or metric units.","properties":{"length":{"type":"number","description":"This distance value is usually assigned to the longest side of the object and is defined as a floating-point number up to 4 decimal places.","format":"float","example":8},"width":{"type":"number","description":"This value describes the horizontal distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":6},"height":{"type":"number","description":"This value describes the vertical distance of the subject defined as a floating-point number up to 4 decimal places.","format":"float","example":4},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.dimensions","typeLabel":"Dimensions · object | null"},"volume":{"oneOf":[{"type":"object","title":"Volume","description":"The total volume of the container in imperial or metric units.","properties":{"value":{"type":"number","description":"This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.","format":"float","example":300,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.volume.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement as a cubic value.","enum":["in^3","mm^3","cm^3","m^3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.volume.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.volume.oneOf.0","typeLabel":"Volume · object"},{"type":"null","title":"Volume","description":"The total volume of the container in imperial or metric units.","properties":{"value":{"type":"number","description":"This value describes the cubic size of the subject as a floating-point number up to 4 decimal places.","format":"float","example":300},"unit":{"type":"string","description":"The imperical or metric unit of measurement as a cubic value.","enum":["in^3","mm^3","cm^3","m^3"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.volume.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.volume","typeLabel":"Volume · object | null"},"manage_stock":{"type":"boolean","description":"This flag indicates whether or not to adjust the inventory quantity of the packaging feature with each use. If `true` then the inventory levels will decrease with each use. If `no` then the inventory will not adjust with each use.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.manage_stock","typeLabel":"enum\u003cboolean>"},"associated_products":{"type":"array","description":"A list of products with this packaging feature selected in its \"Other Special Features\" option in the product's \"Packaging\" tab.","items":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.associated_products.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.associated_products","typeLabel":"ProductRef · object[]"},"allow_for_brands":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected merchants/brands.","items":{"oneOf":[{"type":"object","title":"MerchantRef","description":"Reference a `Merchant` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX].oneOf.0","typeLabel":"MerchantRef · object"},{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_brands","typeLabel":"(MerchantRef · object | BrandRef · object)[]"},"disallow_for_brands":{"type":"array","description":"If specified, this packaging feature will not be applicable to the selected merchants/brands.","items":{"oneOf":[{"type":"object","title":"MerchantRef","description":"Reference a `Merchant` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX].oneOf.0","typeLabel":"MerchantRef · object"},{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.disallow_for_brands","typeLabel":"(MerchantRef · object | BrandRef · object)[]"},"billing_amount":{"oneOf":[{"type":"object","title":"Monetary","description":"The amount that will be billable for consumption of one unit of this packaging feature.\\\n `Optional Field`","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.billing_amount.oneOf.0.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.billing_amount.oneOf.0","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"The amount that will be billable for consumption of one unit of this packaging feature.\\\n `Optional Field`","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.billing_amount","typeLabel":"Monetary · object | null"},"allow_for_warehouses":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected warehouses.","items":{"oneOf":[{"title":"WarehouseRef","type":"object","description":"A reference to a `Warehouse` by `id`.","properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_warehouses.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_warehouses.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_warehouses.items.[INDEX].oneOf.0","typeLabel":"WarehouseRef · object"},{"title":"WarehouseRef","type":"null","description":"A reference to a `Warehouse` by `id`.","properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_warehouses.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_warehouses.items.[INDEX]","typeLabel":"WarehouseRef · object | null"},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_warehouses","typeLabel":"(WarehouseRef · object | null)[]"},"allow_for_shipping_methods":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.","items":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_shipping_methods.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.allow_for_shipping_methods","typeLabel":"string[]"},"satisfies_overbox":{"type":"boolean","description":"Will be a valid container for products which have `Requires Overbox: Yes`.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.satisfies_overbox","typeLabel":"enum\u003cboolean>"},"use_for_bin_packing":{"type":"string","description":"Containers with \"Use for Bin Packing: No\" will not be used by packing solution providers.","enum":["yes","no","fallback"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.use_for_bin_packing","typeLabel":"enum\u003cstring>"},"weight_capacity":{"oneOf":[{"type":"object","title":"Weight","description":"Maximum allowed weight of the container, including tare weight.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight_capacity.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight_capacity.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight_capacity.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"Maximum allowed weight of the container, including tare weight.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight_capacity.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.weight_capacity","typeLabel":"Weight · object | null"},"container_style":{"type":"string","description":"Specify the container type. Currently, only \"Rigid Box\" is supported.","enum":["rigid_box"],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.container_style","typeLabel":"enum\u003cstring>"},"packaging_handling_surcharge":{"type":"boolean","description":"The Packaging Surcharge is applicable for this packaging feature (e.g. cylindrical, non-fiberboard material, protrusions, non-conveyable, etc.)","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options.packaging_handling_surcharge","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1.container_options","typeLabel":"object"},"sku":{"type":"string","description":"The Stock Keeping Unit (SKU) is a unique identifier for the `Product`.","example":"SKU-1AD","uniqueKey":"included.Product.items.[INDEX].oneOf.1.sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.Product.items.[INDEX].oneOf.1.name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.is_enabled","typeLabel":"enum\u003cboolean>"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which the product belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.merchant","typeLabel":"MerchantRef · object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.1.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.1.updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.1","typeLabel":"PackagingContainer · object"},{"type":"object","title":"PackagingSupplies","description":"A reference to the `PackagingSupplies` object linked with Warehouse Inventory Location.","properties":{"type":{"type":"string","enum":["PackagingSupplies"],"description":"This property describes the type of object in the response body.","uniqueKey":"included.Product.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.id","typeLabel":"integer"},"supplies_options":{"type":"object","properties":{"barcodes":{"oneOf":[{"type":"string","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.barcodes.oneOf.0","typeLabel":"string"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.barcodes.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.barcodes.oneOf.2","typeLabel":"string[]"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.barcodes","typeLabel":"string · null · string[] · null"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"The weight of the infill.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"The weight of the infill.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.weight","typeLabel":"Weight · object | null"},"manage_stock":{"type":"boolean","description":"This flag indicates whether or not to adjust the inventory quantity of the packaging feature with each use. If `true` then the inventory levels will decrease with each use. If `no` then the inventory will not adjust with each use.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.manage_stock","typeLabel":"enum\u003cboolean>"},"associated_products":{"type":"array","description":"A list of products with this packaging feature selected in its \"Other Special Features\" option in the product's \"Packaging\" tab.","items":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.associated_products.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.associated_products","typeLabel":"ProductRef · object[]"},"allow_for_brands":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected merchants/brands.","items":{"oneOf":[{"type":"object","title":"MerchantRef","description":"Reference a `Merchant` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX].oneOf.0","typeLabel":"MerchantRef · object"},{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_brands","typeLabel":"(MerchantRef · object | BrandRef · object)[]"},"disallow_for_brands":{"type":"array","description":"If specified, this packaging feature will not be applicable to the selected merchants/brands.","items":{"oneOf":[{"type":"object","title":"MerchantRef","description":"Reference a `Merchant` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX].oneOf.0","typeLabel":"MerchantRef · object"},{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disallow_for_brands","typeLabel":"(MerchantRef · object | BrandRef · object)[]"},"billing_amount":{"oneOf":[{"type":"object","title":"Monetary","description":"The amount that will be billable for consumption of one unit of this packaging feature.\\\n `Optional Field`","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.billing_amount.oneOf.0.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.billing_amount.oneOf.0","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"The amount that will be billable for consumption of one unit of this packaging feature.\\\n `Optional Field`","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.billing_amount","typeLabel":"Monetary · object | null"},"allow_for_warehouses":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected warehouses.","items":{"oneOf":[{"title":"WarehouseRef","type":"object","description":"A reference to a `Warehouse` by `id`.","properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_warehouses.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_warehouses.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_warehouses.items.[INDEX].oneOf.0","typeLabel":"WarehouseRef · object"},{"title":"WarehouseRef","type":"null","description":"A reference to a `Warehouse` by `id`.","properties":{"type":{"type":"string","enum":["Warehouse"],"description":"This property describes the type of object in the response body."},"id":{"type":"integer","format":"int32","description":"The internal `id` property used as a path parameter in a resource lookup."}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_warehouses.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_warehouses.items.[INDEX]","typeLabel":"WarehouseRef · object | null"},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_warehouses","typeLabel":"(WarehouseRef · object | null)[]"},"allow_for_shipping_methods":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected carriers/shipping methods.","items":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_shipping_methods.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.allow_for_shipping_methods","typeLabel":"string[]"},"packaging_handling_surcharge":{"type":"boolean","description":"The Packaging Surcharge is applicable for this packaging feature (e.g. cylindrical, non-fiberboard material, protrusions, non-conveyable, etc.)","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.packaging_handling_surcharge","typeLabel":"enum\u003cboolean>"},"apply_to_goods_type":{"type":"string","enum":["any","NORMAL","ORM_D"],"description":"This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.\n- `NORMAL` Not Regulated\n- `ORM_D` ORM-D\n`Optional Field`","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_to_goods_type","typeLabel":"enum\u003cstring>"},"never_apply_to_goods_type":{"type":"string","enum":["NORMAL","LIMITED_QUANTITIES_COMMODITIES","HAZMAT"],"description":"This packaging feature will be applied to all shipments which do not contain an item with this Goods Type.\n- `NORMAL` Not Regulated\n- `LIMITED_QUANTITIES_COMMODITIES` Limited Quantities: Consumer Commodity\n- `HAZMAT` Regulated\n`Optional Field`","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.never_apply_to_goods_type","typeLabel":"enum\u003cstring>"},"apply_only_above_weight":{"oneOf":[{"type":"object","title":"Weight","description":"If specified, this packaging supply is not a requirement for packages under the given weight when \"Always/Never Apply to Goods Type\" is specified.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_only_above_weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_only_above_weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_only_above_weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"If specified, this packaging supply is not a requirement for packages under the given weight when \"Always/Never Apply to Goods Type\" is specified.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_only_above_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_only_above_weight","typeLabel":"Weight · object | null"},"one_per":{"type":"string","description":"The expected number of scans per shipment. The product \"Unit Quantity\" is used as a multiplier for \"One Scan Per: Each\".","enum":["order","package","item","each"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.one_per","typeLabel":"enum\u003cstring>"},"require_scan_timing":{"type":"string","description":"Choose how the scan timer should begin recording time data on this product or packaging feature.","enum":["after_product_scan|on_full","on_start"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.require_scan_timing","typeLabel":"enum\u003cstring>"},"disable_confirm_button":{"type":"boolean","description":"If \"No\", the user will be able to tap \"Confirm\" rather than scanning a barcode.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.disable_confirm_button","typeLabel":"enum\u003cboolean>"},"require_packaging_type":{"type":"string","description":"If specified, this packaging feature will only be applicable when the container meets the chosen criteria based on the container's \"Satisfies Overbox\" attribute when \"Always/Never Apply to Goods Type\" is specified.","enum":["overbox","non_overbox"],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.require_packaging_type","typeLabel":"enum\u003cstring>"},"apply_to_region":{"type":"string","description":"Unless specified, this packaging feature will apply to all regions when \"Always/Never Apply to Goods Type\" is specified.","uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_to_region","typeLabel":"string"},"apply_unless_container_meets_hazmat":{"type":"boolean","description":"If \"Yes\", this packaging product will be applicable unless a package contains a DG item with \"Container Meets Hazmat Specs: Yes\" when \"Always/Never Apply to Goods Type\" is specified.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_unless_container_meets_hazmat","typeLabel":"enum\u003cboolean>"},"apply_to_multi_sku_package":{"type":"boolean","description":"If \"Yes\", this packaging product will only be applied to packages containing more than one SKU when \"Always/Never Apply to Goods Type\" is specified.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options.apply_to_multi_sku_package","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2.supplies_options","typeLabel":"object"},"sku":{"type":"string","description":"The Stock Keeping Unit (SKU) is a unique identifier for the `Product`.","example":"SKU-1AD","uniqueKey":"included.Product.items.[INDEX].oneOf.2.sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.Product.items.[INDEX].oneOf.2.name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.is_enabled","typeLabel":"enum\u003cboolean>"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which the product belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.merchant","typeLabel":"MerchantRef · object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.2.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.2.updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.2","typeLabel":"PackagingSupplies · object"},{"type":"object","title":"PackagingInfill","description":"A reference to the `PackagingInfill` object linked with Warehouse Inventory Location.","properties":{"type":{"type":"string","enum":["PackagingInfill"],"description":"This property describes the type of object in the response body.","uniqueKey":"included.Product.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.id","typeLabel":"integer"},"infill_options":{"type":"object","properties":{"barcodes":{"oneOf":[{"type":"string","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.barcodes.oneOf.0","typeLabel":"string"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":"956623520-4","uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.barcodes.oneOf.2.items.[INDEX]","typeLabel":"string"},"description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.barcodes.oneOf.2","typeLabel":"string[]"},{"type":"null","description":"A comma separated list of unique packaging feature barcodes.\\\n `Optional Field`","example":["956623520-4","O-VS-Oregano-p3"],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.barcodes","typeLabel":"string · null · string[] · null"},"weight":{"oneOf":[{"type":"object","title":"Weight","description":"The weight of the infill.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.weight.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"The weight of the infill.\n`Optional Field`","properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.weight","typeLabel":"Weight · object | null"},"manage_stock":{"type":"boolean","description":"This flag indicates whether or not to adjust the inventory quantity of the packaging feature with each use. If `true` then the inventory levels will decrease with each use. If `no` then the inventory will not adjust with each use.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.manage_stock","typeLabel":"enum\u003cboolean>"},"associated_products":{"type":"array","description":"A list of products with this packaging feature selected in its \"Other Special Features\" option in the product's \"Packaging\" tab.","items":{"title":"ProductRef","type":"object","description":"A reference to a `Product` object by `id`.","properties":{"type":{"type":"string","enum":["Product"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.associated_products.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.associated_products","typeLabel":"ProductRef · object[]"},"allow_for_brands":{"type":"array","description":"If specified, this packaging feature will only be applicable to the selected merchants/brands.","items":{"oneOf":[{"type":"object","title":"MerchantRef","description":"Reference a `Merchant` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX].oneOf.0","typeLabel":"MerchantRef · object"},{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.allow_for_brands","typeLabel":"(MerchantRef · object | BrandRef · object)[]"},"disallow_for_brands":{"type":"array","description":"If specified, this packaging feature will not be applicable to the selected merchants/brands.","items":{"oneOf":[{"type":"object","title":"MerchantRef","description":"Reference a `Merchant` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX].oneOf.0","typeLabel":"MerchantRef · object"},{"type":"object","title":"BrandRef","description":"Reference a `Brand` by `id`.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Brand"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","description":"The numeric `id` of a particular resource being updated.","example":4,"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disallow_for_brands","typeLabel":"(MerchantRef · object | BrandRef · object)[]"},"billing_amount":{"oneOf":[{"type":"object","title":"Monetary","description":"The amount that will be billable for consumption of one unit of this packaging feature.\\\n `Optional Field`","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.billing_amount.oneOf.0.amount","typeLabel":"number\u003cfloat>"},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD","uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.billing_amount.oneOf.0","typeLabel":"Monetary · object"},{"type":"null","title":"Monetary","description":"The amount that will be billable for consumption of one unit of this packaging feature.\\\n `Optional Field`","properties":{"amount":{"type":"number","description":"This is the monetary value..","format":"float","example":99},"currency":{"type":"string","description":"An ISO 3166-1 alpha-3 currency code.","example":"USD"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.billing_amount","typeLabel":"Monetary · object | null"},"disable_confirm_button":{"type":"boolean","description":"If \"No\", the user will be able to tap \"Confirm\" rather than scanning a barcode.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.disable_confirm_button","typeLabel":"enum\u003cboolean>"},"apply_unless_container_meets_hazmat":{"type":"boolean","description":"If \"Yes\", this packaging product will be applicable unless a package contains a DG item with \"Container Meets Hazmat Specs: Yes\" when \"Always/Never Apply to Goods Type\" is specified.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.apply_unless_container_meets_hazmat","typeLabel":"enum\u003cboolean>"},"is_confirmation_required":{"type":"boolean","description":"If \"Yes\", this packer will be prompted and required to confirm the use of infill.","enum":[true,false],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.is_confirmation_required","typeLabel":"enum\u003cboolean>"},"infill_horizontal":{"oneOf":[{"type":"object","title":"Length","description":"The amount of space to reserve on each horizontal side of the package for infill. \\\n`Optional Field`","properties":{"value":{"type":"number","description":"This value describes the length of the object as a floating-point number up to 4 decimal places.","format":"float","example":12,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_horizontal.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_horizontal.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_horizontal.oneOf.0","typeLabel":"Length · object"},{"type":"null","title":"Length","description":"The amount of space to reserve on each horizontal side of the package for infill. \\\n`Optional Field`","properties":{"value":{"type":"number","description":"This value describes the length of the object as a floating-point number up to 4 decimal places.","format":"float","example":12},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_horizontal.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_horizontal","typeLabel":"Length · object | null"},"infill_vertical":{"oneOf":[{"type":"object","title":"Length","description":"The amount of space to reserve on each vertical side of the package for infill.\n`Optional Field`","properties":{"value":{"type":"number","description":"This value describes the length of the object as a floating-point number up to 4 decimal places.","format":"float","example":12,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_vertical.oneOf.0.value","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_vertical.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_vertical.oneOf.0","typeLabel":"Length · object"},{"type":"null","title":"Length","description":"The amount of space to reserve on each vertical side of the package for infill.\n`Optional Field`","properties":{"value":{"type":"number","description":"This value describes the length of the object as a floating-point number up to 4 decimal places.","format":"float","example":12},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"]}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_vertical.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_vertical","typeLabel":"Length · object | null"},"infill_priority":{"type":"integer","description":"If multiple infill types are prescribed for a mix of items, the infill with the lowest Infill Priority number will prevail.","uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options.infill_priority","typeLabel":"integer"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3.infill_options","typeLabel":"object"},"sku":{"type":"string","description":"The Stock Keeping Unit (SKU) is a unique identifier for the `Product`.","example":"SKU-1AD","uniqueKey":"included.Product.items.[INDEX].oneOf.3.sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.Product.items.[INDEX].oneOf.3.name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.is_enabled","typeLabel":"enum\u003cboolean>"},"merchant":{"type":"object","title":"MerchantRef","description":"The `Merchant` to which the product belongs.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Merchant"],"isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.merchant.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":4,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.merchant","typeLabel":"MerchantRef · object"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.\\\n `Optional Field`","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The date and time the object was last updated in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.Product.items.[INDEX].oneOf.3.updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Product.items.[INDEX].oneOf.3.updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.Product.items.[INDEX].oneOf.3","typeLabel":"PackagingInfill · object"}],"uniqueKey":"included.Product.items.[INDEX]","typeLabel":"Product · object | PackagingContainer · object | PackagingSupplies · object | PackagingInfill · object"},"uniqueKey":"included.Product","typeLabel":"(Product · object | PackagingContainer · object | PackagingSupplies · object | PackagingInfill · object)[]"},"Requester":{"type":"array","items":{"title":"Requester","type":"object","description":"A `Requester` represents the entity (user, API token, integration, script, background job, etc.)\nthat performed an action in the system. The `entity_type` indicates the kind of entity and\n`entity_id` is the ID of that entity in its respective table. A `BackgroundJob` (a scheduled or\nqueued system job) has no table of its own: its `entity_id` is a fixed job number and `name`\nnames the job.","properties":{"type":{"type":"string","enum":["Requester"],"description":"The resource type (always \"Requester\").","isRequired":true,"uniqueKey":"included.Requester.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal requester ID (`requester_id`).","isRequired":true,"uniqueKey":"included.Requester.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"entity_type":{"type":"string","enum":["OrganizationUser","ClientUser","MerchantAPI","GlobalAPI","MerchantIntegration","GlobalIntegration","Script","Other","BackgroundJob"],"description":"The type of entity that performed the action.","isRequired":true,"uniqueKey":"included.Requester.items.[INDEX].entity_type","typeLabel":"enum\u003cstring>"},"entity_id":{"type":"integer","format":"int32","example":5,"description":"The ID of the entity in its respective table (e.g., user ID, integration ID).","isRequired":true,"uniqueKey":"included.Requester.items.[INDEX].entity_id","typeLabel":"integer\u003cint32>"},"name":{"type":"string","maxLength":255,"example":"Bernard Greensmith","description":"Human-readable display name for the requester.","uniqueKey":"included.Requester.items.[INDEX].name","typeLabel":"string"},"status":{"type":"string","enum":["active","inactive","suspended","deleted","unknown"],"description":"The current status of the requester entity.","uniqueKey":"included.Requester.items.[INDEX].status","typeLabel":"enum\u003cstring>"}},"required":["type","id","entity_type","entity_id"],"additionalProperties":false,"uniqueKey":"included.Requester.items.[INDEX]","typeLabel":"Requester · object"},"uniqueKey":"included.Requester","typeLabel":"Requester · object[]"},"Warehouse":{"type":"array","items":{"title":"Warehouse","type":"object","description":"A `Warehouse` represents a physical location from which you can store inventory and perform operations independently of other warehouses.","properties":{"type":{"type":"string","enum":["Warehouse"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Warehouse.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int32","example":3,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","isRequired":true,"uniqueKey":"included.Warehouse.items.[INDEX].id","typeLabel":"integer\u003cint32>"},"name":{"type":"string","example":"East Coast 1","maxLength":255,"description":"The display name for the `Warehouse`.","uniqueKey":"included.Warehouse.items.[INDEX].name","typeLabel":"string"},"abbreviation":{"oneOf":[{"type":"string","maxLength":10,"example":"EC1","description":"A short abbreviation for the `Warehouse`, up to 10 characters. Recommended to be fewer than 6 characters.\\\n `Optional Field`","uniqueKey":"included.Warehouse.items.[INDEX].abbreviation.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":10,"example":"EC1","description":"A short abbreviation for the `Warehouse`, up to 10 characters. Recommended to be fewer than 6 characters.\\\n `Optional Field`","uniqueKey":"included.Warehouse.items.[INDEX].abbreviation.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Warehouse.items.[INDEX].abbreviation","typeLabel":"string | null"},"is_active":{"type":"boolean","example":true,"description":"This flag determines if the `Warehouse` is active and viable for fulfillment.","uniqueKey":"included.Warehouse.items.[INDEX].is_active","typeLabel":"boolean"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.Warehouse.items.[INDEX]","typeLabel":"Warehouse · object"},"uniqueKey":"included.Warehouse","typeLabel":"Warehouse · object[]"}},"uniqueKey":"included","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"resource":{"type":"ASN","warehouse":{"type":"Warehouse","id":123},"id":123,"supplier_name":"\u003cstring>","expected_at":"2019-12-03T21:06:26Z","merchant_reference":"\u003cstring>","supplier_invoice_reference":"\u003cstring>","supplier_order_reference":"\u003cstring>","shipment_type":"international_maritime_freight","bill_of_lading":"\u003cstring>","standard_carrier_alpha_code":"\u003cstring>","merchant":{"type":"Merchant","id":4},"increment_id":"11000020","state":"new","status":"new","progress_percent":50,"carrier_name":"\u003cstring>","delivered_at":"2019-12-03T21:06:26Z","receive_by":"2019-12-03T21:06:26Z","processed_at":"2019-12-03T21:06:26Z","putaway_at":"2019-12-03T21:06:26Z","completed_at":"2019-12-03T21:06:26Z","ready_to_process_at":"2019-12-03T21:06:26Z","merchant_status":"\u003cstring>","item_count":123,"container_count":123,"label_count":123,"exception_count":123,"processing_comments":"\u003cstring>","special_requirements":["\u003cstring>"],"is_auto_commit":true,"created_at":"2017-07-21T17:32:28Z","updated_at":"2017-07-21T17:39:43Z","tracking_numbers":["\u003cstring>"],"status_history":[{"delivery_item":{"type":"DeliveryItem","id":3,"product":{"type":"Product","id":3},"quantity":123,"qty_expected":123,"qty_received":123,"qty_shortage":123,"qty_overage":123,"qty_processed":123,"qty_putaway":123,"qty_committed":123,"qty_returned":123,"is_sku_merge_email_sent":true,"lots":[{"type":"DeliveryItemLot","id":3}],"locations":[{"type":"DeliveryItemLocation","id":3}],"exceptions":[{"type":"DeliveryException","id":3}]},"status":"new","exception":{"type":"Exception","id":123},"exception_status":"new","comment":"\u003cstring>","requester":{"type":"Requester","id":3},"created_at":"2017-07-21T17:32:28Z","package":{"type":"Package","id":123}}],"items":[{"type":"DeliveryItem","id":3,"product":{"type":"Product","id":3},"quantity":123,"qty_expected":123,"qty_received":123,"qty_shortage":123,"qty_overage":123,"qty_processed":123,"qty_putaway":123,"qty_committed":123,"qty_returned":123,"is_sku_merge_email_sent":true,"lots":[{"type":"DeliveryItemLot","id":3}],"locations":[{"type":"DeliveryItemLocation","id":3}],"exceptions":[{"type":"DeliveryException","id":3}]}]},"included":{"DeliveryContainer":[{"type":"DeliveryContainer","id":3,"container_type":{"type":"DeliveryContainerType","id":3,"merchant":{"type":"Merchant","id":4},"delivery_type":"asn","name":"\u003cstring>","name_plural":"\u003cstring>","weight":{"value":20,"unit":"lb"},"is_default":true,"is_system":true},"damage_type":"none","weight_discrepancy_reason":"none","tare_weight":{"value":20,"unit":"lb"},"weight":{"value":20,"unit":"lb"},"weighed_at":"2019-12-03T21:06:26Z","weighed_by":{"type":"OrganizationUser","id":3},"contents":[{"delivery_item":{"type":"DeliveryItem","id":123},"qty_counted":123,"qty_shortage":123,"qty_counted_per_lot":[{"lot":{"type":"Lot","id":54},"quantity":123}]}],"condition_note":"\u003cstring>","item_count":123}],"DeliveryContainerType":[{"type":"DeliveryContainerType","id":3,"merchant":{"type":"Merchant","id":4},"delivery_type":"asn","name":"\u003cstring>","name_plural":"\u003cstring>","weight":{"value":20,"unit":"lb"},"is_default":true,"is_system":true}],"DeliveryException":[{"type":"DeliveryException","id":3,"container":{"type":"DeliveryContainer","id":3},"lot":{"type":"Lot","id":54},"status":"new","sign":-1,"reason":"\u003cstring>","comment":"\u003cstring>","quantity":123}],"DeliveryItem":[{"type":"DeliveryItem","id":3,"product":{"type":"Product","id":3},"quantity":123,"qty_expected":123,"qty_received":123,"qty_shortage":123,"qty_overage":123,"qty_processed":123,"qty_putaway":123,"qty_committed":123,"qty_returned":123,"is_sku_merge_email_sent":true,"lots":[{"type":"DeliveryItemLot","id":3}],"locations":[{"type":"DeliveryItemLocation","id":3}],"exceptions":[{"type":"DeliveryException","id":3}]}],"DeliveryItemLocation":[{"type":"DeliveryItemLocation","id":3,"location":{"type":"Location","id":42},"qty_putaway":123,"qty_committed":123}],"DeliveryItemLot":[{"type":"DeliveryItemLot","id":3,"lot":{"type":"Lot","id":54},"qty_counted":123,"qty_putaway":123}],"DeliveryStatusHistory":[{"delivery_item":{"type":"DeliveryItem","id":3,"product":{"type":"Product","id":3},"quantity":123,"qty_expected":123,"qty_received":123,"qty_shortage":123,"qty_overage":123,"qty_processed":123,"qty_putaway":123,"qty_committed":123,"qty_returned":123,"is_sku_merge_email_sent":true,"lots":[{"type":"DeliveryItemLot","id":3}],"locations":[{"type":"DeliveryItemLocation","id":3}],"exceptions":[{"type":"DeliveryException","id":3}]},"status":"new","exception":{"type":"Exception","id":123},"exception_status":"new","comment":"\u003cstring>","requester":{"type":"Requester","id":3},"created_at":"2017-07-21T17:32:28Z","package":{"type":"Package","id":123}}],"Lot":[{"type":"Lot","id":54}],"Merchant":[{"type":"Merchant","id":4,"code":"acme_inc","name":"ACME Inc.","status":"active","created_at":"2017-07-21T17:32:28Z","updated_at":"2017-07-21T17:39:43Z","brands":[{"type":"Brand","id":4}],"default_brand":{"type":"Brand","id":4},"custom_fields":{"is_gift":{"value":true},"order_details":{"value":"test details"},"department":{"id":3,"label":"Shipping"},"priority_levels":[{"id":1,"label":"Urgent"},{"id":2,"label":"High"}],"cost_of_goods":{"amount":156.99,"currency":"USD"},"assigned_user":{"value":42}}}],"Product":[{"type":"Product","id":123,"vendor_sku":"Vendor-SKU-1AD2","manufacturer_part_number":"MPN-1AD2","external_id":"11-993-9048","barcodes":["956623520-4","O-VS-Oregano-p3"],"goods_type":"NORMAL","is_available":true,"is_visible":true,"lot_type":{"type":"LotType","id":4},"weight":{"value":20,"unit":"lb"},"dimensions":{"length":8,"width":6,"height":4,"unit":"in"},"volume":{"value":300,"unit":"in^3"},"inventory":{"backorders":true,"dynamic_allocation":true,"virtual_inventory":"optimistic"},"export":{"description":"Plastic children's toy with steel weights and ball bearings","customs_value":{"amount":99,"currency":"USD"},"country_of_manufacture":"TW","hs_base_code":"8518.30","hs_country_extension":[{"country_id":"TW","extension":"002"},{"country_id":"US","extension":"011"}]},"regulated_goods":{"regulation":{"type":"Regulation","id":123},"technical_name":"Hydro Polymer Acetylene Coating","additional_information":"Flamable Liquid","net_weight":{"value":20,"unit":"lb"},"container_type":"Plastic Box","container_meets_hazmat_specs":true,"regulation_units":5},"packaging":{"require_packaging":true,"require_weight_check":true,"require_confirmation_per_item":true,"unit_quantity":1,"bulk_quantity":10,"max_per_package":15,"is_ship_separately":true,"ship_separately_tag":"PVC","can_tip":true,"can_contain_other_items":true,"is_handling_surcharge":true},"custom_fields":[{"code":"color","value":13,"label":"Red and Black"},{"code":"cost_of_goods","value":41.32},{"code":"allow_mailer","value":true}],"sku":"SKU-1AD","name":"Test Product","is_enabled":true,"merchant":{"type":"Merchant","id":4},"created_at":"2017-07-21T17:32:28Z","updated_at":"2017-07-21T17:39:43Z"}],"Requester":[{"type":"Requester","id":3,"entity_type":"OrganizationUser","entity_id":5,"name":"Bernard Greensmith","status":"active"}],"Warehouse":[{"type":"Warehouse","id":3,"name":"East Coast 1","abbreviation":"EC1","is_active":true}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6b52a24a-c585-48ed-a0ec-b56fdc0f65d0":{"description":"The request was invalid. The client must change the request. See the response body for more details.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["parser","parameters","openapi"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"parameters","message":"The supplied parameters are invalid."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"parameters","message":"The supplied parameters are invalid."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"eee82d95-5a0f-478c-a339-8179a73a7d4d":{"description":"The requested resource was not found. It may have been deleted, it may have never existed, or you may not have permission to view it.","content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"The error type code.","enum":["not_found"],"uniqueKey":"errors.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"An English sentence describing the error type.","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"details":{"type":"array","description":"An array of objects describing which keys are responsible for the error and detailed messages describing why they are not valid.","items":{"type":"object","properties":{"key":{"type":"string","description":"The path to the key which relates to the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].key","typeLabel":"string"},"message":{"type":"string","description":"An English sentence describing the details of the error.","uniqueKey":"errors.items.[INDEX].details.items.[INDEX].message","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX].details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"errors.items.[INDEX].details","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"errors.items.[INDEX]","typeLabel":"object"},"minItems":1,"uniqueKey":"errors","typeLabel":"object[]"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"errors":[{"type":"not_found","message":"The server could not find the requested resource."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"not_found","message":"The server could not find the requested resource."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"0bdf9654-2d23-4db9-90b7-cac770b9610a":{"description":"Internal Server Error - Something wrong happened at server side. Contact server administrator for more details.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"cdd0ed69-efb4-45cc-8b4d-1bf2ea905a01":{"ShipStream_bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with \"Bearer\" and then a single space.","scopes":[],"schemeName":"ShipStream_bearerAuth"}}},"servers":{"c54ede43-9c1a-41e5-bd59-dd40a08d5ddf":{"url":"https://{base_url_domain}/api/global","description":"Direct API Url","variables":{"base_url_domain":{"default":"example.shipstream.app","description":"The fully qualified domain name for your ShipStream WMS instance. This is either a custom domain, or a subdomain of shipstream.app,\nand will be the same as the domain name for the page which you use to login to ShipStream WMS."}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with \"Bearer\" and then a single space.","scopes":[],"schemeName":"ShipStream_bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Generate a JWT access token through a Custom Global Integration and provide it with each request in the `Authorization` header prefixed with \"Bearer\" and then a single space.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ShipStream_bearerAuth","name":"Authorization"}],"title":"ShipStream_bearerAuth"}]},"originalFileLocation":"global-api/openapi.json"},"subdomain":"shipstream","siteName":"ShipStream Developer Center","title":"Get one Delivery - ShipStream Developer Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-19T16:24:03.340Z","originalFileLocation":"global-api/endpoint/v1/receiving/{type}/{id}/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns a single ASN, RMA, or Other object specified by its type \u0026amp; id path parameters.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get one Delivery - ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single ASN, RMA, or Other object specified by its type \u0026amp; id path parameters.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/{type}/{id}/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://shipstream.mintlify.app/_mintlify/api/og/v2?division=Deliveries\u0026amp;title=Get+one+Delivery\u0026amp;description=Returns+a+single+%60ASN%60%2C+%60RMA%60%2C+or+%60Other%60+object+specified+by+its+%60type%60+%26+%60id%60+path+parameters.\u0026amp;theme=e93d60d32d376022e10e26fa\u0026amp;signature=6a1ecad581d935ee41a6200cf41de5cdd2e68b684999afa7e957865458f7e2eb\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get one Delivery - ShipStream Developer Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single ASN, RMA, or Other object specified by its type \u0026amp; id path parameters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shipstream.mintlify.app/_mintlify/api/og/v2?division=Deliveries\u0026amp;title=Get+one+Delivery\u0026amp;description=Returns+a+single+%60ASN%60%2C+%60RMA%60%2C+or+%60Other%60+object+specified+by+its+%60type%60+%26+%60id%60+path+parameters.\u0026amp;theme=e93d60d32d376022e10e26fa\u0026amp;signature=6a1ecad581d935ee41a6200cf41de5cdd2e68b684999afa7e957865458f7e2eb\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/shipstream/S5kcQpKDCwTV9qDy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ShipStream Developer Center\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2a81c4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/{type}/{id}/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.shipstream.io/#organization\",\"name\":\"ShipStream Developer Center\",\"url\":\"https://docs.shipstream.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/shipstream/qd77w5Du5LxXOgdH/logo/light.svg?fit=max\u0026auto=format\u0026n=qd77w5Du5LxXOgdH\u0026q=85\u0026s=a0df5ad1d65033e45435fe663a71e67e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.shipstream.io#website\",\"name\":\"ShipStream Developer Center\",\"url\":\"https://docs.shipstream.io\",\"publisher\":{\"@id\":\"https://docs.shipstream.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get#webpage\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get\",\"name\":\"Get one Delivery\",\"description\":\"Returns a single ASN, RMA, or Other object specified by its type \u0026 id path parameters.\",\"dateModified\":\"2026-02-19T16:24:03.340Z\",\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Receiving API v1\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Deliveries\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get one Delivery\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get#apireference\",\"headline\":\"Get one Delivery\",\"name\":\"Get one Delivery\",\"description\":\"Returns a single ASN, RMA, or Other object specified by its type \u0026 id path parameters.\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/receiving/%7Btype%7D/%7Bid%7D/get#webpage\"},\"dateModified\":\"2026-02-19T16:24:03.340Z\",\"publisher\":{\"@id\":\"https://docs.shipstream.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ShipStream Developer Center\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"ShipStream Developer Center","nav":{"global":{"anchors":[{"anchor":"Knowledge Base","icon":"book-open-cover","href":"https://help.shipstream.io"},{"anchor":"Release Notes","icon":"newspaper","href":"https://help.shipstream.io/article/fzz2g8rxhs-release-notes-overview"},{"anchor":"Warehouse Designer","icon":"compass","href":"https://flow.shipstream.io"}]},"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/home"}]},{"tab":"Global API Reference","groups":[{"group":"Get Started","pages":[{"title":"Introduction","mode":"wide","href":"/global-api/introduction"},{"title":"Authentication","href":"/global-api/authentication"},{"title":"Versions","href":"/global-api/versions"}]},{"group":"Common Features","pages":[{"title":"Paging Parameters","href":"/global-api/paging-parameters"},{"title":"Sorting Syntax","href":"/global-api/sorting-syntax"},{"title":"Filtering Syntax","href":"/global-api/filtering-syntax"},{"title":"Selecting Fields","href":"/global-api/selecting-fields"},{"title":"Response Codes and Errors","href":"/global-api/response-codes-errors"}]},{"group":"Inventory API v1","pages":[{"group":"Warehouses","pages":[{"title":"List all Warehouses","openapi":"GET /v1/inventory/warehouses","href":"/global-api/endpoint/v1/inventory/warehouses/get"},{"title":"Create Warehouse","openapi":"POST /v1/inventory/warehouses","href":"/global-api/endpoint/v1/inventory/warehouses/post"},{"title":"Get one Warehouse","openapi":"GET /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/get"},{"title":"Update Warehouse","openapi":"PUT /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/put"},{"title":"Delete Warehouse","openapi":"DELETE /v1/inventory/warehouses/{id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/delete"}]},{"group":"Locations","pages":[{"title":"List all Locations","openapi":"GET /v1/inventory/warehouses/{id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/get"},{"title":"Create Location","openapi":"POST /v1/inventory/warehouses/{id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/post"},{"title":"Get one Location","openapi":"GET /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/get"},{"title":"Update Location","openapi":"PUT /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/put"},{"title":"Delete Location","openapi":"DELETE /v1/inventory/warehouses/{id}/locations/{location_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/{location_id}/delete"},{"title":"Get Location by Label","openapi":"GET /v1/inventory/warehouses/{id}/locationsByLabel/{label}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get"},{"title":"Batch update Locations","openapi":"POST /v1/inventory/warehouses/{id}/locations/batch","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/batch/post"},{"title":"Batch Update Location Tags","openapi":"POST /v1/inventory/warehouses/{id}/locations/tags","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locations/tags/post"}]},{"group":"Location Tags","pages":[{"title":"List Location Tags","openapi":"GET /v1/inventory/location-tags","href":"/global-api/endpoint/v1/inventory/location-tags/get"},{"title":"Create Location Tag","openapi":"POST /v1/inventory/location-tags","href":"/global-api/endpoint/v1/inventory/location-tags/post"},{"title":"Get one Location Tag","openapi":"GET /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/get"},{"title":"Update Location Tag","openapi":"PUT /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/put"},{"title":"Delete Location Tag","openapi":"DELETE /v1/inventory/location-tags/{id}","href":"/global-api/endpoint/v1/inventory/location-tags/{id}/delete"}]},{"group":"Slot Types","pages":[{"title":"List Slot Types","openapi":"GET /v1/inventory/slot-types","href":"/global-api/endpoint/v1/inventory/slot-types/get"},{"title":"Create Slot Type","openapi":"POST /v1/inventory/slot-types","href":"/global-api/endpoint/v1/inventory/slot-types/post"},{"title":"Get one Slot Type","openapi":"GET /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/get"},{"title":"Update Slot Type","openapi":"PUT /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/put"},{"title":"Delete Slot Type","openapi":"DELETE /v1/inventory/slot-types/{id}","href":"/global-api/endpoint/v1/inventory/slot-types/{id}/delete"}]},{"group":"Location Profiles","pages":[{"title":"List Location Profiles","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/get"},{"title":"Create Location Profile","openapi":"POST /v1/inventory/warehouses/{id}/location-profiles","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/post"},{"title":"Get Location Profile","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/get"},{"title":"Update Location Profile","openapi":"PUT /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/put"},{"title":"Delete Location Profile","openapi":"DELETE /v1/inventory/warehouses/{id}/location-profiles/{profile_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/delete"},{"title":"List Location Profile member Locations","openapi":"GET /v1/inventory/warehouses/{id}/location-profiles/{profile_id}/locations","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/locations/get"},{"title":"Rebuild Location Profile","openapi":"POST /v1/inventory/warehouses/{id}/location-profiles/{profile_id}/rebuild","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/location-profiles/{profile_id}/rebuild/post"}]},{"group":"Products","pages":[{"title":"List all Products and Packaging","openapi":"GET /v1/inventory/products/{type}","href":"/global-api/endpoint/v1/inventory/products/{type}/get"},{"title":"Get Product or Packaging","openapi":"GET /v1/inventory/products/{type}/{id}","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/get"},{"title":"Update Product or Packaging","openapi":"PUT /v1/inventory/products/{type}/{id}","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/put"},{"title":"Create Product or Packaging","openapi":"POST /v1/inventory/products","href":"/global-api/endpoint/v1/inventory/products/post"},{"title":"Get Product Classifications","openapi":"GET /v1/inventory/products/{type}/{id}/classifications","href":"/global-api/endpoint/v1/inventory/products/{type}/{id}/classifications/get"}]},{"group":"Product Profiles","pages":[{"title":"Editing Product Profile Conditions","href":"/global-api/product-profile-conditions"},{"title":"List Product Profiles","openapi":"GET /v1/inventory/product-profiles","href":"/global-api/endpoint/v1/inventory/product-profiles/get"},{"title":"Create Product Profile","openapi":"POST /v1/inventory/product-profiles","href":"/global-api/endpoint/v1/inventory/product-profiles/post"},{"title":"List Product Profile condition fields","openapi":"GET /v1/inventory/product-profiles/condition-fields","href":"/global-api/endpoint/v1/inventory/product-profiles/condition-fields/get"},{"title":"Get Product Profile by code","openapi":"GET /v1/inventory/product-profiles/by-code/{code}","href":"/global-api/endpoint/v1/inventory/product-profiles/by-code/{code}/get"},{"title":"Get Product Profile","openapi":"GET /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/get"},{"title":"Update Product Profile","openapi":"PUT /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/put"},{"title":"Delete Product Profile","openapi":"DELETE /v1/inventory/product-profiles/{id}","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/delete"},{"title":"List Product Profile member Products","openapi":"GET /v1/inventory/product-profiles/{id}/products","href":"/global-api/endpoint/v1/inventory/product-profiles/{id}/products/get"},{"title":"List Product condition values","openapi":"GET /v1/inventory/product-condition-values","href":"/global-api/endpoint/v1/inventory/product-condition-values/get"}]},{"group":"Handling Classes","pages":[{"title":"Editing Handling Class Conditions","href":"/global-api/handling-class-conditions"},{"title":"List Handling Classes","openapi":"GET /v1/inventory/handling-classes","href":"/global-api/endpoint/v1/inventory/handling-classes/get"},{"title":"Create Handling Class","openapi":"POST /v1/inventory/handling-classes","href":"/global-api/endpoint/v1/inventory/handling-classes/post"},{"title":"List Handling Class condition fields","openapi":"GET /v1/inventory/handling-classes/condition-fields","href":"/global-api/endpoint/v1/inventory/handling-classes/condition-fields/get"},{"title":"Get Handling Class by code","openapi":"GET /v1/inventory/handling-classes/by-code/{code}","href":"/global-api/endpoint/v1/inventory/handling-classes/by-code/{code}/get"},{"title":"Get Handling Class","openapi":"GET /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/get"},{"title":"Update Handling Class","openapi":"PUT /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/put"},{"title":"Delete Handling Class","openapi":"DELETE /v1/inventory/handling-classes/{id}","href":"/global-api/endpoint/v1/inventory/handling-classes/{id}/delete"}]},{"group":"Slotting Rules","pages":[{"title":"List Slotting Rule Sets","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/get"},{"title":"Create Slotting Rule Set","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/post"},{"title":"Get Slotting Rule Set","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/get"},{"title":"Update Slotting Rule Set","openapi":"PUT /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/put"},{"title":"Delete Slotting Rule Set","openapi":"DELETE /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/delete"},{"title":"Duplicate Slotting Rule Set","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/duplicate","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/duplicate/post"},{"title":"List Slotting Rules","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/get"},{"title":"Create Slotting Rule","openapi":"POST /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/post"},{"title":"Get Slotting Rule","openapi":"GET /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/get"},{"title":"Update Slotting Rule","openapi":"PUT /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/put"},{"title":"Delete Slotting Rule","openapi":"DELETE /v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-rule-sets/{rule_set_id}/rules/{rule_id}/delete"},{"title":"List Slotting Conflicts","openapi":"GET /v1/inventory/warehouses/{id}/slotting-conflicts","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/slotting-conflicts/get"}]},{"group":"Replenishment","pages":[{"title":"List Policies","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/get"},{"title":"Create Policy","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-policies","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/post"},{"title":"List Policy Options","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies/options","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/options/get"},{"title":"Get Policy","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/get"},{"title":"Update Policy","openapi":"PUT /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/put"},{"title":"Delete Policy","openapi":"DELETE /v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-policies/{policy_id}/delete"},{"title":"List Report Rows","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-report","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-report/get"},{"title":"Get Replenishment Index Status","openapi":"GET /v1/inventory/warehouses/{id}/replenishment-index/status","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-index/status/get"},{"title":"Rebuild Replenishment Index","openapi":"POST /v1/inventory/warehouses/{id}/replenishment-index/rebuild","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/replenishment-index/rebuild/post"}]},{"group":"Levels","pages":[{"title":"List total inventory levels","openapi":"GET /v1/inventory/levels/total","href":"/global-api/endpoint/v1/inventory/levels/total/get"},{"title":"List warehouse inventory levels","openapi":"GET /v1/inventory/levels/warehouse","href":"/global-api/endpoint/v1/inventory/levels/warehouse/get"}]},{"group":"HoldReasons","pages":[{"title":"List active hold reasons","openapi":"GET /v1/inventory/hold-reasons","href":"/global-api/endpoint/v1/inventory/hold-reasons/get"},{"title":"Create user-defined hold reason","openapi":"POST /v1/inventory/hold-reasons","href":"/global-api/endpoint/v1/inventory/hold-reasons/post"},{"title":"Update hold reason","openapi":"PUT /v1/inventory/hold-reasons/{id}","href":"/global-api/endpoint/v1/inventory/hold-reasons/{id}/put"},{"title":"Delete user-defined hold reason","openapi":"DELETE /v1/inventory/hold-reasons/{id}","href":"/global-api/endpoint/v1/inventory/hold-reasons/{id}/delete"}]},{"group":"Holds","pages":[{"title":"List / search inventory holds","openapi":"GET /v1/inventory/holds","href":"/global-api/endpoint/v1/inventory/holds/get"},{"title":"Get one Hold by ID","openapi":"GET /v1/inventory/holds/{id}","href":"/global-api/endpoint/v1/inventory/holds/{id}/get"},{"title":"Place location-level Hold","openapi":"POST /v1/inventory/holds/location","href":"/global-api/endpoint/v1/inventory/holds/location/post"},{"title":"Place lot-level Hold (with optional BOM cascade)","openapi":"POST /v1/inventory/holds/lot","href":"/global-api/endpoint/v1/inventory/holds/lot/post"},{"title":"Release one Hold by ID","openapi":"POST /v1/inventory/holds/{id}/release","href":"/global-api/endpoint/v1/inventory/holds/{id}/release/post"},{"title":"Release all active Holds on Lot","openapi":"POST /v1/inventory/holds/lot/{lot_id}/release","href":"/global-api/endpoint/v1/inventory/holds/lot/{lot_id}/release/post"}]}]},{"group":"Receiving API v1","pages":[{"group":"Deliveries","pages":[{"title":"List all Deliveries","openapi":"GET /v1/receiving/{type}","description":"Returns a list of `ASN`, `RMA`, or `Other` objects specified by the `type` path parameter.","href":"/global-api/endpoint/v1/receiving/{type}/get"},{"title":"Get one Delivery","openapi":"GET /v1/receiving/{type}/{id}","href":"/global-api/endpoint/v1/receiving/{type}/{id}/get"}]}]},{"group":"Shipping API v1","pages":[{"group":"Shipments","pages":[{"title":"List all Shipments","openapi":"GET /v1/shipping/shipments","description":"Returns a list of `Shipment` objects.","href":"/global-api/endpoint/v1/shipping/shipments/get"},{"title":"Get one Shipment","openapi":"GET /v1/shipping/shipments/{id}","href":"/global-api/endpoint/v1/shipping/shipments/{id}/get"},{"title":"Process Shipment","openapi":"POST /v1/shipping/shipments/{id}/process","href":"/global-api/endpoint/v1/shipping/shipments/{id}/process/post"},{"title":"Pick Shipment","openapi":"POST /v1/shipping/shipments/{id}/pick","href":"/global-api/endpoint/v1/shipping/shipments/{id}/pick/post"},{"title":"Pack Shipment","openapi":"POST /v1/shipping/shipments/{id}/pack","href":"/global-api/endpoint/v1/shipping/shipments/{id}/pack/post"},{"title":"Mark Shipment as Shipped","openapi":"POST /v1/shipping/shipments/{id}/shipped","href":"/global-api/endpoint/v1/shipping/shipments/{id}/shipped/post"},{"title":"Get Shipment Reservations","openapi":"GET /v1/shipping/shipments/{id}/reservations","href":"/global-api/endpoint/v1/shipping/shipments/{id}/reservations/get"}]},{"group":"Orders","pages":[{"title":"Mass update orders","openapi":"POST /v1/shipping/orders/massUpdate","href":"/global-api/endpoint/v1/shipping/orders/massUpdate/post"},{"title":"List all Orders","openapi":"GET /v1/shipping/orders","href":"/global-api/endpoint/v1/shipping/orders/get"},{"title":"Get one Order","openapi":"GET /v1/shipping/orders/{id}","href":"/global-api/endpoint/v1/shipping/orders/{id}/get"},{"title":"Method not allowed","openapi":"GET /v1/shipping/orders/massUpdate","href":"/global-api/endpoint/v1/shipping/orders/massUpdate/get"}]},{"group":"Retailers","pages":[{"title":"List all Retailers","openapi":"GET /v1/shipping/retailers","href":"/global-api/endpoint/v1/shipping/retailers/get"},{"title":"Create Retailer","openapi":"POST /v1/shipping/retailers","href":"/global-api/endpoint/v1/shipping/retailers/post"},{"title":"Get one Retailer","openapi":"GET /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/get"},{"title":"Update Retailer","openapi":"PUT /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/put"},{"title":"Delete Retailer","openapi":"DELETE /v1/shipping/retailers/{id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/delete"},{"title":"List Retailer Identifiers","openapi":"GET /v1/shipping/retailers/{id}/identifiers","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/get"},{"title":"Create Retailer Identifier","openapi":"POST /v1/shipping/retailers/{id}/identifiers","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/post"},{"title":"Get one Retailer Identifier","openapi":"GET /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/get"},{"title":"Update Retailer Identifier","openapi":"PUT /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/put"},{"title":"Delete Retailer Identifier","openapi":"DELETE /v1/shipping/retailers/{id}/identifiers/{identifier_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/identifiers/{identifier_id}/delete"},{"title":"List Retailer Ship-To Locations","openapi":"GET /v1/shipping/retailers/{id}/ship-to-locations","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/get"},{"title":"Create Retailer Ship-To Location","openapi":"POST /v1/shipping/retailers/{id}/ship-to-locations","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/post"},{"title":"Get one Retailer Ship-To Location","openapi":"GET /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/get"},{"title":"Update Retailer Ship-To Location","openapi":"PUT /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/put"},{"title":"Delete Retailer Ship-To Location","openapi":"DELETE /v1/shipping/retailers/{id}/ship-to-locations/{location_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/ship-to-locations/{location_id}/delete"},{"title":"List Retailer Routing Guides","openapi":"GET /v1/shipping/retailers/{id}/routing-guides","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/get"},{"title":"Create Retailer Routing Guide","openapi":"POST /v1/shipping/retailers/{id}/routing-guides","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/post"},{"title":"Get one Retailer Routing Guide","openapi":"GET /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/get"},{"title":"Update Retailer Routing Guide metadata","openapi":"PUT /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/put"},{"title":"Delete Retailer Routing Guide","openapi":"DELETE /v1/shipping/retailers/{id}/routing-guides/{guide_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/delete"},{"title":"Get Retailer Routing Guide file content","openapi":"GET /v1/shipping/retailers/{id}/routing-guides/{guide_id}/file","href":"/global-api/endpoint/v1/shipping/retailers/{id}/routing-guides/{guide_id}/file/get"},{"title":"List Retailer Merchant Settings","openapi":"GET /v1/shipping/retailers/{id}/merchant-settings","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/get"},{"title":"Create Retailer Merchant Setting","openapi":"POST /v1/shipping/retailers/{id}/merchant-settings","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/post"},{"title":"Get one Retailer Merchant Setting","openapi":"GET /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/get"},{"title":"Update Retailer Merchant Setting","openapi":"PUT /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/put"},{"title":"Delete Retailer Merchant Setting","openapi":"DELETE /v1/shipping/retailers/{id}/merchant-settings/{setting_id}","href":"/global-api/endpoint/v1/shipping/retailers/{id}/merchant-settings/{setting_id}/delete"}]}]},{"group":"System API v1","pages":[{"group":"Merchants","pages":[{"title":"List all Merchants","openapi":"GET /v1/system/merchants","href":"/global-api/endpoint/v1/system/merchants/get"}]},{"group":"Users","pages":[{"title":"List all Users","openapi":"GET /v1/system/users/{type}","href":"/global-api/endpoint/v1/system/users/{type}/get"},{"title":"Get one User","openapi":"GET /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/get"},{"title":"Update one User","openapi":"PUT /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/put"},{"title":"Delete User","openapi":"DELETE /v1/system/users/{type}/{id}","href":"/global-api/endpoint/v1/system/users/{type}/{id}/delete"}]},{"group":"User Roles","pages":[{"title":"List all User Roles","openapi":"GET /v1/system/userRoles/{type}","href":"/global-api/endpoint/v1/system/userRoles/{type}/get"},{"title":"Get one User Role","openapi":"GET /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/get"},{"title":"Update one User Role","openapi":"PUT /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/put"},{"title":"Delete User Role","openapi":"DELETE /v1/system/userRoles/{type}/{id}","href":"/global-api/endpoint/v1/system/userRoles/{type}/{id}/delete"}]},{"group":"Healthcheck","pages":[{"title":"Healthcheck","openapi":"GET /v1/system/status","href":"/global-api/endpoint/v1/system/status/get"}]}]}]},{"tab":"Merchant API Reference","pages":[{"title":"Merchant API Reference","href":"/merchant-api/introduction"}]}]},"title":"Get one Delivery - ShipStream Developer Center","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}