Partner's order identifier. Within a product, the combination of partner_order_id and payment_method_id uniquely identifies an order. Submitting the same combination again when creating an order updates the existing order and returns its existing id. The same partner_order_id may be used with a different payment_method_id to create a separate order.
Example:
"o-c8a1fe46bbff4a18ba1d"
total_order_amount
integer
required
Total order amount ($2,699.99 + $50.00)
Example:
274999
id
string
Unique identifier for the order
Example:
"77f60af4-185e-4867-b113-34e3cf7c6acd"
customer_id
string
Customer identifier
Example:
"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5"
merchant_id
string | null
Merchant identifier
Example:
"m-123456789"
merchant_name
string | null
Merchant name
Example:
"Rest Assured"
merchant_address
object[]
List of merchant addresses
Show child attributes
order_lines
object[]
An array of items that make up the order, used for the purpose of establishing the items, amounts, and rewards that are expected to be included in events sent to Imprint following order creation.
Changes made to orders after the order is created can be implicitly communicated to Imprint through the event creation process following the creation of the order; modifying the order itself is not necessary. The set of events sent to Imprint after order creation serve as the final source of truth for transaction amounts, rewards, order lines, etc.
When provided, the API will require that the calculated sum of all the rates and rewards rates within (taking quantities into account) are equal to the total_order_amount and total_rewards_amount, respectively.
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
Example:
"USD"
created_at
string<date-time> | null
The RFC-3339 timestamp when the order was created
Example:
"2025-02-13T19:08:07Z"
updated_at
string<date-time> | null
The RFC-3339 timestamp when the order was last updated
Example:
"2025-02-13T19:08:07Z"
Response
Orders created successfully
payment_method_id
string
required
Payment method identifier
Example:
"0144ea84-3c39-4382-a37a-03c699b77646"
partner_order_id
string
required
Partner's order identifier. Within a product, the combination of partner_order_id and payment_method_id uniquely identifies an order. Submitting the same combination again when creating an order updates the existing order and returns its existing id. The same partner_order_id may be used with a different payment_method_id to create a separate order.
Example:
"o-c8a1fe46bbff4a18ba1d"
total_order_amount
integer
required
Total order amount ($2,699.99 + $50.00)
Example:
274999
id
string
Unique identifier for the order
Example:
"77f60af4-185e-4867-b113-34e3cf7c6acd"
customer_id
string
Customer identifier
Example:
"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5"
merchant_id
string | null
Merchant identifier
Example:
"m-123456789"
merchant_name
string | null
Merchant name
Example:
"Rest Assured"
merchant_address
object[]
List of merchant addresses
Show child attributes
order_lines
object[]
An array of items that make up the order, used for the purpose of establishing the items, amounts, and rewards that are expected to be included in events sent to Imprint following order creation.
Changes made to orders after the order is created can be implicitly communicated to Imprint through the event creation process following the creation of the order; modifying the order itself is not necessary. The set of events sent to Imprint after order creation serve as the final source of truth for transaction amounts, rewards, order lines, etc.
When provided, the API will require that the calculated sum of all the rates and rewards rates within (taking quantities into account) are equal to the total_order_amount and total_rewards_amount, respectively.
The 3-character currency code of the amount in ISO 4217 format (e.g., "USD")
Example:
"USD"
created_at
string<date-time> | null
The RFC-3339 timestamp when the order was created
Example:
"2025-02-13T19:08:07Z"
updated_at
string<date-time> | null
The RFC-3339 timestamp when the order was last updated
Example:
"2025-02-13T19:08:07Z"
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Imprint Docs","colors":{"primary":"#020617","light":"#f8fafc","dark":"#020617"},"logo":{"light":"https://mintcdn.com/imprint-b3c5d5af/GTTTLmLM2i2SHfnY/logo/light.svg?fit=max\u0026auto=format\u0026n=GTTTLmLM2i2SHfnY\u0026q=85\u0026s=7c676246bb9fdaf339146e71d49b1e8a","dark":"https://mintcdn.com/imprint-b3c5d5af/I4GuH_Pw48YRP5iO/logo/dark.svg?fit=max\u0026auto=format\u0026n=I4GuH_Pw48YRP5iO\u0026q=85\u0026s=9feb729eb397fb8f30bf6fdf6f12d66d"},"favicon":"https://mintcdn.com/imprint-b3c5d5af/qERKh6EsF76Eeygl/favicon.svg?fit=max\u0026auto=format\u0026n=qERKh6EsF76Eeygl\u0026q=85\u0026s=5b51787a4dd2c11812a29292ce04d058","navbar":{"links":[],"primary":{"type":"button","label":"Support","href":"https://portal.imprint.co/"}},"footer":{"socials":{}},"fonts":{"heading":{"family":"Universal Sans Bold","source":"https://d21kjopteuokfb.cloudfront.net/imprint/assets/fonts/universal-sans/UniversalSans-v1-2-0-100-0-221221212111-11-825.woff","format":"woff"},"body":{"family":"Universal Sans","source":"https://d21kjopteuokfb.cloudfront.net/imprint/assets/fonts/universal-sans/UniversalSans-v1-2-0-100-0-221221212111-11-500.woff","format":"woff"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"imprint-b3c5d5af","hasAudioNarration":false,"actualSubdomain":"imprint-b3c5d5af","customDomains":["docs.imprint.co"],"gitSource":{"type":"github","owner":"imprint-tech","repo":"go-backend","deployBranch":"main","contentDirectory":"partner/docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":false,"issues":false,"edits":false},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afe2cc31be5dbcd89206575","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"REST API","count":104},{"language":"default","tag":"API Reference","count":104},{"language":"default","tag":"Documentation","count":29},{"language":"default","tag":"Customers","count":24},{"language":"default","tag":"Webhooks","count":14},{"language":"default","tag":"Payment Methods","count":10},{"language":"default","tag":"Rewards","count":9},{"language":"default","tag":"Orders","count":8},{"language":"default","tag":"Transaction Intents","count":8},{"language":"default","tag":"Getting Started","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":"/* vietnamese */\n@font-face {\n font-family: 'Work Sans';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/worksans/v24/QGYqz_wNahGAdqQ43Rh_eZDkv_1w4A.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Work Sans';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/worksans/v24/QGYqz_wNahGAdqQ43Rh_eZDlv_1w4A.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Work Sans';\n font-style: italic;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/worksans/v24/QGYqz_wNahGAdqQ43Rh_eZDrv_0.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\n/* vietnamese */\n@font-face {\n font-family: 'Work Sans';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/worksans/v24/QGYsz_wNahGAdqQ43Rh_c6Dpp_k.woff2) format('woff2');\n unicode-range: U+0102-0103, U+0110-0111, U+0128-0129, U+0168-0169, U+01A0-01A1, U+01AF-01B0, U+0300-0301, U+0303-0304, U+0308-0309, U+0323, U+0329, U+1EA0-1EF9, U+20AB;\n}\n/* latin-ext */\n@font-face {\n font-family: 'Work Sans';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/worksans/v24/QGYsz_wNahGAdqQ43Rh_cqDpp_k.woff2) format('woff2');\n unicode-range: U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF, U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C4, U+2113, U+2C60-2C7F, U+A720-A7FF;\n}\n/* latin */\n@font-face {\n font-family: 'Work Sans';\n font-style: normal;\n font-weight: 100 900;\n font-display: swap;\n src: url(/_mintlify/assets/fonts/google/s/worksans/v24/QGYsz_wNahGAdqQ43Rh_fKDp.woff2) format('woff2');\n unicode-range: U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329, U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;\n}\nbody{font-feature-settings:normal;font-family:\"Universal Sans\", \"Work Sans\", Arial, sans-serif}h1,h2,h3,h4,h5,h6{font-family:\"Universal Sans Bold\", \"Work Sans\", Arial, sans-serif}footer a{display:none}"}]}
{"page":{"pagePath":"api-reference/orders/create-orders","slug":"/api-reference/orders/create-orders","pageMetadata":{"title":"Create orders","description":"Create new orders.\n\n**Required scope:** `ORDER_WRITE`\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/orders","href":"/api-reference/orders/create-orders","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Create new orders.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Required scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"ORDER_WRITE\"\n })]\n })]\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 orders","description":"Create new orders.\n\n**Required scope:** `ORDER_WRITE`\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/orders","href":"/api-reference/orders/create-orders","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Orders"],"summary":"Create orders","description":"Create new orders.\n\n**Required scope:** `ORDER_WRITE`\n","operationId":"createOrder","x-required-scopes":["ORDER_WRITE"],"requestBody":"85f0b1f7-daa3-4c13-b7c0-968124ce809c","responses":{"200":"7777184f-5057-4b3c-af48-b170d1cd4b7d","403":"54f3955f-f2c0-47f2-b481-cf5b211f059f"},"method":"post","type":"path","servers":["7ab050e9-05d7-4ba3-ae94-012ff5fc25b8"],"security":["17aaca94-a614-404c-9249-df416a588694","711101d4-27a5-4c7a-835c-65ffeab8038a"],"path":"/v2/orders","baseUrlOptions":["https://dev.sbx.imprint.co"],"title":"Create orders","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["payment_method_id","total_order_amount","partner_order_id"],"properties":{"payment_method_id":{"type":"string","description":"Payment method identifier","example":"0144ea84-3c39-4382-a37a-03c699b77646","isRequired":true,"uniqueKey":"payment_method_id","typeLabel":"string"},"partner_order_id":{"type":"string","description":"Partner's order identifier. Within a product, the combination of `partner_order_id` and `payment_method_id` uniquely identifies an order. Submitting the same combination again when creating an order updates the existing order and returns its existing `id`. The same `partner_order_id` may be used with a different `payment_method_id` to create a separate order.","example":"o-c8a1fe46bbff4a18ba1d","isRequired":true,"uniqueKey":"partner_order_id","typeLabel":"string"},"total_order_amount":{"type":"integer","description":"Total order amount ($2,699.99 + $50.00)","example":274999,"isRequired":true,"uniqueKey":"total_order_amount","typeLabel":"integer"},"id":{"type":"string","description":"Unique identifier for the order","example":"77f60af4-185e-4867-b113-34e3cf7c6acd","uniqueKey":"id","typeLabel":"string"},"customer_id":{"type":"string","description":"Customer identifier","example":"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5","uniqueKey":"customer_id","typeLabel":"string"},"merchant_id":{"oneOf":[{"type":"string","description":"Merchant identifier","example":"m-123456789","uniqueKey":"merchant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant identifier","example":"m-123456789","uniqueKey":"merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_id","typeLabel":"string | null"},"merchant_name":{"oneOf":[{"type":"string","description":"Merchant name","example":"Rest Assured","uniqueKey":"merchant_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant name","example":"Rest Assured","uniqueKey":"merchant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_name","typeLabel":"string | null"},"merchant_address":{"type":"array","items":{"type":"object","description":"Mailing address information","properties":{"street_line1":{"type":"string","description":"Primary street address","example":"123 Main St","uniqueKey":"merchant_address.items.[INDEX].street_line1","typeLabel":"string"},"street_line2":{"type":"string","description":"Secondary street address (apartment, suite, etc.)","example":"Apt 4B","uniqueKey":"merchant_address.items.[INDEX].street_line2","typeLabel":"string"},"city":{"type":"string","description":"City name","example":"San Francisco","uniqueKey":"merchant_address.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","description":"State or province","example":"CA","uniqueKey":"merchant_address.items.[INDEX].state","typeLabel":"string"},"postal_code":{"type":"string","examples":["94105","94105-1234"],"uniqueKey":"merchant_address.items.[INDEX].postal_code","typeLabel":"string"},"country":{"type":"string","description":"ISO-3166-1 alpha-3 Country Code","example":"USA","uniqueKey":"merchant_address.items.[INDEX].country","typeLabel":"string"}},"uniqueKey":"merchant_address.items.[INDEX]","typeLabel":"object"},"description":"List of merchant addresses","uniqueKey":"merchant_address","typeLabel":"object[]"},"order_lines":{"type":"array","items":{"type":"object","required":["name","quantity","rate","rewards_rate"],"properties":{"name":{"type":"string","description":"Name of the order line item","example":"Couch Supreme","isRequired":true,"uniqueKey":"order_lines.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantity of the item","example":1,"isRequired":true,"uniqueKey":"order_lines.items.[INDEX].quantity","typeLabel":"integer"},"rate":{"type":"integer","description":"Amount in the smallest currency unit (e.g., cents for USD)","example":274999,"isRequired":true,"uniqueKey":"order_lines.items.[INDEX].rate","typeLabel":"integer"},"rewards_rate":{"type":"integer","description":"Amount in the smallest currency unit (e.g., cents for USD)","example":2500,"isRequired":true,"uniqueKey":"order_lines.items.[INDEX].rewards_rate","typeLabel":"integer"},"product_url":{"oneOf":[{"type":"string","description":"URL to the product","example":"www.restassured.com/couch-supreme","uniqueKey":"order_lines.items.[INDEX].product_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to the product","example":"www.restassured.com/couch-supreme","uniqueKey":"order_lines.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_lines.items.[INDEX].product_url","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","description":"URL to an image of the product","example":"https://cdn.restassured.com/couch-supreme.jpg","uniqueKey":"order_lines.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to an image of the product","example":"https://cdn.restassured.com/couch-supreme.jpg","uniqueKey":"order_lines.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_lines.items.[INDEX].image_url","typeLabel":"string | null"}},"uniqueKey":"order_lines.items.[INDEX]","typeLabel":"object"},"description":"An array of items that make up the order, used for the purpose of establishing the items, amounts, and rewards that are *expected* to be included in events sent to Imprint following order creation.\nChanges made to orders after the order is created can be implicitly communicated to Imprint through the event creation process following the creation of the order; modifying the order itself is not necessary. The set of events sent to Imprint after order creation serve as the final source of truth for transaction amounts, rewards, order lines, etc.\nWhen provided, the API will require that the calculated sum of all the rates and rewards rates within (taking quantities into account) are equal to the `total_order_amount` and `total_rewards_amount`, respectively.","example":[{"name":"Couch Supreme","product_url":"www.restassured.com/couch-supreme","image_url":"https://cdn.restassured.com/couch-supreme.jpg","quantity":1,"rate":274999,"rewards_rate":2500}],"uniqueKey":"order_lines","typeLabel":"object[]"},"total_rewards_amount":{"type":"integer","description":"Total rewards amount ($25 + $0)","example":2500,"uniqueKey":"total_rewards_amount","typeLabel":"integer"},"currency":{"type":"string","description":"The 3-character currency code of the amount in ISO 4217 format (e.g., \"USD\")","example":"USD","uniqueKey":"currency","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The RFC-3339 timestamp when the order was created","example":"2025-02-13T19:08:07Z","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The RFC-3339 timestamp when the order was created","example":"2025-02-13T19:08:07Z","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The RFC-3339 timestamp when the order was last updated","example":"2025-02-13T19:08:07Z","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The RFC-3339 timestamp when the order was last updated","example":"2025-02-13T19:08:07Z","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_method_id":"0144ea84-3c39-4382-a37a-03c699b77646","partner_order_id":"o-c8a1fe46bbff4a18ba1d","total_order_amount":274999,"id":"77f60af4-185e-4867-b113-34e3cf7c6acd","customer_id":"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5","merchant_id":"m-123456789","merchant_name":"Rest Assured","merchant_address":[{"street_line1":"123 Main St","street_line2":"Apt 4B","city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"}],"order_lines":[{"name":"Couch Supreme","product_url":"www.restassured.com/couch-supreme","image_url":"https://cdn.restassured.com/couch-supreme.jpg","quantity":1,"rate":274999,"rewards_rate":2500}],"total_rewards_amount":2500,"currency":"USD","created_at":"2025-02-13T19:08:07Z","updated_at":"2025-02-13T19:08:07Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"7777184f-5057-4b3c-af48-b170d1cd4b7d":{"description":"Orders created successfully","content":{"application/json":{"schema":{"type":"object","required":["payment_method_id","total_order_amount","partner_order_id"],"properties":{"payment_method_id":{"type":"string","description":"Payment method identifier","example":"0144ea84-3c39-4382-a37a-03c699b77646","isRequired":true,"uniqueKey":"payment_method_id","typeLabel":"string"},"partner_order_id":{"type":"string","description":"Partner's order identifier. Within a product, the combination of `partner_order_id` and `payment_method_id` uniquely identifies an order. Submitting the same combination again when creating an order updates the existing order and returns its existing `id`. The same `partner_order_id` may be used with a different `payment_method_id` to create a separate order.","example":"o-c8a1fe46bbff4a18ba1d","isRequired":true,"uniqueKey":"partner_order_id","typeLabel":"string"},"total_order_amount":{"type":"integer","description":"Total order amount ($2,699.99 + $50.00)","example":274999,"isRequired":true,"uniqueKey":"total_order_amount","typeLabel":"integer"},"id":{"type":"string","description":"Unique identifier for the order","example":"77f60af4-185e-4867-b113-34e3cf7c6acd","uniqueKey":"id","typeLabel":"string"},"customer_id":{"type":"string","description":"Customer identifier","example":"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5","uniqueKey":"customer_id","typeLabel":"string"},"merchant_id":{"oneOf":[{"type":"string","description":"Merchant identifier","example":"m-123456789","uniqueKey":"merchant_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant identifier","example":"m-123456789","uniqueKey":"merchant_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_id","typeLabel":"string | null"},"merchant_name":{"oneOf":[{"type":"string","description":"Merchant name","example":"Rest Assured","uniqueKey":"merchant_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"Merchant name","example":"Rest Assured","uniqueKey":"merchant_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"merchant_name","typeLabel":"string | null"},"merchant_address":{"type":"array","items":{"type":"object","description":"Mailing address information","properties":{"street_line1":{"type":"string","description":"Primary street address","example":"123 Main St","uniqueKey":"merchant_address.items.[INDEX].street_line1","typeLabel":"string"},"street_line2":{"type":"string","description":"Secondary street address (apartment, suite, etc.)","example":"Apt 4B","uniqueKey":"merchant_address.items.[INDEX].street_line2","typeLabel":"string"},"city":{"type":"string","description":"City name","example":"San Francisco","uniqueKey":"merchant_address.items.[INDEX].city","typeLabel":"string"},"state":{"type":"string","description":"State or province","example":"CA","uniqueKey":"merchant_address.items.[INDEX].state","typeLabel":"string"},"postal_code":{"type":"string","examples":["94105","94105-1234"],"uniqueKey":"merchant_address.items.[INDEX].postal_code","typeLabel":"string"},"country":{"type":"string","description":"ISO-3166-1 alpha-3 Country Code","example":"USA","uniqueKey":"merchant_address.items.[INDEX].country","typeLabel":"string"}},"uniqueKey":"merchant_address.items.[INDEX]","typeLabel":"object"},"description":"List of merchant addresses","uniqueKey":"merchant_address","typeLabel":"object[]"},"order_lines":{"type":"array","items":{"type":"object","required":["name","quantity","rate","rewards_rate"],"properties":{"name":{"type":"string","description":"Name of the order line item","example":"Couch Supreme","isRequired":true,"uniqueKey":"order_lines.items.[INDEX].name","typeLabel":"string"},"quantity":{"type":"integer","description":"Quantity of the item","example":1,"isRequired":true,"uniqueKey":"order_lines.items.[INDEX].quantity","typeLabel":"integer"},"rate":{"type":"integer","description":"Amount in the smallest currency unit (e.g., cents for USD)","example":274999,"isRequired":true,"uniqueKey":"order_lines.items.[INDEX].rate","typeLabel":"integer"},"rewards_rate":{"type":"integer","description":"Amount in the smallest currency unit (e.g., cents for USD)","example":2500,"isRequired":true,"uniqueKey":"order_lines.items.[INDEX].rewards_rate","typeLabel":"integer"},"product_url":{"oneOf":[{"type":"string","description":"URL to the product","example":"www.restassured.com/couch-supreme","uniqueKey":"order_lines.items.[INDEX].product_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to the product","example":"www.restassured.com/couch-supreme","uniqueKey":"order_lines.items.[INDEX].product_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_lines.items.[INDEX].product_url","typeLabel":"string | null"},"image_url":{"oneOf":[{"type":"string","description":"URL to an image of the product","example":"https://cdn.restassured.com/couch-supreme.jpg","uniqueKey":"order_lines.items.[INDEX].image_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL to an image of the product","example":"https://cdn.restassured.com/couch-supreme.jpg","uniqueKey":"order_lines.items.[INDEX].image_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"order_lines.items.[INDEX].image_url","typeLabel":"string | null"}},"uniqueKey":"order_lines.items.[INDEX]","typeLabel":"object"},"description":"An array of items that make up the order, used for the purpose of establishing the items, amounts, and rewards that are *expected* to be included in events sent to Imprint following order creation.\nChanges made to orders after the order is created can be implicitly communicated to Imprint through the event creation process following the creation of the order; modifying the order itself is not necessary. The set of events sent to Imprint after order creation serve as the final source of truth for transaction amounts, rewards, order lines, etc.\nWhen provided, the API will require that the calculated sum of all the rates and rewards rates within (taking quantities into account) are equal to the `total_order_amount` and `total_rewards_amount`, respectively.","example":[{"name":"Couch Supreme","product_url":"www.restassured.com/couch-supreme","image_url":"https://cdn.restassured.com/couch-supreme.jpg","quantity":1,"rate":274999,"rewards_rate":2500}],"uniqueKey":"order_lines","typeLabel":"object[]"},"total_rewards_amount":{"type":"integer","description":"Total rewards amount ($25 + $0)","example":2500,"uniqueKey":"total_rewards_amount","typeLabel":"integer"},"currency":{"type":"string","description":"The 3-character currency code of the amount in ISO 4217 format (e.g., \"USD\")","example":"USD","uniqueKey":"currency","typeLabel":"string"},"created_at":{"oneOf":[{"type":"string","format":"date-time","description":"The RFC-3339 timestamp when the order was created","example":"2025-02-13T19:08:07Z","uniqueKey":"created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The RFC-3339 timestamp when the order was created","example":"2025-02-13T19:08:07Z","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string\u003cdate-time> | null"},"updated_at":{"oneOf":[{"type":"string","format":"date-time","description":"The RFC-3339 timestamp when the order was last updated","example":"2025-02-13T19:08:07Z","uniqueKey":"updated_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"The RFC-3339 timestamp when the order was last updated","example":"2025-02-13T19:08:07Z","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"payment_method_id":"0144ea84-3c39-4382-a37a-03c699b77646","partner_order_id":"o-c8a1fe46bbff4a18ba1d","total_order_amount":274999,"id":"77f60af4-185e-4867-b113-34e3cf7c6acd","customer_id":"1bb0ab64-ed57-4f2f-bd8d-ab04d1a365c5","merchant_id":"m-123456789","merchant_name":"Rest Assured","merchant_address":[{"street_line1":"123 Main St","street_line2":"Apt 4B","city":"San Francisco","state":"CA","postal_code":"94105","country":"USA"}],"order_lines":[{"name":"Couch Supreme","product_url":"www.restassured.com/couch-supreme","image_url":"https://cdn.restassured.com/couch-supreme.jpg","quantity":1,"rate":274999,"rewards_rate":2500}],"total_rewards_amount":2500,"currency":"USD","created_at":"2025-02-13T19:08:07Z","updated_at":"2025-02-13T19:08:07Z"}}},"exampleType":"generated"}},"exampleType":"generated"},"54f3955f-f2c0-47f2-b481-cf5b211f059f":{"description":"API key is missing the required `ORDER_WRITE` scope","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["type","message"],"properties":{"type":{"type":"string","description":"The category of error being returned","example":"BAD_REQUEST_ERROR","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A message describing the cause of the error","example":"unsupported reward_type: INVALID, must be STATEMENT or DELAYED","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"type":"BAD_REQUEST_ERROR","message":"unsupported reward_type: INVALID, must be STATEMENT or DELAYED"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"17aaca94-a614-404c-9249-df416a588694":{"basicAuth":{"type":"http","scheme":"basic","description":"Basic HTTP authentication. Allowed headers-- Authorization: Basic \u003cbase64(api_key_id:api_key_secret)>","scopes":[],"schemeName":"basicAuth"}},"711101d4-27a5-4c7a-835c-65ffeab8038a":{"bearerAuth":{"bearerFormat":"auth-scheme","description":"Bearer HTTP authentication. Allowed headers-- Authorization: Bearer \u003capi_key>","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"7ab050e9-05d7-4ba3-ae94-012ff5fc25b8":{"url":"https://dev.sbx.imprint.co","description":"Imprint public api sandbox"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic HTTP authentication. Allowed headers-- Authorization: Basic \u003cbase64(api_key_id:api_key_secret)>","scopes":[],"schemeName":"basicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic HTTP authentication. Allowed headers-- Authorization: Basic \u003cbase64(api_key_id:api_key_secret)>","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"basicAuth","name":"Authorization"}],"title":"basicAuth"},{"schemes":[{"scheme":{"bearerFormat":"auth-scheme","description":"Bearer HTTP authentication. Allowed headers-- Authorization: Bearer \u003capi_key>","scheme":"bearer","type":"http","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer HTTP authentication. Allowed headers-- Authorization: Bearer \u003capi_key>","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"imprint-b3c5d5af","siteName":"Imprint Docs","title":"Create orders - Imprint Docs","navMaps":{"firstHrefInVersion":{"2026-10-13":{"href":"/api-reference/orders/create-orders","matchLevel":0},"2025-05-05":{"href":"/api-reference/2025-05-05/customers/search-for-customers","matchLevel":2}},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T15:21:00.592Z","originalFileLocation":"api-reference/orders/create-orders.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 new orders. Required scope: ORDER_WRITE\">\u003cmeta data-mint-head name=\"application-name\" content=\"Imprint Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create orders - Imprint Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create new orders. Required scope: ORDER_WRITE\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Imprint Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.imprint.co/api-reference/orders/create-orders\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://imprint-b3c5d5af.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+orders\u0026amp;description=Create+new+orders.%0A%0A**Required+scope%3A**+%60ORDER_WRITE%60%0A\u0026amp;theme=8981e6064ed63cdb27711b8b\u0026amp;signature=820cd3ab657ee50a3f9bfbc9908c7969676c5be424a7dfae5d1952106dcd7aae\">\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 orders - Imprint Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create new orders. Required scope: ORDER_WRITE\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://imprint-b3c5d5af.mintlify.site/_mintlify/api/og/v2?division=Orders\u0026amp;title=Create+orders\u0026amp;description=Create+new+orders.%0A%0A**Required+scope%3A**+%60ORDER_WRITE%60%0A\u0026amp;theme=8981e6064ed63cdb27711b8b\u0026amp;signature=820cd3ab657ee50a3f9bfbc9908c7969676c5be424a7dfae5d1952106dcd7aae\">\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/imprint-b3c5d5af/YpGUGkagpLHsflMS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Imprint Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#020617\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.imprint.co/api-reference/orders/create-orders\">\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-orders.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.imprint.co/#organization\",\"name\":\"Imprint Docs\",\"url\":\"https://docs.imprint.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/imprint-b3c5d5af/GTTTLmLM2i2SHfnY/logo/light.svg?fit=max\u0026auto=format\u0026n=GTTTLmLM2i2SHfnY\u0026q=85\u0026s=7c676246bb9fdaf339146e71d49b1e8a\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.imprint.co#website\",\"name\":\"Imprint Docs\",\"url\":\"https://docs.imprint.co\",\"publisher\":{\"@id\":\"https://docs.imprint.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.imprint.co/api-reference/orders/create-orders#webpage\",\"url\":\"https://docs.imprint.co/api-reference/orders/create-orders\",\"name\":\"Create orders\",\"description\":\"Create new orders. Required scope: ORDER_WRITE\",\"dateModified\":\"2026-11-06T15:21:00.592Z\",\"isPartOf\":{\"@id\":\"https://docs.imprint.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.imprint.co/api-reference/orders/create-orders#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.imprint.co/api-reference/orders/create-orders#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.imprint.co/api-reference/customers/search-for-customers\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Orders\",\"item\":\"https://docs.imprint.co/api-reference/orders/retrieve-orders\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create orders\",\"item\":\"https://docs.imprint.co/api-reference/orders/create-orders\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.imprint.co/api-reference/orders/create-orders#apireference\",\"headline\":\"Create orders\",\"name\":\"Create orders\",\"description\":\"Create new orders. Required scope: ORDER_WRITE\",\"url\":\"https://docs.imprint.co/api-reference/orders/create-orders\",\"mainEntityOfPage\":{\"@id\":\"https://docs.imprint.co/api-reference/orders/create-orders#webpage\"},\"dateModified\":\"2026-11-06T15:21:00.592Z\",\"publisher\":{\"@id\":\"https://docs.imprint.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.imprint.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Imprint Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Imprint Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/orders/create-orders.md","siteName":"Imprint Docs","nav":{"global":null,"versions":[{"version":"2026-10-13","tag":"Current","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/welcome"}]},{"tab":"REST API","groups":[{"group":"API Reference","pages":[{"group":"Customers","pages":[{"title":"Search for customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers","href":"/api-reference/customers/search-for-customers"},{"title":"Search for customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/customers","href":"/api-reference/customers/search-for-customers-1"},{"title":"Retrieve a customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}","href":"/api-reference/customers/retrieve-a-customer"},{"title":"List a customer's accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/accounts","href":"/api-reference/customers/list-a-customers-accounts"},{"title":"Get customer's account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/accounts/{account_id}","href":"/api-reference/customers/get-customers-account"},{"title":"List an account's reward categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/accounts/{account_id}/rewards_categories","href":"/api-reference/customers/list-an-accounts-reward-categories"},{"title":"List an account's statements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/accounts/{account_id}/statements","href":"/api-reference/customers/list-an-accounts-statements"},{"title":"Get customer's current rewards balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/rewards_balance","href":"/api-reference/customers/get-customers-current-rewards-balance"},{"title":"List customer's payment methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/payment_methods","href":"/api-reference/customers/list-customers-payment-methods"},{"title":"List customer's transaction intents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/transaction_intents","href":"/api-reference/customers/list-customers-transaction-intents"},{"title":"List customer's transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/transactions","href":"/api-reference/customers/list-customers-transactions"},{"title":"List customer's rewards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customers/{customer_id}/rewards","href":"/api-reference/customers/list-customers-rewards"}]},{"group":"Customer Links","pages":[{"title":"Link an Imprint customer and partner customer accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/customers/{customer_id}/link","href":"/api-reference/customer-links/link-an-imprint-customer-and-partner-customer-accounts"},{"title":"Update the partner customer ID of a customer link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v2/customers/{customer_id}/link","href":"/api-reference/customer-links/update-the-partner-customer-id-of-a-customer-link"}]},{"group":"Customer Sessions","pages":[{"title":"Create a new customer session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/customer_sessions","href":"/api-reference/customer-sessions/create-a-new-customer-session"},{"title":"Retrieve a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/customer_sessions/{session_id}","href":"/api-reference/customer-sessions/retrieve-a-session"}]},{"group":"Payment Methods","pages":[{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/payment_methods","href":"/api-reference/payment-methods/list-payment-methods"},{"title":"List payment methods","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/payment_methods","href":"/api-reference/payment-methods/list-payment-methods-1"},{"title":"Retrieve a payment method","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/payment_methods/{payment_method_id}","href":"/api-reference/payment-methods/retrieve-a-payment-method"},{"title":"Add a payment method to a device wallet","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/payment_methods/{payment_method_id}/provision/{wallet}","href":"/api-reference/payment-methods/add-a-payment-method-to-a-device-wallet"},{"title":"Retrieve a payment method's card design","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/payment_methods/{payment_method_id}/card_design","href":"/api-reference/payment-methods/retrieve-a-payment-methods-card-design"}]},{"group":"Transaction Intents","pages":[{"title":"List transaction intents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/transaction_intents","href":"/api-reference/transaction-intents/list-transaction-intents"},{"title":"Create a transaction intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/transaction_intents","href":"/api-reference/transaction-intents/create-a-transaction-intent"},{"title":"Retrieve a transaction intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/transaction_intents/{intent_id}","href":"/api-reference/transaction-intents/retrieve-a-transaction-intent"},{"title":"Update a transaction intent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/transaction_intents/{intent_id}","href":"/api-reference/transaction-intents/update-a-transaction-intent"}]},{"group":"Transactions","pages":[{"title":"Retrieve a transaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/transactions/{transaction_id}","href":"/api-reference/transactions/retrieve-a-transaction"}]},{"group":"Rewards","pages":[{"title":"Search for rewards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/rewards","href":"/api-reference/rewards/search-for-rewards"},{"title":"List the product's reward categories","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/rewards/rewards_categories","href":"/api-reference/rewards/list-the-products-reward-categories"},{"title":"Retrieve a reward","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/rewards/{reward_id}","href":"/api-reference/rewards/retrieve-a-reward"},{"title":"Updates a reward","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v2/rewards/{reward_id}","href":"/api-reference/rewards/updates-a-reward"}]},{"group":"Card Designs","pages":[{"title":"List card designs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/card_designs","href":"/api-reference/card-designs/list-card-designs"},{"title":"Retrieve a card design","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/card_designs/{card_design_id}","href":"/api-reference/card-designs/retrieve-a-card-design"},{"title":"Update a card design","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v2/card_designs/{card_design_id}","href":"/api-reference/card-designs/update-a-card-design"}]},{"group":"Order Events","pages":[{"title":"Retrieve order events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/order_events","href":"/api-reference/order-events/retrieve-order-events"},{"title":"Create order events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/order_events","href":"/api-reference/order-events/create-order-events"},{"title":"Delete order event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v2/order_events/{order_event_id}","href":"/api-reference/order-events/delete-order-event"}]},{"group":"Orders","pages":[{"title":"Retrieve orders","description":"Get a list of orders.\n\n**Required scope:** `ORDER_READ`\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v2/orders","href":"/api-reference/orders/retrieve-orders"},{"title":"Create orders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/orders","href":"/api-reference/orders/create-orders"},{"title":"Modify order","description":"Modify an existing order.\n\n**Required scope:** `ORDER_WRITE`\n","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v2/orders/{order_id}","href":"/api-reference/orders/modify-order"},{"title":"Delete order","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v2/orders/{order_id}","href":"/api-reference/orders/delete-order"}]},{"group":"Simulate Transaction Event","pages":[{"title":"Simulate transaction event in sandbox environment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/simulate_transaction_event","href":"/api-reference/simulate-transaction-event/simulate-transaction-event-in-sandbox-environment"}]},{"group":"Simulate Statement Reward","pages":[{"title":"Simulate Statement Reward","deprecated":true,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/simulate_statement_reward","href":"/api-reference/simulate-statement-reward/simulate-statement-reward"}]},{"group":"Simulate Reward","pages":[{"title":"Simulate Reward","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/simulate_reward","href":"/api-reference/simulate-reward/simulate-reward"}]},{"group":"Keys","pages":[{"title":"Create an API Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v2/keys","href":"/api-reference/keys/create-an-api-key"},{"title":"Delete an API Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v2/keys","href":"/api-reference/keys/delete-an-api-key"}]},{"group":"Webhooks","pages":[{"title":"Application event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook Application","href":"/api-reference/webhooks/application-event-notification"},{"title":"Transaction event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook Transaction","href":"/api-reference/webhooks/transaction-event-notification"},{"title":"Payment method event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook PaymentMethod","href":"/api-reference/webhooks/payment-method-event-notification"},{"title":"Customer link event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook CustomerLink","href":"/api-reference/webhooks/customer-link-event-notification"},{"title":"Reward event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook Reward","href":"/api-reference/webhooks/reward-event-notification"},{"title":"Streak event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook Streak","href":"/api-reference/webhooks/streak-event-notification"},{"title":"Account status event notification","version":null,"deprecated":null,"openapi":"/api-reference/openapi.yaml webhook AccountStatus","href":"/api-reference/webhooks/account-status-event-notification"}]}]}]}]},{"version":"2025-05-05","pages":[{"title":"2025-05-05","href":"/api-reference/2025-05-05/customers/search-for-customers"}]}]},"basePath":"","title":"Create orders - Imprint Docs","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}