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.
The location's human-readable label and barcode value (without barcode prefix). Be sure to url-encode the
the value to avoid special characters being interpreted as not part of the label.
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.4021","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":{},"basePath":"","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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get","slug":"/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get","pageMetadata":{"title":"Get Location by Label","openapi":"GET /v1/inventory/warehouses/{id}/locationsByLabel/{label}","description":"Returns a single `Location` object specified by the warehouse `id` and location `label` path parameters.","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/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: \"Location\"\n }), \" object specified by the warehouse \", _jsx(_components.code, {\n children: \"id\"\n }), \" and location \", _jsx(_components.code, {\n children: \"label\"\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 Location by Label","openapi":"GET /v1/inventory/warehouses/{id}/locationsByLabel/{label}","description":"Returns a single `Location` object specified by the warehouse `id` and location `label` path parameters.","href":"/global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Get Location by Label","tags":["Locations"],"operationId":"getLocationByLabel","description":"Returns a single `Location` object specified by the warehouse `id` and location `label` path parameters.","parameters":["64a6df5f-4cce-428d-9d0e-f01eb70f7699","5e373032-2304-4e7a-9e08-bd1e7bd05523","568750e1-f7a7-48e8-bf35-33f283688553","a4ea4e1f-e1af-4764-876b-e940fc5f29ee","17bfcd42-5238-4c10-a55d-cc6807c91356","0223428a-5abd-4732-a39e-86862f79dd4b","8eccc7d4-5757-496b-bb5e-88a28b92c39c"],"responses":{"200":"2ad42c27-252f-4dca-9050-2937712e3591","400":"4b74aded-34fe-44a1-9fdb-c786c2a2c003","404":"c71d6731-600a-4f67-b7fd-496104f72fa8","422":"7ec44378-c4a2-4829-87b3-1927acaccab5","500":"cb8ec603-a010-4c29-bc7e-3a4b5ddb0332"},"method":"get","type":"path","servers":["c54ede43-9c1a-41e5-bd59-dd40a08d5ddf"],"security":["cdd0ed69-efb4-45cc-8b4d-1bf2ea905a01"],"path":"/v1/inventory/warehouses/{id}/locationsByLabel/{label}","baseUrlOptions":["https://{base_url_domain}/api/global"],"title":"Get Location by Label","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"64a6df5f-4cce-428d-9d0e-f01eb70f7699":{"name":"id","in":"path","schema":{"type":"integer","format":"int32","isRequired":true,"description":"The `id` of the referenced `Warehouse`.","uniqueKey":"","typeLabel":"integer\u003cint32>"},"required":true,"description":"The `id` of the referenced `Warehouse`."},"5e373032-2304-4e7a-9e08-bd1e7bd05523":{"name":"label","in":"path","schema":{"type":"string","isRequired":true,"description":"The location's human-readable label and barcode value (without barcode prefix). Be sure to url-encode the\nthe value to avoid special characters being interpreted as not part of the label.","uniqueKey":"","typeLabel":"string"},"required":true,"description":"The location's human-readable label and barcode value (without barcode prefix). Be sure to url-encode the\nthe value to avoid special characters being interpreted as not part of the label."},"568750e1-f7a7-48e8-bf35-33f283688553":{"name":"fields","in":"query","required":false,"description":"Specify additional fields of the `Location` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Location","description":"Specify additional fields of the `Location` object to be included in the response.","type":"array","items":{"type":"string","enum":["basic","all","label","priority","qty_on_hand","qty_putaway","qty_unreserved","qty_reserved","qty_locked","is_temp","is_pickable","is_type_auto","created_at","updated_at","last_cyclecount_at","tags","lot","product","rack","slot_type"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"a4ea4e1f-e1af-4764-876b-e940fc5f29ee":{"name":"fields:lot","in":"query","required":false,"description":"Specify additional fields of the `Lot` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Lot","description":"Specify additional fields of the `Lot` object to be included in the response.","type":"array","items":{"type":"string","enum":["basic","all","id","lot_number","origination_date","expiration_date","is_expired","is_active","lot_number_input","expiration_input","sort_value","days_until_expiration","sort_direction","group_value","created_at","updated_at","created_by","lot_type","product"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"17bfcd42-5238-4c10-a55d-cc6807c91356":{"name":"fields:product","in":"query","required":false,"description":"Specify additional fields of the `Product` or `Packaging*` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Product Or Packaging","description":"Specify additional fields of the `Product` or `Packaging*` object to be included in the response.","type":"array","items":{"type":"string","enum":["basic","all","created_at","updated_at","container_options","supplies_options","data_collection_options","instruction_options","infill_options","vendor_sku","manufacturer_part_number","external_id","barcodes","goods_type","is_available","is_visible","weight","dimensions","volume","inventory","export","regulated_goods","packaging","custom_fields"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"0223428a-5abd-4732-a39e-86862f79dd4b":{"name":"fields:rack","in":"query","required":false,"description":"Specify additional fields of the `Rack` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"Rack","description":"Specify additional fields of the `Rack` object to be included in the response.","type":"array","items":{"type":"string","enum":["all","id","name","rack_type","location_pattern","warehouse"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}},"8eccc7d4-5757-496b-bb5e-88a28b92c39c":{"name":"fields:slot_type","in":"query","required":false,"description":"Specify additional fields of the `SlotType` object to be included in the response. See the [selecting fields](/global-api/selecting-fields) page for more information.","explode":false,"schema":{"title":"SlotType","description":"Specify additional fields of the `SlotType` object to be included in the response.","type":"array","items":{"type":"string","enum":["basic","all","name","is_pickable","sort_order","patterns","is_fixed_capacity","slot_dimensions","weight_capacity","created_at","updated_at"],"uniqueKey":"items.[INDEX]","typeLabel":"enum\u003cstring>"},"isRequired":false,"uniqueKey":"","typeLabel":"enum\u003cstring>[]"}}},"responses":{"2ad42c27-252f-4dca-9050-2937712e3591":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"resource":{"title":"Location","type":"object","description":"A Location describes a user-specified inventory address within a warehouse.","properties":{"type":{"type":"string","enum":["Location"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","uniqueKey":"resource.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","example":42,"readOnly":true,"description":"The internal `id` property used as a path parameter in a resource lookup.","uniqueKey":"resource.id","typeLabel":"integer"},"label":{"oneOf":[{"type":"string","example":"A4-55-C3","description":"The human-readable name of a location and also the value encoded in location's barcode label.\nThis value must be unique within each warehouse.","uniqueKey":"resource.label.oneOf.0","typeLabel":"string"},{"type":"null","example":"A4-55-C3","description":"The human-readable name of a location and also the value encoded in location's barcode label.\nThis value must be unique within each warehouse.","uniqueKey":"resource.label.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.label","typeLabel":"string | null"},"priority":{"type":"integer","example":10,"description":"The inventory reservation order relative to other locations containing the same product.","uniqueKey":"resource.priority","typeLabel":"integer"},"qty_putaway":{"oneOf":[{"type":"number","format":"double","example":10,"readOnly":true,"description":"The quantity of a product associated with a Delivery that have not yet been committed to the inventory.","uniqueKey":"resource.qty_putaway.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","example":10,"readOnly":true,"description":"The quantity of a product associated with a Delivery that have not yet been committed to the inventory.","uniqueKey":"resource.qty_putaway.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.qty_putaway","typeLabel":"number\u003cdouble> | null"},"qty_unreserved":{"oneOf":[{"type":"number","format":"double","example":20,"readOnly":true,"description":"The quantity of a product not yet assigned to a specific Shipment. This does not imply that the inventory is Available.","uniqueKey":"resource.qty_unreserved.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","example":20,"readOnly":true,"description":"The quantity of a product not yet assigned to a specific Shipment. This does not imply that the inventory is Available.","uniqueKey":"resource.qty_unreserved.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.qty_unreserved","typeLabel":"number\u003cdouble> | null"},"qty_reserved":{"oneOf":[{"type":"number","format":"double","example":4,"readOnly":true,"description":"The quantity assigned to a Shipment or Work Order and ready to be picked.","uniqueKey":"resource.qty_reserved.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","example":4,"readOnly":true,"description":"The quantity assigned to a Shipment or Work Order and ready to be picked.","uniqueKey":"resource.qty_reserved.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.qty_reserved","typeLabel":"number\u003cdouble> | null"},"qty_on_hand":{"oneOf":[{"type":"number","format":"double","example":34,"readOnly":true,"description":"The \"On Hand\" amount is the same as Put-Away + Unreserved + Reserved quantities.","uniqueKey":"resource.qty_on_hand.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","example":34,"readOnly":true,"description":"The \"On Hand\" amount is the same as Put-Away + Unreserved + Reserved quantities.","uniqueKey":"resource.qty_on_hand.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.qty_on_hand","typeLabel":"number\u003cdouble> | null"},"qty_locked":{"oneOf":[{"type":"number","format":"double","example":4,"readOnly":true,"description":"The quantity that is reserved to a Shipment or Work Order as chosen specifically by a user and therefore should not be re-reserved to a new location on the fly in the event that an adjustment needs to re-optimize pick locations. This amount is already included in `qty_reserved` so is not added again to `qty_on_hand`.\\\n `Optional Field`","uniqueKey":"resource.qty_locked.oneOf.0","typeLabel":"number\u003cdouble>"},{"type":"null","format":"double","example":4,"readOnly":true,"description":"The quantity that is reserved to a Shipment or Work Order as chosen specifically by a user and therefore should not be re-reserved to a new location on the fly in the event that an adjustment needs to re-optimize pick locations. This amount is already included in `qty_reserved` so is not added again to `qty_on_hand`.\\\n `Optional Field`","uniqueKey":"resource.qty_locked.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.qty_locked","typeLabel":"number\u003cdouble> | null"},"is_temp":{"oneOf":[{"type":"boolean","example":false,"readOnly":true,"description":"Temporary locations are used to track inventory that is being relocated and cannot be created or modified.\\\n `Optional Field`","uniqueKey":"resource.is_temp.oneOf.0","typeLabel":"boolean"},{"type":"null","example":false,"readOnly":true,"description":"Temporary locations are used to track inventory that is being relocated and cannot be created or modified.\\\n `Optional Field`","uniqueKey":"resource.is_temp.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.is_temp","typeLabel":"boolean | null"},"is_pickable":{"oneOf":[{"type":"boolean","example":true,"readOnly":true,"description":"Whether or not the location is considered to be easy to pick from for the purpose of generating pickable batches.\\\n `Optional Field`","uniqueKey":"resource.is_pickable.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"readOnly":true,"description":"Whether or not the location is considered to be easy to pick from for the purpose of generating pickable batches.\\\n `Optional Field`","uniqueKey":"resource.is_pickable.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.is_pickable","typeLabel":"boolean | null"},"is_type_auto":{"oneOf":[{"type":"boolean","example":true,"description":"If Slot Type is \"Automatic\" then it will cause the type to be maintained automatically according to the Auto-Assign Patterns of the slot types.\\\n `Optional Field`","uniqueKey":"resource.is_type_auto.oneOf.0","typeLabel":"boolean"},{"type":"null","example":true,"description":"If Slot Type is \"Automatic\" then it will cause the type to be maintained automatically according to the Auto-Assign Patterns of the slot types.\\\n `Optional Field`","uniqueKey":"resource.is_type_auto.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.is_type_auto","typeLabel":"boolean | null"},"created_at":{"oneOf":[{"type":"string","format":"datetime","example":"2021-11-17T14:32:44Z","readOnly":true,"description":"The date and time when the object was created.\\\n `Optional Field`","uniqueKey":"resource.created_at.oneOf.0","typeLabel":"string\u003cdatetime>"},{"type":"null","format":"datetime","example":"2021-11-17T14:32:44Z","readOnly":true,"description":"The date and time when the object was created.\\\n `Optional Field`","uniqueKey":"resource.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.created_at","typeLabel":"string\u003cdatetime> | null"},"updated_at":{"type":"string","format":"datetime","example":"2021-11-17T14:32:44Z","readOnly":true,"description":"The date and time when the object was last updated.\\\n `Optional Field`","uniqueKey":"resource.updated_at","typeLabel":"string\u003cdatetime>"},"last_cyclecount_at":{"oneOf":[{"type":"string","format":"datetime","example":"2021-11-17T14:32:44Z","readOnly":true,"description":"The date and time when last cycle count was performed.\\\n `Optional Field`","uniqueKey":"resource.last_cyclecount_at.oneOf.0","typeLabel":"string\u003cdatetime>"},{"type":"null","format":"datetime","example":"2021-11-17T14:32:44Z","readOnly":true,"description":"The date and time when last cycle count was performed.\\\n `Optional Field`","uniqueKey":"resource.last_cyclecount_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.last_cyclecount_at","typeLabel":"string\u003cdatetime> | null"},"tags":{"type":"array","description":"The `LocationTag` objects assigned to this location. Soft-deleted tags remain assigned and\nare still listed, so resolve each reference to learn its current state.\n\nOn create or update, a submitted array replaces the location's whole tag set (an empty\narray clears it) and an omitted key leaves it untouched. A soft-deleted tag may remain\nassigned but cannot be newly assigned. See the batch tags operation for adding or removing\ntags across many locations at once.\\\n `Optional Field`","items":{"title":"LocationTagRef","type":"object","description":"A reference to a `LocationTag` object.","properties":{"type":{"type":"string","enum":["LocationTag"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.tags.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","example":4,"isRequired":true,"uniqueKey":"resource.tags.items.[INDEX].id","typeLabel":"integer"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"resource.tags.items.[INDEX]","typeLabel":"LocationTagRef · object"},"uniqueKey":"resource.tags","typeLabel":"LocationTagRef · object[]"},"lot":{"oneOf":[{"type":"object","title":"LotRef","description":"A reference to the `Lot` object assigned to this location.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Lot"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.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":"resource.lot.oneOf.0.id","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"resource.lot.oneOf.0","typeLabel":"LotRef · object"},{"type":"null","title":"LotRef","description":"A reference to the `Lot` object assigned to this location.","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":"resource.lot.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.lot","typeLabel":"LotRef · object | null"},"product":{"oneOf":[{"type":"object","title":"StockableProductRef","description":"A reference to the stockable product assigned to this location.","required":["type","id"],"properties":{"type":{"type":"string","description":"This is a read-only property that describes the type of object in the response body.","enum":["Product","PackagingContainer","PackagingInfill","PackagingSupplies"],"isRequired":true,"uniqueKey":"resource.product.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.","format":"int32","isRequired":true,"uniqueKey":"resource.product.oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"resource.product.oneOf.0","typeLabel":"StockableProductRef · object"},{"type":"null","title":"StockableProductRef","description":"A reference to the stockable product assigned to this location.","required":["type","id"],"properties":{"type":{"type":"string","description":"This is a read-only property that describes the type of object in the response body.","enum":["Product","PackagingContainer","PackagingInfill","PackagingSupplies"]},"id":{"type":"integer","description":"The internal, read-only, `id` property used as a path parameter in a resource lookup.","format":"int32"}},"additionalProperties":false,"uniqueKey":"resource.product.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.product","typeLabel":"StockableProductRef · object | null"},"rack":{"oneOf":[{"type":"object","title":"RackRef","description":"A reference to the `Rack` to which this location is assigned. This may be managed automatically or assigned manually.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Rack"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.rack.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":"resource.rack.oneOf.0.id","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"resource.rack.oneOf.0","typeLabel":"RackRef · object"},{"type":"null","title":"RackRef","description":"A reference to the `Rack` to which this location is assigned. This may be managed automatically or assigned manually.","required":["type","id"],"properties":{"type":{"type":"string","enum":["Rack"],"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."}},"additionalProperties":false,"uniqueKey":"resource.rack.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.rack","typeLabel":"RackRef · object | null"},"slot_type":{"oneOf":[{"type":"object","title":"SlotTypeRef","description":"A reference to the `SlotType` object assigned to this location. This may be managed automatically or assigned manually.","required":["type","id"],"properties":{"type":{"type":"string","enum":["SlotType"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"resource.slot_type.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":"resource.slot_type.oneOf.0.id","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"resource.slot_type.oneOf.0","typeLabel":"SlotTypeRef · object"},{"type":"null","title":"SlotTypeRef","description":"A reference to the `SlotType` object assigned to this location. This may be managed automatically or assigned manually.","required":["type","id"],"properties":{"type":{"type":"string","enum":["SlotType"],"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":"resource.slot_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"resource.slot_type","typeLabel":"SlotTypeRef · object | null"}},"uniqueKey":"resource","typeLabel":"Location · 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":{"SlotType":{"type":"array","items":{"title":"SlotType","type":"object","description":"The `SlotType` object allows locations with common attributes or purposes to be easily distinguishable.\nThe slot type also determines if a location is pickable or not which may affect whether or not the location\ncan be reserved for shipments when creating a batch.\n\nA slot type may additionally declare a fixed physical capacity, which drives slot capacity and\nutilization calculations, and a list of label patterns that auto-assign the type to matching locations.","properties":{"type":{"type":"string","enum":["SlotType"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.SlotType.items.[INDEX].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.SlotType.items.[INDEX].id","typeLabel":"integer"},"name":{"type":"string","maxLength":45,"description":"The descriptive name of the slot type, unique across slot types.","example":"Pickable Pallets","uniqueKey":"included.SlotType.items.[INDEX].name","typeLabel":"string"},"is_pickable":{"type":"boolean","description":"Whether or not the location is considered to be easy to pick from for the purpose of generating pickable batches.","default":true,"uniqueKey":"included.SlotType.items.[INDEX].is_pickable","typeLabel":"boolean"},"sort_order":{"type":"integer","minimum":0,"maximum":65535,"example":10,"description":"The order in which this slot type's auto-assign patterns are tested, lowest first; among slot\ntypes sharing a sort order the newest is tested first. The first pattern to match a location\nlabel decides its slot type.\\\n `Optional Field`","uniqueKey":"included.SlotType.items.[INDEX].sort_order","typeLabel":"integer"},"patterns":{"type":"array","description":"Label patterns that automatically assign this slot type to matching locations. Stored in a\ncanonical order, which is not necessarily the order they were submitted in.\\\n `Optional Field`","items":{"title":"SlotTypePattern","type":"object","description":"A rule that assigns its slot type to every location whose label matches `regex`, applied only\nto locations that are still set to automatic slot type assignment.","properties":{"description":{"type":"string","example":"Pallet racks on aisles A through D","description":"An explanation of which locations the pattern is meant to capture.","isRequired":true,"uniqueKey":"included.SlotType.items.[INDEX].patterns.items.[INDEX].description","typeLabel":"string"},"regex":{"type":"string","example":"P-[A-D]-\\d+","description":"A regular expression matched against the whole location label.","isRequired":true,"uniqueKey":"included.SlotType.items.[INDEX].patterns.items.[INDEX].regex","typeLabel":"string"},"warehouses":{"type":"array","description":"The warehouses the pattern applies to. An empty list, or omitting the property on a\nrequest, applies it to every warehouse. Always present in responses.","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.SlotType.items.[INDEX].patterns.items.[INDEX].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.SlotType.items.[INDEX].patterns.items.[INDEX].warehouses.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.SlotType.items.[INDEX].patterns.items.[INDEX].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.SlotType.items.[INDEX].patterns.items.[INDEX].warehouses.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.SlotType.items.[INDEX].patterns.items.[INDEX].warehouses.items.[INDEX]","typeLabel":"WarehouseRef · object | null"},"uniqueKey":"included.SlotType.items.[INDEX].patterns.items.[INDEX].warehouses","typeLabel":"(WarehouseRef · object | null)[]"}},"required":["description","regex"],"additionalProperties":false,"uniqueKey":"included.SlotType.items.[INDEX].patterns.items.[INDEX]","typeLabel":"SlotTypePattern · object"},"uniqueKey":"included.SlotType.items.[INDEX].patterns","typeLabel":"SlotTypePattern · object[]"},"is_fixed_capacity":{"type":"boolean","example":true,"description":"Whether slots of this type hold a fixed, known amount, making them eligible for slot capacity\nand utilization calculations. When enabled, all three slot dimensions are required.\\\n `Optional Field`","uniqueKey":"included.SlotType.items.[INDEX].is_fixed_capacity","typeLabel":"boolean"},"slot_dimensions":{"oneOf":[{"type":"object","title":"DimensionsWHD","description":"The interior dimensions of slots assigned to this slot type.\\\n `Optional Field`","properties":{"width":{"type":"number","description":"The width defined as a floating-point number up to 4 decimal places.","format":"float","example":48,"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions.oneOf.0.width","typeLabel":"number\u003cfloat>"},"height":{"type":"number","description":"The height defined as a floating-point number up to 4 decimal places.","format":"float","example":60,"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions.oneOf.0.height","typeLabel":"number\u003cfloat>"},"depth":{"type":"number","description":"The depth defined as a floating-point number up to 4 decimal places.","format":"float","example":42,"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions.oneOf.0.depth","typeLabel":"number\u003cfloat>"},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"],"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions.oneOf.0","typeLabel":"DimensionsWHD · object"},{"type":"null","title":"DimensionsWHD","description":"The interior dimensions of slots assigned to this slot type.\\\n `Optional Field`","properties":{"width":{"type":"number","description":"The width defined as a floating-point number up to 4 decimal places.","format":"float","example":48},"height":{"type":"number","description":"The height defined as a floating-point number up to 4 decimal places.","format":"float","example":60},"depth":{"type":"number","description":"The depth defined as a floating-point number up to 4 decimal places.","format":"float","example":42},"unit":{"type":"string","description":"The imperical or metric unit of measurement.","enum":["in","mm","cm","m"]}},"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.SlotType.items.[INDEX].slot_dimensions","typeLabel":"DimensionsWHD · object | null"},"weight_capacity":{"oneOf":[{"type":"object","title":"WeightNonNegative","description":"The maximum weight a slot of this type may hold, used to clamp computed slot capacities.\nMust not be negative.\\\n `Optional Field`","required":["value"],"properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","minimum":0,"maximum":99999999.999999,"example":20,"isRequired":true,"uniqueKey":"included.SlotType.items.[INDEX].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.SlotType.items.[INDEX].weight_capacity.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.SlotType.items.[INDEX].weight_capacity.oneOf.0","typeLabel":"WeightNonNegative · object"},{"type":"null","title":"WeightNonNegative","description":"The maximum weight a slot of this type may hold, used to clamp computed slot capacities.\nMust not be negative.\\\n `Optional Field`","required":["value"],"properties":{"value":{"type":"number","description":"The weight quantity defined as a floating point value of up to 4 decimal places.","format":"float","minimum":0,"maximum":99999999.999999,"example":20},"unit":{"type":"string","description":"This can be an imperial or metric unit for weight.","enum":["lb","oz","kg","g"]}},"uniqueKey":"included.SlotType.items.[INDEX].weight_capacity.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.SlotType.items.[INDEX].weight_capacity","typeLabel":"WeightNonNegative · object | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","example":"2026-08-01T14:03:22Z","description":"The UTC date and time the slot type was created.\\\n `Optional Field`","uniqueKey":"included.SlotType.items.[INDEX].created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2026-08-01T14:03:22Z","description":"The UTC date and time the slot type was created.\\\n `Optional Field`","uniqueKey":"included.SlotType.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.SlotType.items.[INDEX].created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","example":"2026-08-01T14:03:22Z","description":"The UTC date and time the slot type was last modified.\\\n `Optional Field`","uniqueKey":"included.SlotType.items.[INDEX].updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","example":"2026-08-01T14:03:22Z","description":"The UTC date and time the slot type was last modified.\\\n `Optional Field`","uniqueKey":"included.SlotType.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.SlotType.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.SlotType.items.[INDEX]","typeLabel":"SlotType · object"},"uniqueKey":"included.SlotType","typeLabel":"SlotType · 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)[]"},"LotType":{"type":"array","items":{"title":"LotType","type":"object","description":"LotType","properties":{"type":{"type":"string","enum":["LotType"],"readOnly":true,"description":"This is a read-only property that describes the type of object in the response body.","uniqueKey":"included.LotType.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","format":"int64","description":"The internal `id` property used as a path parameter in a resource lookup.","readOnly":true,"example":4,"uniqueKey":"included.LotType.items.[INDEX].id","typeLabel":"integer\u003cint64>"},"name":{"type":"string","description":"Any string which uniquely identifies a LotType.","minLength":1,"maxLength":255,"example":"MixFulfillment-Extract-Choose-FEFO","uniqueKey":"included.LotType.items.[INDEX].name","typeLabel":"string"},"allow_mixing_locations":{"type":"boolean","description":"This flag must be `true` for mixing with other Lots/Expirations in the same location..","example":true,"uniqueKey":"included.LotType.items.[INDEX].allow_mixing_locations","typeLabel":"boolean"},"allow_mixing_fulfillment":{"type":"boolean","description":"This flag must be `true` for mixing with other Lots/Expirations when fulfilling an order..","example":true,"uniqueKey":"included.LotType.items.[INDEX].allow_mixing_fulfillment","typeLabel":"boolean"},"lot_number_input":{"description":"The input method used when processing a lot number..","type":"string","enum":["none","choose_date","extract_date","text"],"example":"text","uniqueKey":"included.LotType.items.[INDEX].lot_number_input","typeLabel":"enum\u003cstring>"},"lot_number_example":{"type":"string","description":"Enter a typical example of a lot number which can be used to validate the Lot Number Pattern. It will also be displayed as an example when users are prompted for input.","example":"AB190405G","uniqueKey":"included.LotType.items.[INDEX].lot_number_example","typeLabel":"string"},"lot_number_pattern":{"type":"string","description":"Enter a RegEx for capturing the Lot Number Input. Regex must contain one or more capturing group.","example":"^([A-Z]{2}-[0-9]+)$","uniqueKey":"included.LotType.items.[INDEX].lot_number_pattern","typeLabel":"string"},"lot_number_replacement":{"type":"string","description":"Enter a RegEx to either save the Lot Number Input as is or transform the entry into something more readable. Must contain one or more non-empty capturing group from the Lot Number Pattern.","example":"$2$1","uniqueKey":"included.LotType.items.[INDEX].lot_number_replacement","typeLabel":"string"},"expiration_date":{"type":"string","description":"The input method used when processing the expiration date.","enum":["none","choose_date","extract_date","lot_number_date"],"example":"lot_number_date","uniqueKey":"included.LotType.items.[INDEX].expiration_date","typeLabel":"enum\u003cstring>"},"burn_order":{"type":"string","description":"Specifies what stock should be used first when fulfilling orders.","enum":["none","fifo","lifo","fefo","lefo","fifo_lot_number","lifo_lot_number"],"example":"fefo","uniqueKey":"included.LotType.items.[INDEX].burn_order","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"The date and time the object was created in RFC 3339 section 5.6 notation.","example":"2017-07-21T17:32:28Z","readOnly":true,"uniqueKey":"included.LotType.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"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.LotType.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.LotType.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.LotType.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.LotType.items.[INDEX]","typeLabel":"LotType · object"},"uniqueKey":"included.LotType","typeLabel":"LotType · object[]"},"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[]"},"PackagingContainer":{"type":"array","items":{"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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.dimensions.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.dimensions.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.volume.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.volume.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].container_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].container_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].container_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].container_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].container_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.allow_for_warehouses.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.allow_for_warehouses.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].container_options.allow_for_warehouses.items.[INDEX]","typeLabel":"WarehouseRef · object | null"},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.allow_for_shipping_methods.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.weight_capacity.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.weight_capacity.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].container_options.packaging_handling_surcharge","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.PackagingContainer.items.[INDEX].name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.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.PackagingContainer.items.[INDEX].merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingContainer.items.[INDEX].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.PackagingContainer.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.PackagingContainer.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingContainer.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingContainer.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingContainer.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.PackagingContainer.items.[INDEX]","typeLabel":"PackagingContainer · object"},"uniqueKey":"included.PackagingContainer","typeLabel":"PackagingContainer · object[]"},"PackagingDataCollection":{"type":"array","items":{"type":"object","title":"PackagingDataCollection","description":"A reference to the `PackagingDataCollection` object linked with Warehouse Inventory Location.","properties":{"sku":{"type":"string","description":"The Stock Keeping Unit (SKU) is a unique identifier for the `Product`.","example":"SKU-1AD","uniqueKey":"included.PackagingDataCollection.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.PackagingDataCollection.items.[INDEX].name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].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.PackagingDataCollection.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.PackagingDataCollection.items.[INDEX].merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].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.PackagingDataCollection.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.PackagingDataCollection.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingDataCollection.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingDataCollection.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingDataCollection.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"},"type":{"type":"string","enum":["PackagingDataCollection"],"description":"This property describes the type of object in the response body.","uniqueKey":"included.PackagingDataCollection.items.[INDEX].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.PackagingDataCollection.items.[INDEX].id","typeLabel":"integer"},"data_collection_options":{"type":"object","properties":{"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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.billing_amount","typeLabel":"Monetary · 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.PackagingDataCollection.items.[INDEX].data_collection_options.allow_for_shipping_methods.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.allow_for_shipping_methods","typeLabel":"string[]"},"apply_to_goods_type":{"type":"string","enum":["any","NORMAL","ORM_D"],"description":"This packaging feature will be applied to all shipments containing an item with this Goods Type. \\\n- `NORMAL` Not Regulated\n- `ORM_D` ORM-D\n`Optional Field`","uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.never_apply_to_goods_type","typeLabel":"enum\u003cstring>"},"apply_only_above_weight":{"oneOf":[{"type":"object","title":"Weight","description":"If specified, this packaging product 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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.apply_only_above_weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.apply_only_above_weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"If specified, this packaging product 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.PackagingDataCollection.items.[INDEX].data_collection_options.apply_only_above_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.require_packaging_type","typeLabel":"enum\u003cstring>"},"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.PackagingDataCollection.items.[INDEX].data_collection_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.PackagingDataCollection.items.[INDEX].data_collection_options.apply_to_multi_sku_package","typeLabel":"enum\u003cboolean>"},"collect_data_pattern":{"type":"string","description":"Specify a Javascript-compatible regular expression which describes the format of the data to be collected. Examples: \".+\" for anything, or \"^[0-9]{15}$\" for a 15-digit number. See http://regexpal.com/","uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.collect_data_pattern","typeLabel":"string"},"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.PackagingDataCollection.items.[INDEX].data_collection_options.apply_to_region","typeLabel":"string"},"is_collected_data_unique":{"type":"boolean","description":"Prevent the same data collection value from being collected more than once on the same shipment.","enum":[true,false],"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options.is_collected_data_unique","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.PackagingDataCollection.items.[INDEX].data_collection_options","typeLabel":"object"}},"uniqueKey":"included.PackagingDataCollection.items.[INDEX]","typeLabel":"PackagingDataCollection · object"},"uniqueKey":"included.PackagingDataCollection","typeLabel":"PackagingDataCollection · object[]"},"PackagingInfill":{"type":"array","items":{"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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingInfill.items.[INDEX].infill_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInfill.items.[INDEX].infill_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].infill_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInfill.items.[INDEX].infill_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].infill_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.infill_horizontal.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.infill_horizontal.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.infill_vertical.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.infill_vertical.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].infill_options.infill_priority","typeLabel":"integer"}},"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.PackagingInfill.items.[INDEX].name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.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.PackagingInfill.items.[INDEX].merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInfill.items.[INDEX].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.PackagingInfill.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.PackagingInfill.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingInfill.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingInfill.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInfill.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.PackagingInfill.items.[INDEX]","typeLabel":"PackagingInfill · object"},"uniqueKey":"included.PackagingInfill","typeLabel":"PackagingInfill · object[]"},"PackagingInstruction":{"type":"array","items":{"type":"object","title":"PackagingInstruction","description":"A reference to the `PackagingInstruction` object linked with Warehouse Inventory Location.","properties":{"type":{"type":"string","enum":["PackagingInstruction"],"description":"This property describes the type of object in the response body.","uniqueKey":"included.PackagingInstruction.items.[INDEX].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.PackagingInstruction.items.[INDEX].id","typeLabel":"integer"},"instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.barcodes","typeLabel":"string · null · string[] · null"},"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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.billing_amount","typeLabel":"Monetary · 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.PackagingInstruction.items.[INDEX].instruction_options.allow_for_shipping_methods.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.allow_for_shipping_methods","typeLabel":"string[]"},"apply_to_goods_type":{"type":"string","enum":["any","NORMAL","ORM_D"],"description":"This packaging feature will be applied to all shipments containing an item with this Goods Type.\n- `NORMAL` Not Regulated\n- `ORM_D` ORM-D\n`Optional Field`","uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.never_apply_to_goods_type","typeLabel":"enum\u003cstring>"},"apply_only_above_weight":{"oneOf":[{"type":"object","title":"Weight","description":"If specified, this packaging product 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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.apply_only_above_weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options.apply_only_above_weight.oneOf.0","typeLabel":"Weight · object"},{"type":"null","title":"Weight","description":"If specified, this packaging product 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.PackagingInstruction.items.[INDEX].instruction_options.apply_only_above_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_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.PackagingInstruction.items.[INDEX].instruction_options.apply_to_multi_sku_package","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.PackagingInstruction.items.[INDEX].instruction_options","typeLabel":"object"},"sku":{"type":"string","description":"The Stock Keeping Unit (SKU) is a unique identifier for the `Product`.","example":"SKU-1AD","uniqueKey":"included.PackagingInstruction.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.PackagingInstruction.items.[INDEX].name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.PackagingInstruction.items.[INDEX].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.PackagingInstruction.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.PackagingInstruction.items.[INDEX].merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingInstruction.items.[INDEX].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.PackagingInstruction.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.PackagingInstruction.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInstruction.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingInstruction.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingInstruction.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingInstruction.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.PackagingInstruction.items.[INDEX]","typeLabel":"PackagingInstruction · object"},"uniqueKey":"included.PackagingInstruction","typeLabel":"PackagingInstruction · object[]"},"PackagingSupplies":{"type":"array","items":{"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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.barcodes.oneOf.1","typeLabel":"null"},{"type":"array","items":{"type":"string","uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.barcodes.oneOf.3","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.associated_products.items.[INDEX].id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].supplies_options.associated_products.items.[INDEX]","typeLabel":"ProductRef · object"},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.allow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.allow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].supplies_options.allow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].supplies_options.allow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.disallow_for_brands.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.disallow_for_brands.items.[INDEX].oneOf.1.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].supplies_options.disallow_for_brands.items.[INDEX].oneOf.1","typeLabel":"BrandRef · object"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].supplies_options.disallow_for_brands.items.[INDEX]","typeLabel":"MerchantRef · object | BrandRef · object"},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.billing_amount.oneOf.0.currency","typeLabel":"string"}},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.billing_amount.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.allow_for_warehouses.items.[INDEX].oneOf.0.id","typeLabel":"integer\u003cint32>"}},"required":["type","id"],"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.allow_for_warehouses.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].supplies_options.allow_for_warehouses.items.[INDEX]","typeLabel":"WarehouseRef · object | null"},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.allow_for_shipping_methods.items.[INDEX]","typeLabel":"string"},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.apply_only_above_weight.oneOf.0.unit","typeLabel":"enum\u003cstring>"}},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.apply_only_above_weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].supplies_options.apply_to_multi_sku_package","typeLabel":"enum\u003cboolean>"}},"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.items.[INDEX].sku","typeLabel":"string"},"name":{"type":"string","description":"This is displayed as a short, descriptive title for the `Product`.","example":"Test Product","uniqueKey":"included.PackagingSupplies.items.[INDEX].name","typeLabel":"string"},"is_enabled":{"type":"boolean","description":"Disabled products are effectively deleted.","enum":[true,false],"default":true,"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.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.PackagingSupplies.items.[INDEX].merchant.id","typeLabel":"integer\u003cint32>"}},"additionalProperties":false,"uniqueKey":"included.PackagingSupplies.items.[INDEX].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.PackagingSupplies.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.PackagingSupplies.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingSupplies.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.","example":"2017-07-21T17:39:43Z","readOnly":true,"uniqueKey":"included.PackagingSupplies.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.PackagingSupplies.items.[INDEX].updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"included.PackagingSupplies.items.[INDEX]","typeLabel":"PackagingSupplies · object"},"uniqueKey":"included.PackagingSupplies","typeLabel":"PackagingSupplies · 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)[]"},"Rack":{"type":"array","items":{"oneOf":[{"title":"Rack","type":"object","description":"A `Rack` is a grouping of locations in a warehouse implying a very close proximity.","properties":{"type":{"type":"string","enum":["Rack"],"readOnly":true,"description":"This property describes the type of object in the response body.","uniqueKey":"included.Rack.items.[INDEX].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.","uniqueKey":"included.Rack.items.[INDEX].oneOf.0.id","typeLabel":"integer"},"rack_type":{"oneOf":[{"type":"object","title":"RackTypeRef","description":"A reference to the `RackType` that classifies this rack.","required":["type","id"],"properties":{"type":{"type":"string","enum":["RackType"],"description":"This property describes the type of object in the response body.","isRequired":true,"uniqueKey":"included.Rack.items.[INDEX].oneOf.0.rack_type.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.Rack.items.[INDEX].oneOf.0.rack_type.oneOf.0.id","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"included.Rack.items.[INDEX].oneOf.0.rack_type.oneOf.0","typeLabel":"RackTypeRef · object"},{"type":"null","title":"RackTypeRef","description":"A reference to the `RackType` that classifies this rack.","required":["type","id"],"properties":{"type":{"type":"string","enum":["RackType"],"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."}},"additionalProperties":false,"uniqueKey":"included.Rack.items.[INDEX].oneOf.0.rack_type.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Rack.items.[INDEX].oneOf.0.rack_type","typeLabel":"RackTypeRef · object | null"}},"uniqueKey":"included.Rack.items.[INDEX].oneOf.0","typeLabel":"Rack · object"},{"title":"Rack","type":"null","description":"A `Rack` is a grouping of locations in a warehouse implying a very close proximity.","properties":{"type":{"type":"string","enum":["Rack"],"readOnly":true,"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."},"rack_type":{"oneOf":[{"type":"object","title":"RackTypeRef","description":"A reference to the `RackType` that classifies this rack.","required":["type","id"],"properties":{"type":{"type":"string","enum":["RackType"],"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."}},"additionalProperties":false},{"type":"null","title":"RackTypeRef","description":"A reference to the `RackType` that classifies this rack.","required":["type","id"],"properties":{"type":{"type":"string","enum":["RackType"],"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."}},"additionalProperties":false}]}},"uniqueKey":"included.Rack.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.Rack.items.[INDEX]","typeLabel":"Rack · object | null"},"uniqueKey":"included.Rack","typeLabel":"(Rack · object | null)[]"},"RackType":{"type":"array","items":{"oneOf":[{"title":"RackType","type":"object","description":"A `RackType` classifies racks by their physical characteristics (e.g. \"Wide Aisle\", \"Narrow Aisle\").","properties":{"type":{"type":"string","enum":["RackType"],"readOnly":true,"description":"This property describes the type of object in the response body.","uniqueKey":"included.RackType.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"integer","description":"The internal `id` property used as a path parameter in a resource lookup.","example":1,"uniqueKey":"included.RackType.items.[INDEX].oneOf.0.id","typeLabel":"integer"},"name":{"type":"string","description":"The name of the rack type.","example":"Wide Aisle","uniqueKey":"included.RackType.items.[INDEX].oneOf.0.name","typeLabel":"string"},"notes":{"oneOf":[{"type":"string","description":"Optional notes about this rack type.","uniqueKey":"included.RackType.items.[INDEX].oneOf.0.notes.oneOf.0","typeLabel":"string"},{"type":"null","description":"Optional notes about this rack type.","uniqueKey":"included.RackType.items.[INDEX].oneOf.0.notes.oneOf.1","typeLabel":"null"}],"uniqueKey":"included.RackType.items.[INDEX].oneOf.0.notes","typeLabel":"string | null"}},"uniqueKey":"included.RackType.items.[INDEX].oneOf.0","typeLabel":"RackType · object"},{"title":"RackType","type":"null","description":"A `RackType` classifies racks by their physical characteristics (e.g. \"Wide Aisle\", \"Narrow Aisle\").","properties":{"type":{"type":"string","enum":["RackType"],"readOnly":true,"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.","example":1},"name":{"type":"string","description":"The name of the rack type.","example":"Wide Aisle"},"notes":{"oneOf":[{"type":"string","description":"Optional notes about this rack type."},{"type":"null","description":"Optional notes about this rack type."}]}},"uniqueKey":"included.RackType.items.[INDEX].oneOf.1","typeLabel":"null"}],"uniqueKey":"included.RackType.items.[INDEX]","typeLabel":"RackType · object | null"},"uniqueKey":"included.RackType","typeLabel":"(RackType · object | null)[]"},"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":"Location","id":42,"label":"A4-55-C3","priority":10,"qty_putaway":10,"qty_unreserved":20,"qty_reserved":4,"qty_on_hand":34,"qty_locked":4,"is_temp":false,"is_pickable":true,"is_type_auto":true,"created_at":"2021-11-17T14:32:44Z","updated_at":"2021-11-17T14:32:44Z","last_cyclecount_at":"2021-11-17T14:32:44Z","tags":[{"type":"LocationTag","id":4}],"lot":{"type":"Lot","id":54},"product":{"type":"Product","id":123},"rack":{"type":"Rack","id":123},"slot_type":{"type":"SlotType","id":54}},"included":{"SlotType":[{"type":"SlotType","id":54,"name":"Pickable Pallets","is_pickable":true,"sort_order":10,"patterns":[{"description":"Pallet racks on aisles A through D","regex":"P-[A-D]-\\d+","warehouses":[{"type":"Warehouse","id":123}]}],"is_fixed_capacity":true,"slot_dimensions":{"width":48,"height":60,"depth":42,"unit":"in"},"weight_capacity":{"value":20,"unit":"lb"},"created_at":"2026-08-01T14:03:22Z","updated_at":"2026-08-01T14:03:22Z"}],"Lot":[{"type":"Lot","id":54}],"LotType":[{"type":"LotType","id":4,"name":"MixFulfillment-Extract-Choose-FEFO","allow_mixing_locations":true,"allow_mixing_fulfillment":true,"lot_number_input":"text","lot_number_example":"AB190405G","lot_number_pattern":"^([A-Z]{2}-[0-9]+)$","lot_number_replacement":"$2$1","expiration_date":"lot_number_date","burn_order":"fefo","created_at":"2017-07-21T17:32:28Z","updated_at":"2017-07-21T17:39:43Z"}],"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}}}],"PackagingContainer":[{"type":"PackagingContainer","id":123,"container_options":{"barcodes":"956623520-4","weight":{"value":20,"unit":"lb"},"dimensions":{"length":8,"width":6,"height":4,"unit":"in"},"volume":{"value":300,"unit":"in^3"},"manage_stock":true,"associated_products":[{"type":"Product","id":3}],"allow_for_brands":[{"type":"Merchant","id":4}],"disallow_for_brands":[{"type":"Merchant","id":4}],"billing_amount":{"amount":99,"currency":"USD"},"allow_for_warehouses":[{"type":"Warehouse","id":123}],"allow_for_shipping_methods":["\u003cstring>"],"satisfies_overbox":true,"use_for_bin_packing":"yes","weight_capacity":{"value":20,"unit":"lb"},"container_style":"rigid_box","packaging_handling_surcharge":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"}],"PackagingDataCollection":[{"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","type":"PackagingDataCollection","id":123,"data_collection_options":{"associated_products":[{"type":"Product","id":3}],"allow_for_brands":[{"type":"Merchant","id":4}],"disallow_for_brands":[{"type":"Merchant","id":4}],"billing_amount":{"amount":99,"currency":"USD"},"allow_for_shipping_methods":["\u003cstring>"],"apply_to_goods_type":"any","never_apply_to_goods_type":"NORMAL","apply_only_above_weight":{"value":20,"unit":"lb"},"one_per":"order","require_scan_timing":"after_product_scan|on_full","disable_confirm_button":true,"require_packaging_type":"overbox","apply_unless_container_meets_hazmat":true,"apply_to_multi_sku_package":true,"collect_data_pattern":"\u003cstring>","apply_to_region":"\u003cstring>","is_collected_data_unique":true}}],"PackagingInfill":[{"type":"PackagingInfill","id":123,"infill_options":{"barcodes":"956623520-4","weight":{"value":20,"unit":"lb"},"manage_stock":true,"associated_products":[{"type":"Product","id":3}],"allow_for_brands":[{"type":"Merchant","id":4}],"disallow_for_brands":[{"type":"Merchant","id":4}],"billing_amount":{"amount":99,"currency":"USD"},"disable_confirm_button":true,"apply_unless_container_meets_hazmat":true,"is_confirmation_required":true,"infill_horizontal":{"value":12,"unit":"in"},"infill_vertical":{"value":12,"unit":"in"},"infill_priority":123},"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"}],"PackagingInstruction":[{"type":"PackagingInstruction","id":123,"instruction_options":{"barcodes":"956623520-4","associated_products":[{"type":"Product","id":3}],"allow_for_brands":[{"type":"Merchant","id":4}],"disallow_for_brands":[{"type":"Merchant","id":4}],"billing_amount":{"amount":99,"currency":"USD"},"allow_for_shipping_methods":["\u003cstring>"],"apply_to_goods_type":"any","never_apply_to_goods_type":"NORMAL","apply_only_above_weight":{"value":20,"unit":"lb"},"one_per":"order","require_scan_timing":"after_product_scan|on_full","disable_confirm_button":true,"require_packaging_type":"overbox","apply_to_region":"\u003cstring>","apply_unless_container_meets_hazmat":true,"apply_to_multi_sku_package":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"}],"PackagingSupplies":[{"type":"PackagingSupplies","id":123,"supplies_options":{"barcodes":"956623520-4","weight":{"value":20,"unit":"lb"},"manage_stock":true,"associated_products":[{"type":"Product","id":3}],"allow_for_brands":[{"type":"Merchant","id":4}],"disallow_for_brands":[{"type":"Merchant","id":4}],"billing_amount":{"amount":99,"currency":"USD"},"allow_for_warehouses":[{"type":"Warehouse","id":123}],"allow_for_shipping_methods":["\u003cstring>"],"packaging_handling_surcharge":true,"apply_to_goods_type":"any","never_apply_to_goods_type":"NORMAL","apply_only_above_weight":{"value":20,"unit":"lb"},"one_per":"order","require_scan_timing":"after_product_scan|on_full","disable_confirm_button":true,"require_packaging_type":"overbox","apply_to_region":"\u003cstring>","apply_unless_container_meets_hazmat":true,"apply_to_multi_sku_package":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"}],"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"}],"Rack":[{"type":"Rack","id":54,"rack_type":{"type":"RackType","id":123}}],"RackType":[{"type":"RackType","id":1,"name":"Wide Aisle","notes":"\u003cstring>"}],"Warehouse":[{"type":"Warehouse","id":3,"name":"East Coast 1","abbreviation":"EC1","is_active":true}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"4b74aded-34fe-44a1-9fdb-c786c2a2c003":{"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"},"c71d6731-600a-4f67-b7fd-496104f72fa8":{"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"},"7ec44378-c4a2-4829-87b3-1927acaccab5":{"description":"There was an error processing 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":["application","unable_to_process"],"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":"unable_to_process","message":"There was an error processing the request."}]},"examples":{"Example":{"title":"Example","value":{"errors":[{"type":"unable_to_process","message":"There was an error processing the request."}]}}},"exampleType":"examples"}},"exampleType":"examples"},"cb8ec603-a010-4c29-bc7e-3a4b5ddb0332":{"description":"OK - The operation completed successfully and there is no response body.","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 Location by Label - ShipStream Developer Center","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-02-19T16:24:03.297Z","originalFileLocation":"global-api/endpoint/v1/inventory/warehouses/{id}/locationsByLabel/{label}/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 Location object specified by the warehouse id and location label 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 Location by Label - ShipStream Developer Center\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns a single Location object specified by the warehouse id and location label 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/inventory/warehouses/{id}/locationsByLabel/{label}/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=Locations\u0026amp;title=Get+Location+by+Label\u0026amp;description=Returns+a+single+%60Location%60+object+specified+by+the+warehouse+%60id%60+and+location+%60label%60+path+parameters.\u0026amp;theme=e93d60d32d376022e10e26fa\u0026amp;signature=e5e9081244a85fc4f800d6253547084d0400f7487560a908c342fd6e838cbbd7\">\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 Location by Label - ShipStream Developer Center\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns a single Location object specified by the warehouse id and location label path parameters.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://shipstream.mintlify.app/_mintlify/api/og/v2?division=Locations\u0026amp;title=Get+Location+by+Label\u0026amp;description=Returns+a+single+%60Location%60+object+specified+by+the+warehouse+%60id%60+and+location+%60label%60+path+parameters.\u0026amp;theme=e93d60d32d376022e10e26fa\u0026amp;signature=e5e9081244a85fc4f800d6253547084d0400f7487560a908c342fd6e838cbbd7\">\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/inventory/warehouses/{id}/locationsByLabel/{label}/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/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%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/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get#webpage\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get\",\"name\":\"Get Location by Label\",\"description\":\"Returns a single Location object specified by the warehouse id and location label path parameters.\",\"dateModified\":\"2026-02-19T16:24:03.297Z\",\"isPartOf\":{\"@id\":\"https://docs.shipstream.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Inventory API v1\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/get\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Locations\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locations/get\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get Location by Label\",\"item\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get#apireference\",\"headline\":\"Get Location by Label\",\"name\":\"Get Location by Label\",\"description\":\"Returns a single Location object specified by the warehouse id and location label path parameters.\",\"url\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.shipstream.io/global-api/endpoint/v1/inventory/warehouses/%7Bid%7D/locationsByLabel/%7Blabel%7D/get#webpage\"},\"dateModified\":\"2026-02-19T16:24:03.297Z\",\"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}","description":"Deletes an existing Location specified by the warehouse `id` and `location_id` path parameters.","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","description":"Creates or updates a `Location` collection specified by a warehouse `id` path parameter and according to the request body.","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}","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","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 Location by Label - ShipStream Developer Center","buildId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","deploymentId":"dpl_EnxDqhjaNc9a8MVa833TGULPd9uJ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-26-lDe7V.js","utils-CWQmgYtH.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-4-Aw3rSD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C2zjXYA5.js","snippetPresets-DFmpFA7C.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-FJpQavWq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D_GvPF7k.js","shallow-Bs2ZB0NO.js","getApiPlaygroundDisplay-DCcqJJk-.js","CodeSnippet-DzDxawVe.js","CodeSnippets-aUr7fU-7.js","Page-CT9uE8Ip.js","getPastedJson-Y1fKsj_I.js","icon-DI4zTsDr.js","MethodPill-C0nDlmSQ.js","DuplicateIcon-NUXbx2nQ.js","createIcon-BdTHrPAi.js","DynamicMarkdown-CtpgKJwj.js","SectionHeading-B3x35tOt.js","axios-vUo_bRtp.js","Markdown-3OmurJMP.js","clsx-DMKzROTp.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-1ms6tsT-.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-Ke9xIMFx.js"]}