Type of purchase order. Required for Walmart, TJX, SaksOffFifth.com, Saks Off Fifth Store, DICK's Sporting Goods, Macy's Store, Macy's.com, and Bloomingdales
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"RetailReady","colors":{"primary":"#2563EB","light":"#2563EB","dark":"#2563EB"},"logo":{"light":"https://mintcdn.com/retailready-4b9f321b/NGmGDHphxz3-Rlig/logo/light.svg?fit=max\u0026auto=format\u0026n=NGmGDHphxz3-Rlig\u0026q=85\u0026s=b0d22da72fa17f2463b8baf64ff868f1","dark":"https://mintcdn.com/retailready-4b9f321b/NGmGDHphxz3-Rlig/logo/dark.svg?fit=max\u0026auto=format\u0026n=NGmGDHphxz3-Rlig\u0026q=85\u0026s=c2071f9704eb997ee9065b4846d3f47d"},"favicon":"https://mintcdn.com/retailready-4b9f321b/2y7_wrqwOvUJZmYC/favicon.png?fit=max\u0026auto=format\u0026n=2y7_wrqwOvUJZmYC\u0026q=85\u0026s=c3e455c931be7b2af66929fddcfe819b","api":{"playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:support@retailreadyai.com","label":"Support"}],"primary":{"type":"button","label":"Sign In","href":"https://3pl.retailreadyai.com/login"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/retailreadyai"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"retailready-4b9f321b","hasAudioNarration":false,"actualSubdomain":"retailready-4b9f321b","customDomains":["docs.retailreadyai.com"],"gitSource":{"type":"github","owner":"retailready","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae2d0b1184332a38bee8205","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"Orders","count":7},{"language":"default","tag":"Documents","count":2},{"language":"default","tag":"Fintech","count":2},{"language":"default","tag":"Inventory","count":2},{"language":"default","tag":"API Documentation","count":1},{"language":"default","tag":"Authentication","count":1},{"language":"default","tag":"Brands","count":1},{"language":"default","tag":"Chargebacks","count":1},{"language":"default","tag":"Facilities","count":1}]},"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":"rbac-expansion","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":"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":"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":"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":"full-page-search","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":"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":"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":"turbopuffer-dual-write","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},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/orders/create-order","slug":"/api-reference/orders/create-order","pageMetadata":{"title":"Create Order","description":"Create a new order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/create","href":"/api-reference/orders/create-order","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Create a new order\"\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":"Create Order","description":"Create a new order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/create","href":"/api-reference/orders/create-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create Order","description":"Create a new order","tags":["Orders"],"security":["af716928-b62d-4124-85d7-ecd87a9aa1e9"],"requestBody":"8e13dbf7-c08c-4df6-92cb-b5ec318f630f","responses":{"200":"8243f0e8-3218-4d51-83f0-0a19831fd5e9","400":"4aa1d71e-2600-4241-a2f5-63fd5de984cd"},"method":"post","type":"path","servers":["b0a9942f-4aa8-4507-90f3-7921214d1752","44674cc3-736c-4627-afbf-ef34b949c673"],"path":"/api/v1/orders/create","baseUrlOptions":["https://api.retailreadyai.com","https://stg.retailreadyai.com"],"title":"Create Order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"po_number":{"type":"string","description":"Purchase order number","example":"some-po-number","isRequired":true,"uniqueKey":"po_number","typeLabel":"string"},"picksheet_code":{"type":"string","description":"Picksheet Code/Warehouse Order Number","example":"some-picksheet-code","isRequired":true,"uniqueKey":"picksheet_code","typeLabel":"string"},"brand_id":{"type":"string","format":"uuid","description":"UUID of the brand","example":"14e517b3-5091-4748-8a25-c497aec2ce98","isRequired":true,"uniqueKey":"brand_id","typeLabel":"string\u003cuuid>"},"retailer_id":{"type":"string","format":"uuid","description":"UUID of the retailer","example":"14e517b3-5091-4748-8a25-c497aec2ce98","isRequired":true,"uniqueKey":"retailer_id","typeLabel":"string\u003cuuid>"},"facility_id":{"type":"string","format":"uuid","description":"UUID of the facility","example":"14e517b3-5091-4748-8a25-c497aec2ce9z","isRequired":true,"uniqueKey":"facility_id","typeLabel":"string\u003cuuid>"},"items":{"type":"array","items":{"type":"object","properties":{"sku":{"type":"string","description":"Stock Keeping Unit","example":"pillow-sku","isRequired":true,"uniqueKey":"\\items.items.[INDEX].sku","typeLabel":"string"},"upc":{"type":"string","description":"Universal Product Code","example":"pillow-upc","uniqueKey":"\\items.items.[INDEX].upc","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantity of items","example":5,"uniqueKey":"\\items.items.[INDEX].quantity","typeLabel":"integer"},"case_pack_quantity":{"type":"integer","description":"Number of items per case","example":5,"uniqueKey":"\\items.items.[INDEX].case_pack_quantity","typeLabel":"integer"},"case_barcode":{"type":"string","description":"Barcode for the case","example":"pillow-case-upc","uniqueKey":"\\items.items.[INDEX].case_barcode","typeLabel":"string"},"vendor_pn":{"type":"string","description":"Vendor part number. Required for Dillard's, Target, ULTA, and DICK's Sporting Goods.","example":"vendor-part-number","uniqueKey":"\\items.items.[INDEX].vendor_pn","typeLabel":"string"},"description":{"type":"string","description":"Product description","example":"soft pillows","uniqueKey":"\\items.items.[INDEX].description","typeLabel":"string"}},"required":["sku"],"uniqueKey":"\\items.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"\\items","typeLabel":"object[]"},"address_data":{"type":"object","properties":{"ship_to_contact":{"type":"object","properties":{"name":{"type":"string","description":"Contact Name","isRequired":true,"uniqueKey":"address_data.ship_to_contact.name","typeLabel":"string"},"address_line1":{"type":"string","description":"Street Address","isRequired":true,"uniqueKey":"address_data.ship_to_contact.address_line1","typeLabel":"string"},"city":{"type":"string","description":"City Name","isRequired":true,"uniqueKey":"address_data.ship_to_contact.city","typeLabel":"string"},"province":{"type":"string","description":"Province","isRequired":true,"uniqueKey":"address_data.ship_to_contact.province","typeLabel":"string"},"country":{"type":"string","description":"Country","isRequired":true,"uniqueKey":"address_data.ship_to_contact.country","typeLabel":"string"},"zip":{"type":"string","description":"Postal Code","isRequired":true,"uniqueKey":"address_data.ship_to_contact.zip","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","description":"Address Line 2. Required for Dillard's.","uniqueKey":"address_data.ship_to_contact.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address Line 2. Required for Dillard's.","uniqueKey":"address_data.ship_to_contact.address_line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_data.ship_to_contact.address_line2","typeLabel":"string | null"},"facility_code":{"type":"string","description":"Facility Code","uniqueKey":"address_data.ship_to_contact.facility_code","typeLabel":"string"},"dc_number":{"type":"string","description":"DC number. Required for Chewy's, Vitamin Shoppe, Tractor Supply Co., CVS, UNFI, ULTA, Nordstrom, Walmart, TJX, Saks Fifth Avenue Store, Saks.com, SaksOffFifth.com, Saks Off Fifth Store, Von Maur, DICK's Sporting Goods, Macy's, and Dillards.","uniqueKey":"address_data.ship_to_contact.dc_number","typeLabel":"string"}},"required":["name","address_line1","city","province","country","zip"],"isRequired":true,"uniqueKey":"address_data.ship_to_contact","typeLabel":"object"},"bill_to_contact":{"description":"Required for Bloomingdales, Macy's Store, and Macy's.com","type":"object","properties":{"name":{"type":"string","description":"Contact Name. Required for Bloomingdales, Macy's Store, and Macy's.com","uniqueKey":"address_data.bill_to_contact.name","typeLabel":"string"},"address_line1":{"type":"string","description":"Street Address. Required for Bloomingdales, Macy's Store, and Macy's.com","uniqueKey":"address_data.bill_to_contact.address_line1","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","description":"Address Line 2","uniqueKey":"address_data.bill_to_contact.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address Line 2","uniqueKey":"address_data.bill_to_contact.address_line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_data.bill_to_contact.address_line2","typeLabel":"string | null"},"city":{"type":"string","description":"City Name. Required for Bloomingdales, Macy's Store, and Macy's.com","uniqueKey":"address_data.bill_to_contact.city","typeLabel":"string"},"province":{"type":"string","description":"Province. Required for Bloomingdales, Macy's Store, and Macy's.com","uniqueKey":"address_data.bill_to_contact.province","typeLabel":"string"},"country":{"type":"string","description":"Country. Required for Macy's Store and Macy's.com","uniqueKey":"address_data.bill_to_contact.country","typeLabel":"string"},"zip":{"type":"string","description":"Postal Code. Required for Bloomingdales, Macy's Store, and Macy's.com","uniqueKey":"address_data.bill_to_contact.zip","typeLabel":"string"},"facility_code":{"type":"string","description":"Facility Code","uniqueKey":"address_data.bill_to_contact.facility_code","typeLabel":"string"},"address_number":{"type":"string","description":"Address Number","uniqueKey":"address_data.bill_to_contact.address_number","typeLabel":"string"},"email":{"type":"string","format":"email","description":"Email address for the bill-to contact","uniqueKey":"address_data.bill_to_contact.email","typeLabel":"string\u003cemail>"}},"uniqueKey":"address_data.bill_to_contact","typeLabel":"object"},"mark_for_contact":{"type":"object","description":"Required for Saks Fifth Avenue Store, Saks.com, SaksOffFifth.com, Saks Off Fifth Store, Bloomingdales, and Dillards.","properties":{"name":{"type":"string","description":"Contact Name","uniqueKey":"address_data.mark_for_contact.name","typeLabel":"string"},"address_line1":{"type":"string","description":"Street Address","uniqueKey":"address_data.mark_for_contact.address_line1","typeLabel":"string"},"address_line2":{"oneOf":[{"type":"string","description":"Address Line 2","uniqueKey":"address_data.mark_for_contact.address_line2.oneOf.0","typeLabel":"string"},{"type":"null","description":"Address Line 2","uniqueKey":"address_data.mark_for_contact.address_line2.oneOf.1","typeLabel":"null"}],"uniqueKey":"address_data.mark_for_contact.address_line2","typeLabel":"string | null"},"city":{"type":"string","description":"City Name","uniqueKey":"address_data.mark_for_contact.city","typeLabel":"string"},"state":{"type":"string","description":"State","uniqueKey":"address_data.mark_for_contact.state","typeLabel":"string"},"country":{"type":"string","description":"Country","uniqueKey":"address_data.mark_for_contact.country","typeLabel":"string"},"zip":{"type":"string","description":"Postal Code","uniqueKey":"address_data.mark_for_contact.zip","typeLabel":"string"},"facility_code":{"type":"string","description":"Facility Code","uniqueKey":"address_data.mark_for_contact.facility_code","typeLabel":"string"},"address_number":{"type":"string","description":"Address Number. Required for Saks Fifth Avenue Store, Saks.com, SaksOffFifth.com, Saks Off Fifth Store, Bloomingdales, and Dillards.","uniqueKey":"address_data.mark_for_contact.address_number","typeLabel":"string"}},"uniqueKey":"address_data.mark_for_contact","typeLabel":"object"}},"required":["ship_to_contact"],"isRequired":true,"uniqueKey":"address_data","typeLabel":"object"},"external_order_id":{"type":"string","description":"External Order ID","example":"some-external-order-id","uniqueKey":"external_order_id","typeLabel":"string"},"dept_number":{"type":"string","description":"Department number. Required for Nordstrom, Walmart, TJX, Von Maur, DICK's Sporting Goods, Macy's, Dillard's, and Bloomingdales.","example":"123456","uniqueKey":"dept_number","typeLabel":"string"},"purchase_order_type":{"type":"string","description":"Type of purchase order. Required for Walmart, TJX, SaksOffFifth.com, Saks Off Fifth Store, DICK's Sporting Goods, Macy's Store, Macy's.com, and Bloomingdales","example":"Test Department","uniqueKey":"purchase_order_type","typeLabel":"string"},"transportation_method":{"type":"string","description":"Method of transportation","example":"FREIGHT","uniqueKey":"transportation_method","typeLabel":"string"},"carrier":{"type":"string","description":"Carrier","example":"Fedex Freight","uniqueKey":"carrier","typeLabel":"string"},"service_method":{"type":"string","description":"Service Method","enum":["ups_ground","fedex_ground"],"uniqueKey":"service_method","typeLabel":"enum\u003cstring>"},"dates":{"type":"object","properties":{"requested_delivery_date":{"type":"string","format":"date","example":"2024-08-15","uniqueKey":"dates.requested_delivery_date","typeLabel":"string\u003cdate>"},"earliest_delivery_date":{"type":"string","format":"date","example":"2024-08-10","uniqueKey":"dates.earliest_delivery_date","typeLabel":"string\u003cdate>"},"latest_delivery_date":{"type":"string","format":"date","example":"2024-08-20","uniqueKey":"dates.latest_delivery_date","typeLabel":"string\u003cdate>"},"earliest_ship_date":{"type":"string","format":"date","example":"2024-08-05","description":"Required for TJX and Ross.","uniqueKey":"dates.earliest_ship_date","typeLabel":"string\u003cdate>"},"latest_ship_date":{"type":"string","format":"date","example":"2024-08-12","description":"Required for Dillard's and Ross.","uniqueKey":"dates.latest_ship_date","typeLabel":"string\u003cdate>"},"cancel_by_date":{"type":"string","format":"date","example":"2024-08-25","uniqueKey":"dates.cancel_by_date","typeLabel":"string\u003cdate>"},"requested_ship_date":{"type":"string","format":"date","example":"2024-08-08","uniqueKey":"dates.requested_ship_date","typeLabel":"string\u003cdate>"},"stage_by":{"type":"string","format":"date","example":"2024-08-01","uniqueKey":"dates.stage_by","typeLabel":"string\u003cdate>"}},"uniqueKey":"dates","typeLabel":"object"}},"required":["facility_id","retailer_id","brand_id","picksheet_code","po_number","address_data","items"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"po_number":"some-po-number","picksheet_code":"some-picksheet-code","brand_id":"14e517b3-5091-4748-8a25-c497aec2ce98","retailer_id":"14e517b3-5091-4748-8a25-c497aec2ce98","facility_id":"14e517b3-5091-4748-8a25-c497aec2ce9z","items":[{"sku":"pillow-sku","upc":"pillow-upc","quantity":5,"case_pack_quantity":5,"case_barcode":"pillow-case-upc","vendor_pn":"vendor-part-number","description":"soft pillows"}],"address_data":{"ship_to_contact":{"name":"\u003cstring>","address_line1":"\u003cstring>","city":"\u003cstring>","province":"\u003cstring>","country":"\u003cstring>","zip":"\u003cstring>","address_line2":"\u003cstring>","facility_code":"\u003cstring>","dc_number":"\u003cstring>"},"bill_to_contact":{"name":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","city":"\u003cstring>","province":"\u003cstring>","country":"\u003cstring>","zip":"\u003cstring>","facility_code":"\u003cstring>","address_number":"\u003cstring>","email":"jsmith@example.com"},"mark_for_contact":{"name":"\u003cstring>","address_line1":"\u003cstring>","address_line2":"\u003cstring>","city":"\u003cstring>","state":"\u003cstring>","country":"\u003cstring>","zip":"\u003cstring>","facility_code":"\u003cstring>","address_number":"\u003cstring>"}},"external_order_id":"some-external-order-id","dept_number":"123456","purchase_order_type":"Test Department","transportation_method":"FREIGHT","carrier":"Fedex Freight","dates":{"requested_delivery_date":"2024-08-15","earliest_delivery_date":"2024-08-10","latest_delivery_date":"2024-08-20","earliest_ship_date":"2024-08-05","latest_ship_date":"2024-08-12","cancel_by_date":"2024-08-25","requested_ship_date":"2024-08-08","stage_by":"2024-08-01"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"8243f0e8-3218-4d51-83f0-0a19831fd5e9":{"description":"Order created successfully, with reason for being on hold if applicable","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Order created successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","example":{"order_id":"14e517b3-5091-4748-8a25-c497aec2ce98"},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Order created successfully","data":{"order_id":"14e517b3-5091-4748-8a25-c497aec2ce98"}}}},"exampleType":"generated"}},"exampleType":"generated"},"4aa1d71e-2600-4241-a2f5-63fd5de984cd":{"description":"Bad request - validation error","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Error message","uniqueKey":"message","typeLabel":"string"},"error":{"type":"object","properties":{"code":{"type":"string","example":"INVALID_REQUEST","uniqueKey":"error.code","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Failed to create order: picksheet_code is required","error":{"code":"INVALID_REQUEST"}},"examples":{"Example":{"title":"Example","value":{"message":"Failed to create order: picksheet_code is required","error":{"code":"INVALID_REQUEST"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"af716928-b62d-4124-85d7-ecd87a9aa1e9":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"b0a9942f-4aa8-4507-90f3-7921214d1752":{"url":"https://api.retailreadyai.com","description":"Production server"},"44674cc3-736c-4627-afbf-ef34b949c673":{"url":"https://stg.retailreadyai.com","description":"Staging server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"retailready-4b9f321b","siteName":"RetailReady","title":"Create Order - RetailReady","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-22T05:01:42.350Z","originalFileLocation":"api-reference/orders/create-order.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=\"system\"}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=\"Create a new order\">\u003cmeta data-mint-head name=\"application-name\" content=\"RetailReady\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Order - RetailReady\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new order\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"RetailReady\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.retailreadyai.com/api-reference/orders/create-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://retailready-4b9f321b.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+Order\u0026amp;description=Create+a+new+order\u0026amp;theme=7190ff78c4f09e1f8b66d889\u0026amp;signature=87928cbf5d422831e5a3d7788598c43550affa6915f1cee366ecc1b2e7d1ff77\">\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=\"Create Order - RetailReady\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new order\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://retailready-4b9f321b.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+Order\u0026amp;description=Create+a+new+order\u0026amp;theme=7190ff78c4f09e1f8b66d889\u0026amp;signature=87928cbf5d422831e5a3d7788598c43550affa6915f1cee366ecc1b2e7d1ff77\">\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/retailready-4b9f321b/nVeXC44jxg-aQhT4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"RetailReady\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.retailreadyai.com/api-reference/orders/create-order\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/orders/create-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.retailreadyai.com/#organization\",\"name\":\"RetailReady\",\"url\":\"https://docs.retailreadyai.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/retailready-4b9f321b/NGmGDHphxz3-Rlig/logo/light.svg?fit=max\u0026auto=format\u0026n=NGmGDHphxz3-Rlig\u0026q=85\u0026s=b0d22da72fa17f2463b8baf64ff868f1\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.retailreadyai.com#website\",\"name\":\"RetailReady\",\"url\":\"https://docs.retailreadyai.com\",\"publisher\":{\"@id\":\"https://docs.retailreadyai.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.retailreadyai.com/api-reference/orders/create-order#webpage\",\"url\":\"https://docs.retailreadyai.com/api-reference/orders/create-order\",\"name\":\"Create Order\",\"description\":\"Create a new order\",\"dateModified\":\"2026-10-22T05:01:42.350Z\",\"isPartOf\":{\"@id\":\"https://docs.retailreadyai.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.retailreadyai.com/api-reference/orders/create-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.retailreadyai.com/api-reference/orders/create-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"RetailReady\",\"item\":\"https://docs.retailreadyai.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Order\",\"item\":\"https://docs.retailreadyai.com/api-reference/orders/create-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.retailreadyai.com/api-reference/orders/create-order#apireference\",\"headline\":\"Create Order\",\"name\":\"Create Order\",\"description\":\"Create a new order\",\"url\":\"https://docs.retailreadyai.com/api-reference/orders/create-order\",\"mainEntityOfPage\":{\"@id\":\"https://docs.retailreadyai.com/api-reference/orders/create-order#webpage\"},\"dateModified\":\"2026-10-22T05:01:42.350Z\",\"publisher\":{\"@id\":\"https://docs.retailreadyai.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.retailreadyai.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"RetailReady\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"RetailReady","nav":{"global":null,"tabs":[{"tab":"API Reference","groups":[{"group":"API Documentation","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Authentication","pages":[{"title":"Authenticate","deprecated":null,"version":null,"openapi":"/openapi.json post /api/auth/token","href":"/api-reference/authentication/authenticate"}]},{"group":"Chargebacks","pages":[{"title":"Get Chargebacks","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/chargebacks","href":"/api-reference/chargebacks/get-chargebacks"}]},{"group":"Documents","pages":[{"title":"Attach BOL to an order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/documents/bol/{order_id}","href":"/api-reference/documents/attach-bol-to-an-order"},{"title":"Attach documents to an order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/documents/{order_id}","href":"/api-reference/documents/attach-documents-to-an-order"}]},{"group":"Facilities","pages":[{"title":"Get Facilities","deprecated":null,"version":null,"openapi":"/openapi.json get /api/user-facilities/v1/facilities","href":"/api-reference/facilities/get-facilities"}]},{"group":"Brands","pages":[{"title":"Get Brands","deprecated":null,"version":null,"openapi":"/openapi.json get /api/brand/v1/facility/{facility_id}","href":"/api-reference/brands/get-brands"}]},{"group":"Retailers","pages":[{"title":"Get Retailers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/retailer/v1/facility/{facility_id}?brand_id={brand_id}","href":"/api-reference/retailers/get-retailers"}]},{"group":"Item Master","pages":[{"title":"Item Master","description":"Upload or update item master data for SKUs","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/item-master","href":"/api-reference/item-master/item-master"}]},{"group":"Orders","pages":[{"title":"Create Order","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/orders/create","href":"/api-reference/orders/create-order"},{"title":"Change Facility","description":"Change the facility for an order","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/orders/change-facility","href":"/api-reference/orders/change-facility"},{"title":"Update Order","deprecated":null,"version":null,"openapi":"/openapi.json put /api/v1/orders","href":"/api-reference/orders/update-order"},{"title":"Get Order Details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/{order_id}","href":"/api-reference/orders/get-order-details"},{"title":"Get Orders Analytics Table v1","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/orders/analytics/table","href":"/api-reference/orders/get-orders-analytics-table-v1"},{"title":"Get Orders Analytics Table v2","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v2/orders/analytics/table/{facility_id}","href":"/api-reference/orders/get-orders-analytics-table-v2"},{"title":"Get Compliance Report Binary","deprecated":null,"version":null,"openapi":"/openapi.json get /api/orders/compliance_report/binary/{order_id}","href":"/api-reference/orders/get-compliance-report-binary"}]},{"group":"Inventory","pages":[{"title":"Send Inventory Advice","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory/brand/{brand_id}/facility/{facility_id}","href":"/api-reference/inventory/send-inventory-advice"},{"title":"Send Inventory Advice (Brand)","deprecated":null,"version":null,"openapi":"/openapi.json post /api/v1/inventory/brand","href":"/api-reference/inventory/send-inventory-advice-brand"}]},{"group":"POS Reports","pages":[{"title":"Get POS Reports","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/pos-reports","href":"/api-reference/pos-reports/get-pos-reports"}]},{"group":"Fintech","pages":[{"title":"Get Fintech Invoices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/fintech/invoices","href":"/api-reference/fintech/get-fintech-invoices"},{"title":"Get Fintech Invoice Order Details","deprecated":null,"version":null,"openapi":"/openapi.json get /api/v1/fintech/invoice-order-details","href":"/api-reference/fintech/get-fintech-invoice-order-details"}]},{"group":"Transactions","pages":[{"title":"List Transactions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/transactions","href":"/api-reference/transactions/list-transactions"}]}]}]},"basePath":"","title":"Create Order - RetailReady","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}