Sync an order to Redo so your shoppers can return it.
This is the returns integration path for commerce platforms Redo does not
support directly. Orders pushed here become returnable: the shopper can look
up the order in the return portal, and Redo uses the line items, discounts,
and taxes you send to decide what is eligible for return and what to refund.
Syncing the same order ID again updates the existing Redo order, so this is
safe to call on every order create and update.
For a walkthrough of the full integration, including field-by-field mapping
and a complete example payload, see the
Custom Returns Integration guide.
Important: If Redo protection is attached to this order, include a line item with:
vendor: “re:do”
sku: “x-redo”
tags: “returns”, “package protection”, or “both”
properties: _redo_type with value “return”, “package protection”, or “both”
If you priced coverage with a Coverage Products quote instead, send
coverage: { purchased: true, quoteId } with the quote’s id.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
storeId
string
required
Store ID
Example:
"64e5a8a1af49a89df37e4ee7"
Body
application/json
An order synced into Redo so it can be returned.
Redo reads the line items, discounts, and taxes below to decide what the
shopper is allowed to return and what to refund, so send the values that were
actually charged.
Note: If Redo is attached to this order, you must add a single line item with:
vendor: "re:do"
sku: "x-redo"
Include the price of Redo as the line item price
In tags, include: "returns", "package protection", or "both"
In properties, include _redo_type with value: "return", "package protection", or "both"
id
string
required
Order ID in external system
type
enum<string>
required
Type of resource (must be "order")
Available options:
order
createdAt
string
required
Order creation timestamp
presentmentCurrency
string
required
Currency shown to customer
shopCurrency
string
required
Shop's base currency
customer
Customer · object
required
Customer information
Show child attributes
lineItems
Custom Order Line Item · object[]
required
Order line items. Line item IDs must be unique within an order.
Show child attributes
orderDiscounts
Discount · object[]
required
Order-level discounts (not line item or shipping discounts)
Show child attributes
shippingLines
Custom Order Shipping Line · object[]
required
Shipping methods
Show child attributes
fulfillments
Custom Order Fulfillment · object[]
required
Order fulfillments
Show child attributes
shippingAddress
Shipping Address · object
required
Shipping address
Show child attributes
updatedAt
string
required
Last update timestamp
billingAddress
Billing Address · object | null
Billing address
Show child attributes
salesChannel
string | null
Sales channel where order was placed
source
enum<string> | null
The integration that sent this order, when Redo has a dedicated integration for it. Leave it out for orders from your own system.
Available options:
TeamworkCommerce,
null
tags
string[]
Order tags
metafields
Custom Order Metafield · object[]
Namespaced key-value pairs for the order as a whole.
Show child attributes
cancelledAt
string | null
Timestamp the order was cancelled in your system. Omit or send null for live orders. A cancelled order is recorded with a voided financial status and stops producing order tracking updates.
cancelReason
enum<string> | null
Why the order was cancelled. Optional, even when cancelled.
Available options:
customer,
fraud,
inventory,
declined,
other,
staff,
null
Example:
"customer"
transactions
Custom Order Transaction · object[]
Payment transactions
Show child attributes
refunds
Custom Order Refund · object[]
Refunds already issued against this order. Redo uses them to work out what has already been returned to the shopper and to derive the order's financial status. Send the full set on every sync.
Show child attributes
coverage
Coverage · object
Redo coverage the shopper bought at checkout, priced by a Coverage
Products quote.
Set purchased: true with the id from the Coverage Products response
as quoteId. Redo checks that the order's line items match the quoted
cart and that the order is eligible for every quoted coverage type, and
answers 400 if not. Once a quote is bound to the order, later syncs keep
it, even if they omit coverage or send purchased: false.
Use this or the Redo coverage line item, not both. An order with a Redo
coverage line item is billed from that line item.
Show child attributes
Response
Order synced successfully
Response returned when an order is synced successfully
message
string
required
Always "Order synced successfully"
orderId
string
required
The order ID you supplied in the request body
redoId
string
required
The Redo order ID for the synced order
Was this page helpful?
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Redo","colors":{"primary":"#FF4405","light":"#FF4405","dark":"#1b1b1b"},"logo":{"light":"https://mintcdn.com/redo-44af351d/KtmWeYG860C3iLpm/docs/logo/light.svg?fit=max\u0026auto=format\u0026n=KtmWeYG860C3iLpm\u0026q=85\u0026s=d7d25c69bed7e16ea3f3ad1334492765","dark":"https://mintcdn.com/redo-44af351d/KtmWeYG860C3iLpm/docs/logo/dark.svg?fit=max\u0026auto=format\u0026n=KtmWeYG860C3iLpm\u0026q=85\u0026s=20a39501a0e50b6d8040a4d1c6b5bf1c"},"favicon":"https://mintcdn.com/redo-44af351d/bJ_qKygAPDy-o3KA/docs/favicon.ico?fit=max\u0026auto=format\u0026n=bJ_qKygAPDy-o3KA\u0026q=85\u0026s=cbe6e872979f1e3bedec3eabcd7d5641","api":{"openapi":"api-schema/openapi.yaml"},"background":{"decoration":"windows"},"navbar":{"links":[{"href":"https://app.getredo.com","label":"Dashboard"}],"primary":{"type":"button","label":"Get a Demo","href":"https://redo.com/en/demo"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/redo-tech","website":"https://redo.com"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"redo-44af351d","hasAudioNarration":false,"actualSubdomain":"redo-44af351d","customDomains":["developers.redo.com"],"gitSource":{"type":"gitlab","owner":"redo/redoapp/product","repo":"developer-docs-site","deployBranch":"main","contentDirectory":"","isPrivate":true,"projectId":87173070,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6af8a5128ab36739304354f5","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"API Reference","count":1047},{"language":"default","tag":"Reference","count":976},{"language":"default","tag":"Objects","count":586},{"language":"default","tag":"Marketing","count":205},{"language":"default","tag":"Mutations","count":199},{"language":"default","tag":"Queries","count":188},{"language":"default","tag":"Checkout","count":168},{"language":"default","tag":"Support","count":122},{"language":"default","tag":"Shipping","count":81},{"language":"default","tag":"Integrations","count":61}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/returns-custom-integration/sync-custom-order","slug":"/api-reference/returns-custom-integration/sync-custom-order","pageMetadata":{"title":"Sync Custom Order","description":"Sync an order to Redo so your shoppers can return it.\n\nThis is the returns integration path for commerce platforms Redo does not\nsupport directly. Orders pushed here become returnable: the shopper can look\nup the order in the return portal, and Redo uses the line items, discounts,\nand taxes you send to decide what is eligible for return and what to refund.\n\nSyncing the same order ID again updates the existing Redo order, so this is\nsafe to call on every order create and update.\n\nFor a walkthrough of the full integration, including field-by-field mapping\nand a complete example payload, see the\n[Custom Returns Integration guide](/docs/guides/integrations/custom-returns-integration).\n\nImportant: If Redo protection is attached to this order, include a line item with:\n- vendor: \"re:do\"\n- sku: \"x-redo\"\n- tags: \"returns\", \"package protection\", or \"both\"\n- properties: _redo_type with value \"return\", \"package protection\", or \"both\"\n\nIf you priced coverage with a Coverage Products quote instead, send\n`coverage: { purchased: true, quoteId }` with the quote's `id`.\n","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/custom/orders","href":"/api-reference/returns-custom-integration/sync-custom-order","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 a: \"a\",\n code: \"code\",\n li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Sync an order to Redo so your shoppers can return it.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"This is the returns integration path for commerce platforms Redo does not\\nsupport directly. Orders pushed here become returnable: the shopper can look\\nup the order in the return portal, and Redo uses the line items, discounts,\\nand taxes you send to decide what is eligible for return and what to refund.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Syncing the same order ID again updates the existing Redo order, so this is\\nsafe to call on every order create and update.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For a walkthrough of the full integration, including field-by-field mapping\\nand a complete example payload, see the\\n\", _jsx(_components.a, {\n href: \"/docs/guides/integrations/custom-returns-integration\",\n children: \"Custom Returns Integration guide\"\n }), \".\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"Important: If Redo protection is attached to this order, include a line item with:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"vendor: “re:do”\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"sku: “x-redo”\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"tags: “returns”, “package protection”, or “both”\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"properties: _redo_type with value “return”, “package protection”, or “both”\"\n }), \"\\n\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"If you priced coverage with a Coverage Products quote instead, send\\n\", _jsx(_components.code, {\n children: \"coverage: { purchased: true, quoteId }\"\n }), \" with the quote’s \", _jsx(_components.code, {\n children: \"id\"\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":"Sync Custom Order","description":"Sync an order to Redo so your shoppers can return it.\n\nThis is the returns integration path for commerce platforms Redo does not\nsupport directly. Orders pushed here become returnable: the shopper can look\nup the order in the return portal, and Redo uses the line items, discounts,\nand taxes you send to decide what is eligible for return and what to refund.\n\nSyncing the same order ID again updates the existing Redo order, so this is\nsafe to call on every order create and update.\n\nFor a walkthrough of the full integration, including field-by-field mapping\nand a complete example payload, see the\n[Custom Returns Integration guide](/docs/guides/integrations/custom-returns-integration).\n\nImportant: If Redo protection is attached to this order, include a line item with:\n- vendor: \"re:do\"\n- sku: \"x-redo\"\n- tags: \"returns\", \"package protection\", or \"both\"\n- properties: _redo_type with value \"return\", \"package protection\", or \"both\"\n\nIf you priced coverage with a Coverage Products quote instead, send\n`coverage: { purchased: true, quoteId }` with the quote's `id`.\n","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/custom/orders","href":"/api-reference/returns-custom-integration/sync-custom-order","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"description":"Sync an order to Redo so your shoppers can return it.\n\nThis is the returns integration path for commerce platforms Redo does not\nsupport directly. Orders pushed here become returnable: the shopper can look\nup the order in the return portal, and Redo uses the line items, discounts,\nand taxes you send to decide what is eligible for return and what to refund.\n\nSyncing the same order ID again updates the existing Redo order, so this is\nsafe to call on every order create and update.\n\nFor a walkthrough of the full integration, including field-by-field mapping\nand a complete example payload, see the\n[Custom Returns Integration guide](/docs/guides/integrations/custom-returns-integration).\n\nImportant: If Redo protection is attached to this order, include a line item with:\n- vendor: \"re:do\"\n- sku: \"x-redo\"\n- tags: \"returns\", \"package protection\", or \"both\"\n- properties: _redo_type with value \"return\", \"package protection\", or \"both\"\n\nIf you priced coverage with a Coverage Products quote instead, send\n`coverage: { purchased: true, quoteId }` with the quote's `id`.\n","operationId":"Custom Order Sync","parameters":["10e68a8b-9625-438a-9471-cbebae6710d7"],"requestBody":"24f4dd96-c7c0-4fd5-b650-00c34f52ff4b","responses":{"200":"c6d8aa97-12d8-4062-8f72-572d6f04dcef","400":"6dea72eb-22c2-4f65-8521-80d1324872d6","401":"08b2adf4-a667-461e-89ec-5fa8949d0139","403":"a708fb34-83ed-4334-bb09-3ea440edabd0","404":"0d59b191-826c-4f98-a481-18fe47ff94bb","500":"b6475768-4d8c-47af-987d-f28ad4720fde","default":"b40a9afa-61df-49d7-a582-451b34bf6d71"},"security":["624aaace-dca5-4072-9983-fad107596153"],"summary":"Sync Custom Order","tags":["Returns Custom Integration"],"method":"post","type":"path","servers":["f0381a4e-06ae-4d7c-ae97-6567cce9d9a5"],"path":"/stores/{storeId}/custom/orders","baseUrlOptions":["https://api.getredo.com/v2.2"],"title":"Sync Custom Order","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"10e68a8b-9625-438a-9471-cbebae6710d7":{"description":"Store ID","in":"path","name":"storeId","required":true,"schema":{"example":"64e5a8a1af49a89df37e4ee7","type":"string","isRequired":true,"description":"Store ID","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"description":"An order synced into Redo so it can be returned.\n\nRedo reads the line items, discounts, and taxes below to decide what the\nshopper is allowed to return and what to refund, so send the values that were\nactually charged.\n\nNote: If Redo is attached to this order, you must add a single line item with:\n- vendor: \"re:do\"\n- sku: \"x-redo\"\n- Include the price of Redo as the line item price\n- In tags, include: \"returns\", \"package protection\", or \"both\"\n- In properties, include _redo_type with value: \"return\", \"package protection\", or \"both\"\n","properties":{"id":{"description":"Order ID in external system","title":"ID","type":"string","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"type":{"description":"Type of resource (must be \"order\")","enum":["order"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"createdAt":{"description":"Order creation timestamp","title":"Created At","type":"string","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string"},"presentmentCurrency":{"description":"Currency shown to customer","title":"Presentment Currency","type":"string","isRequired":true,"uniqueKey":"presentmentCurrency","typeLabel":"string"},"shopCurrency":{"description":"Shop's base currency","title":"Shop Currency","type":"string","isRequired":true,"uniqueKey":"shopCurrency","typeLabel":"string"},"customer":{"description":"Customer information","properties":{"email":{"description":"Customer email address","format":"email","title":"Email","type":"string","isRequired":true,"uniqueKey":"customer.email","typeLabel":"string\u003cemail>"},"firstName":{"description":"Customer first name","title":"First Name","type":"string","isRequired":true,"uniqueKey":"customer.firstName","typeLabel":"string"},"lastName":{"description":"Customer last name","title":"Last Name","type":"string","isRequired":true,"uniqueKey":"customer.lastName","typeLabel":"string"},"phone":{"oneOf":[{"description":"Customer phone number","title":"Phone","type":"string","uniqueKey":"customer.phone.oneOf.0","typeLabel":"string"},{"description":"Customer phone number","title":"Phone","type":"null","uniqueKey":"customer.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"customer.phone","typeLabel":"string | null"},"id":{"description":"Customer ID in external system","title":"ID","type":"string","uniqueKey":"customer.id","typeLabel":"string"},"tags":{"default":[],"description":"Tags associated with customer","items":{"type":"string","uniqueKey":"customer.tags.items.[INDEX]","typeLabel":"string"},"title":"Tags","type":"array","uniqueKey":"customer.tags","typeLabel":"string[]"}},"required":["email","firstName","lastName"],"title":"Customer","type":"object","isRequired":true,"uniqueKey":"customer","typeLabel":"Customer · object"},"lineItems":{"description":"Order line items. Line item IDs must be unique within an order.","items":{"description":"Line item for custom order integration","properties":{"id":{"description":"Line item ID","title":"ID","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].id","typeLabel":"string"},"quantity":{"description":"Quantity ordered","title":"Quantity","type":"number","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].quantity","typeLabel":"number"},"priceSet":{"description":"Line item price (pre-tax and pre-discount)","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Price Set","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].priceSet","typeLabel":"Price Set · object"},"title":{"description":"Line item title","title":"Title","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].title","typeLabel":"string"},"productId":{"description":"Product ID","title":"Product ID","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].productId","typeLabel":"string"},"sku":{"description":"SKU (use \"x-redo\" for Redo line items)","title":"SKU","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].sku","typeLabel":"string"},"returnableQuantity":{"oneOf":[{"description":"Quantity that can be returned","title":"Returnable Quantity","type":"number","uniqueKey":"lineItems.items.[INDEX].returnableQuantity.oneOf.0","typeLabel":"number"},{"description":"Quantity that can be returned","title":"Returnable Quantity","type":"null","uniqueKey":"lineItems.items.[INDEX].returnableQuantity.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].returnableQuantity","typeLabel":"number | null"},"variantTitle":{"oneOf":[{"description":"Product variant title","title":"Variant Title","type":"string","uniqueKey":"lineItems.items.[INDEX].variantTitle.oneOf.0","typeLabel":"string"},{"description":"Product variant title","title":"Variant Title","type":"null","uniqueKey":"lineItems.items.[INDEX].variantTitle.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].variantTitle","typeLabel":"string | null"},"vendor":{"oneOf":[{"description":"Product vendor (use \"re:do\" for Redo line items)","title":"Vendor","type":"string","uniqueKey":"lineItems.items.[INDEX].vendor.oneOf.0","typeLabel":"string"},{"description":"Product vendor (use \"re:do\" for Redo line items)","title":"Vendor","type":"null","uniqueKey":"lineItems.items.[INDEX].vendor.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].vendor","typeLabel":"string | null"},"fulfillmentService":{"oneOf":[{"description":"Fulfillment service","title":"Fulfillment Service","type":"string","uniqueKey":"lineItems.items.[INDEX].fulfillmentService.oneOf.0","typeLabel":"string"},{"description":"Fulfillment service","title":"Fulfillment Service","type":"null","uniqueKey":"lineItems.items.[INDEX].fulfillmentService.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].fulfillmentService","typeLabel":"string | null"},"variantId":{"oneOf":[{"description":"Variant ID","title":"Variant ID","type":"string","uniqueKey":"lineItems.items.[INDEX].variantId.oneOf.0","typeLabel":"string"},{"description":"Variant ID","title":"Variant ID","type":"null","uniqueKey":"lineItems.items.[INDEX].variantId.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].variantId","typeLabel":"string | null"},"additionalProductId":{"oneOf":[{"description":"Additional product ID","title":"Additional Product ID","type":"string","uniqueKey":"lineItems.items.[INDEX].additionalProductId.oneOf.0","typeLabel":"string"},{"description":"Additional product ID","title":"Additional Product ID","type":"null","uniqueKey":"lineItems.items.[INDEX].additionalProductId.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].additionalProductId","typeLabel":"string | null"},"properties":{"default":[],"description":"Custom properties for line item","items":{"description":"Property associated with a line item","properties":{"name":{"description":"Property name","title":"Name","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].properties.items.[INDEX].name","typeLabel":"string"},"value":{"description":"Property value","title":"Value","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].properties.items.[INDEX].value","typeLabel":"string"}},"required":["name","value"],"title":"Line Item Property","type":"object","uniqueKey":"lineItems.items.[INDEX].properties.items.[INDEX]","typeLabel":"Line Item Property · object"},"title":"Properties","type":"array","uniqueKey":"lineItems.items.[INDEX].properties","typeLabel":"Line Item Property · object[]"},"tags":{"default":[],"description":"Tags (use \"returns\", \"package protection\", or \"both\" for Redo items)","items":{"type":"string","uniqueKey":"lineItems.items.[INDEX].tags.items.[INDEX]","typeLabel":"string"},"title":"Tags","type":"array","uniqueKey":"lineItems.items.[INDEX].tags","typeLabel":"string[]"},"metafields":{"description":"Namespaced key-value pairs for this line item. Redo stores them on the order line and reads them for return flow conditions, withdrawal exclusions, and coverage exclusion rules, which reference a metafield as `namespace.key`.","items":{"description":"Namespaced key-value pair carried through to Redo","properties":{"namespace":{"description":"Metafield namespace","title":"Namespace","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].metafields.items.[INDEX].namespace","typeLabel":"string"},"key":{"description":"Metafield key","title":"Key","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].metafields.items.[INDEX].key","typeLabel":"string"},"value":{"description":"Metafield value, sent as a string","title":"Value","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].metafields.items.[INDEX].value","typeLabel":"string"}},"required":["namespace","key","value"],"title":"Custom Order Metafield","type":"object","uniqueKey":"lineItems.items.[INDEX].metafields.items.[INDEX]","typeLabel":"Custom Order Metafield · object"},"title":"Metafields","type":"array","uniqueKey":"lineItems.items.[INDEX].metafields","typeLabel":"Custom Order Metafield · object[]"},"weight":{"oneOf":[{"description":"Item weight. `value` is stored as grams, so send the weight in grams.","properties":{"value":{"description":"Weight in grams","type":"number","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].weight.oneOf.0.value","typeLabel":"number"},"unit":{"description":"Unit label. Recorded for reference only; `value` is always read as grams.","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].weight.oneOf.0.unit","typeLabel":"string"}},"required":["value","unit"],"title":"Weight","type":"object","uniqueKey":"lineItems.items.[INDEX].weight.oneOf.0","typeLabel":"Weight · object"},{"description":"Item weight. `value` is stored as grams, so send the weight in grams.","properties":{"value":{"description":"Weight in grams","type":"number"},"unit":{"description":"Unit label. Recorded for reference only; `value` is always read as grams.","type":"string"}},"required":["value","unit"],"title":"Weight","type":"null","uniqueKey":"lineItems.items.[INDEX].weight.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].weight","typeLabel":"Weight · object | null"},"image":{"oneOf":[{"description":"Primary image URL. This is the image Redo displays for the item.","title":"Image","type":"string","uniqueKey":"lineItems.items.[INDEX].image.oneOf.0","typeLabel":"string"},{"description":"Primary image URL. This is the image Redo displays for the item.","title":"Image","type":"null","uniqueKey":"lineItems.items.[INDEX].image.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].image","typeLabel":"string | null"},"images":{"default":[],"description":"Additional images. Accepted but not currently displayed by Redo.","items":{"description":"Image associated with a line item","properties":{"url":{"description":"Image URL","title":"URL","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].images.items.[INDEX].url","typeLabel":"string"},"data":{"oneOf":[{"description":"Base64 encoded image data","title":"Data","type":"string","uniqueKey":"lineItems.items.[INDEX].images.items.[INDEX].data.oneOf.0","typeLabel":"string"},{"description":"Base64 encoded image data","title":"Data","type":"null","uniqueKey":"lineItems.items.[INDEX].images.items.[INDEX].data.oneOf.1","typeLabel":"null"}],"uniqueKey":"lineItems.items.[INDEX].images.items.[INDEX].data","typeLabel":"string | null"}},"required":["url"],"title":"Line Item Image","type":"object","uniqueKey":"lineItems.items.[INDEX].images.items.[INDEX]","typeLabel":"Line Item Image · object"},"title":"Images","type":"array","uniqueKey":"lineItems.items.[INDEX].images","typeLabel":"Line Item Image · object[]"},"discounts":{"default":[],"description":"Discounts applied (should account for quantity)","items":{"description":"Discount applied to order or line item","properties":{"amountSet":{"description":"Discount amount","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Amount Set","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].amountSet","typeLabel":"Amount Set · object"},"discountId":{"description":"Unique identifier for the discount","title":"Discount ID","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].discountId","typeLabel":"string"},"discountTitle":{"description":"Title/name of the discount","title":"Discount Title","type":"string","uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].discountTitle","typeLabel":"string"},"discountCode":{"description":"Code used to apply the discount","title":"Discount Code","type":"string","uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX].discountCode","typeLabel":"string"}},"required":["amountSet","discountId"],"title":"Discount","type":"object","uniqueKey":"lineItems.items.[INDEX].discounts.items.[INDEX]","typeLabel":"Discount · object"},"title":"Discounts","type":"array","uniqueKey":"lineItems.items.[INDEX].discounts","typeLabel":"Discount · object[]"},"taxLines":{"default":[],"description":"Tax lines (should account for quantity)","items":{"description":"Tax line item","properties":{"priceSet":{"description":"Tax amount","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Price Set","type":"object","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].priceSet","typeLabel":"Price Set · object"},"rate":{"oneOf":[{"description":"Tax rate as a decimal string. Send null when the rate is unknown.","title":"Rate","type":"string","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].rate.oneOf.0","typeLabel":"string"},{"description":"Tax rate as a decimal string. Send null when the rate is unknown.","title":"Rate","type":"null","isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].rate","typeLabel":"string | null"},"title":{"description":"Tax title/name. Defaults to \"Tax\" when omitted.","title":"Title","type":"string","uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX].title","typeLabel":"string"}},"required":["priceSet","rate"],"title":"Tax Line","type":"object","uniqueKey":"lineItems.items.[INDEX].taxLines.items.[INDEX]","typeLabel":"Tax Line · object"},"title":"Tax Lines","type":"array","uniqueKey":"lineItems.items.[INDEX].taxLines","typeLabel":"Tax Line · object[]"}},"required":["id","quantity","priceSet","title","productId","sku"],"title":"Custom Order Line Item","type":"object","uniqueKey":"lineItems.items.[INDEX]","typeLabel":"Custom Order Line Item · object"},"title":"Line Items","type":"array","isRequired":true,"uniqueKey":"lineItems","typeLabel":"Custom Order Line Item · object[]"},"orderDiscounts":{"description":"Order-level discounts (not line item or shipping discounts)","items":{"description":"Discount applied to order or line item","properties":{"amountSet":{"description":"Discount amount","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Amount Set","type":"object","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].amountSet","typeLabel":"Amount Set · object"},"discountId":{"description":"Unique identifier for the discount","title":"Discount ID","type":"string","isRequired":true,"uniqueKey":"orderDiscounts.items.[INDEX].discountId","typeLabel":"string"},"discountTitle":{"description":"Title/name of the discount","title":"Discount Title","type":"string","uniqueKey":"orderDiscounts.items.[INDEX].discountTitle","typeLabel":"string"},"discountCode":{"description":"Code used to apply the discount","title":"Discount Code","type":"string","uniqueKey":"orderDiscounts.items.[INDEX].discountCode","typeLabel":"string"}},"required":["amountSet","discountId"],"title":"Discount","type":"object","uniqueKey":"orderDiscounts.items.[INDEX]","typeLabel":"Discount · object"},"title":"Order Discounts","type":"array","isRequired":true,"uniqueKey":"orderDiscounts","typeLabel":"Discount · object[]"},"shippingLines":{"description":"Shipping methods","items":{"description":"Shipping line for custom order integration","properties":{"id":{"description":"Shipping line ID","title":"ID","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].id","typeLabel":"string"},"title":{"description":"Shipping method title","title":"Title","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].title","typeLabel":"string"},"priceSet":{"description":"Shipping price (pre-tax and pre-discount)","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Price Set","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].priceSet","typeLabel":"Price Set · object"},"code":{"description":"Shipping method code","title":"Code","type":"string","uniqueKey":"shippingLines.items.[INDEX].code","typeLabel":"string"},"discounts":{"default":[],"description":"Discounts applied to shipping","items":{"description":"Discount applied to order or line item","properties":{"amountSet":{"description":"Discount amount","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Amount Set","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].amountSet","typeLabel":"Amount Set · object"},"discountId":{"description":"Unique identifier for the discount","title":"Discount ID","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].discountId","typeLabel":"string"},"discountTitle":{"description":"Title/name of the discount","title":"Discount Title","type":"string","uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].discountTitle","typeLabel":"string"},"discountCode":{"description":"Code used to apply the discount","title":"Discount Code","type":"string","uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX].discountCode","typeLabel":"string"}},"required":["amountSet","discountId"],"title":"Discount","type":"object","uniqueKey":"shippingLines.items.[INDEX].discounts.items.[INDEX]","typeLabel":"Discount · object"},"title":"Discounts","type":"array","uniqueKey":"shippingLines.items.[INDEX].discounts","typeLabel":"Discount · object[]"},"taxLines":{"default":[],"description":"Tax lines for shipping","items":{"description":"Tax line item","properties":{"priceSet":{"description":"Tax amount","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Price Set","type":"object","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].priceSet","typeLabel":"Price Set · object"},"rate":{"oneOf":[{"description":"Tax rate as a decimal string. Send null when the rate is unknown.","title":"Rate","type":"string","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].rate.oneOf.0","typeLabel":"string"},{"description":"Tax rate as a decimal string. Send null when the rate is unknown.","title":"Rate","type":"null","isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].rate.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].rate","typeLabel":"string | null"},"title":{"description":"Tax title/name. Defaults to \"Tax\" when omitted.","title":"Title","type":"string","uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX].title","typeLabel":"string"}},"required":["priceSet","rate"],"title":"Tax Line","type":"object","uniqueKey":"shippingLines.items.[INDEX].taxLines.items.[INDEX]","typeLabel":"Tax Line · object"},"title":"Tax Lines","type":"array","uniqueKey":"shippingLines.items.[INDEX].taxLines","typeLabel":"Tax Line · object[]"}},"required":["id","title","priceSet"],"title":"Custom Order Shipping Line","type":"object","uniqueKey":"shippingLines.items.[INDEX]","typeLabel":"Custom Order Shipping Line · object"},"title":"Shipping Lines","type":"array","isRequired":true,"uniqueKey":"shippingLines","typeLabel":"Custom Order Shipping Line · object[]"},"fulfillments":{"description":"Order fulfillments","items":{"description":"Fulfillment information for custom order integration","properties":{"id":{"description":"Fulfillment ID","title":"ID","type":"string","isRequired":true,"uniqueKey":"fulfillments.items.[INDEX].id","typeLabel":"string"},"lineItems":{"description":"Line items included in this fulfillment","items":{"description":"Line item reference in fulfillment","properties":{"id":{"description":"Line item ID","title":"ID","type":"string","isRequired":true,"uniqueKey":"fulfillments.items.[INDEX].lineItems.items.[INDEX].id","typeLabel":"string"},"quantity":{"description":"Quantity fulfilled","title":"Quantity","type":"number","isRequired":true,"uniqueKey":"fulfillments.items.[INDEX].lineItems.items.[INDEX].quantity","typeLabel":"number"}},"required":["id","quantity"],"title":"Fulfillment Line Item","type":"object","uniqueKey":"fulfillments.items.[INDEX].lineItems.items.[INDEX]","typeLabel":"Fulfillment Line Item · object"},"title":"Line Items","type":"array","isRequired":true,"uniqueKey":"fulfillments.items.[INDEX].lineItems","typeLabel":"Fulfillment Line Item · object[]"},"trackingNumbers":{"default":[],"description":"Tracking numbers for this fulfillment","items":{"description":"Tracking number information","properties":{"trackingNumber":{"description":"Tracking number","title":"Tracking Number","type":"string","isRequired":true,"uniqueKey":"fulfillments.items.[INDEX].trackingNumbers.items.[INDEX].trackingNumber","typeLabel":"string"},"carrier":{"oneOf":[{"description":"Shipping carrier","title":"Carrier","type":"string","uniqueKey":"fulfillments.items.[INDEX].trackingNumbers.items.[INDEX].carrier.oneOf.0","typeLabel":"string"},{"description":"Shipping carrier","title":"Carrier","type":"null","uniqueKey":"fulfillments.items.[INDEX].trackingNumbers.items.[INDEX].carrier.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillments.items.[INDEX].trackingNumbers.items.[INDEX].carrier","typeLabel":"string | null"}},"required":["trackingNumber"],"title":"Tracking Number","type":"object","uniqueKey":"fulfillments.items.[INDEX].trackingNumbers.items.[INDEX]","typeLabel":"Tracking Number · object"},"title":"Tracking Numbers","type":"array","uniqueKey":"fulfillments.items.[INDEX].trackingNumbers","typeLabel":"Tracking Number · object[]"},"trackingUrls":{"default":[],"description":"Tracking URLs","items":{"type":"string","uniqueKey":"fulfillments.items.[INDEX].trackingUrls.items.[INDEX]","typeLabel":"string"},"title":"Tracking URLs","type":"array","uniqueKey":"fulfillments.items.[INDEX].trackingUrls","typeLabel":"string[]"},"shippingDate":{"oneOf":[{"description":"Date when shipment was sent","title":"Shipping Date","type":"string","uniqueKey":"fulfillments.items.[INDEX].shippingDate.oneOf.0","typeLabel":"string"},{"description":"Date when shipment was sent","title":"Shipping Date","type":"null","uniqueKey":"fulfillments.items.[INDEX].shippingDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillments.items.[INDEX].shippingDate","typeLabel":"string | null"},"deliveryDate":{"oneOf":[{"description":"Date when shipment was delivered","title":"Delivery Date","type":"string","uniqueKey":"fulfillments.items.[INDEX].deliveryDate.oneOf.0","typeLabel":"string"},{"description":"Date when shipment was delivered","title":"Delivery Date","type":"null","uniqueKey":"fulfillments.items.[INDEX].deliveryDate.oneOf.1","typeLabel":"null"}],"uniqueKey":"fulfillments.items.[INDEX].deliveryDate","typeLabel":"string | null"}},"required":["id","lineItems"],"title":"Custom Order Fulfillment","type":"object","uniqueKey":"fulfillments.items.[INDEX]","typeLabel":"Custom Order Fulfillment · object"},"title":"Fulfillments","type":"array","isRequired":true,"uniqueKey":"fulfillments","typeLabel":"Custom Order Fulfillment · object[]"},"shippingAddress":{"description":"Shipping address","properties":{"address1":{"description":"Address line 1","title":"Address Line 1","type":"string","isRequired":true,"uniqueKey":"shippingAddress.address1","typeLabel":"string"},"city":{"description":"City","title":"City","type":"string","isRequired":true,"uniqueKey":"shippingAddress.city","typeLabel":"string"},"provinceCode":{"description":"Province or state code","title":"Province Code","type":"string","isRequired":true,"uniqueKey":"shippingAddress.provinceCode","typeLabel":"string"},"zip":{"description":"Postal/ZIP code","title":"ZIP","type":"string","isRequired":true,"uniqueKey":"shippingAddress.zip","typeLabel":"string"},"countryCode":{"description":"Country code (ISO)","title":"Country Code","type":"string","isRequired":true,"uniqueKey":"shippingAddress.countryCode","typeLabel":"string"},"address2":{"oneOf":[{"description":"Address line 2","title":"Address Line 2","type":"string","uniqueKey":"shippingAddress.address2.oneOf.0","typeLabel":"string"},{"description":"Address line 2","title":"Address Line 2","type":"null","uniqueKey":"shippingAddress.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.address2","typeLabel":"string | null"},"company":{"oneOf":[{"description":"Company name","title":"Company","type":"string","uniqueKey":"shippingAddress.company.oneOf.0","typeLabel":"string"},{"description":"Company name","title":"Company","type":"null","uniqueKey":"shippingAddress.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.company","typeLabel":"string | null"},"firstName":{"oneOf":[{"description":"First name","title":"First Name","type":"string","uniqueKey":"shippingAddress.firstName.oneOf.0","typeLabel":"string"},{"description":"First name","title":"First Name","type":"null","uniqueKey":"shippingAddress.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name","title":"Last Name","type":"string","uniqueKey":"shippingAddress.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name","title":"Last Name","type":"null","uniqueKey":"shippingAddress.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.lastName","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number","title":"Phone","type":"string","uniqueKey":"shippingAddress.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number","title":"Phone","type":"null","uniqueKey":"shippingAddress.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"shippingAddress.phone","typeLabel":"string | null"}},"required":["address1","city","provinceCode","zip","countryCode"],"title":"Shipping Address","type":"object","isRequired":true,"uniqueKey":"shippingAddress","typeLabel":"Shipping Address · object"},"updatedAt":{"description":"Last update timestamp","title":"Updated At","type":"string","isRequired":true,"uniqueKey":"updatedAt","typeLabel":"string"},"billingAddress":{"oneOf":[{"description":"Billing address","properties":{"address1":{"oneOf":[{"description":"Address line 1","title":"Address Line 1","type":"string","uniqueKey":"billingAddress.oneOf.0.address1.oneOf.0","typeLabel":"string"},{"description":"Address line 1","title":"Address Line 1","type":"null","uniqueKey":"billingAddress.oneOf.0.address1.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.address1","typeLabel":"string | null"},"address2":{"oneOf":[{"description":"Address line 2","title":"Address Line 2","type":"string","uniqueKey":"billingAddress.oneOf.0.address2.oneOf.0","typeLabel":"string"},{"description":"Address line 2","title":"Address Line 2","type":"null","uniqueKey":"billingAddress.oneOf.0.address2.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.address2","typeLabel":"string | null"},"city":{"oneOf":[{"description":"City","title":"City","type":"string","uniqueKey":"billingAddress.oneOf.0.city.oneOf.0","typeLabel":"string"},{"description":"City","title":"City","type":"null","uniqueKey":"billingAddress.oneOf.0.city.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.city","typeLabel":"string | null"},"company":{"oneOf":[{"description":"Company name","title":"Company","type":"string","uniqueKey":"billingAddress.oneOf.0.company.oneOf.0","typeLabel":"string"},{"description":"Company name","title":"Company","type":"null","uniqueKey":"billingAddress.oneOf.0.company.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.company","typeLabel":"string | null"},"firstName":{"oneOf":[{"description":"First name","title":"First Name","type":"string","uniqueKey":"billingAddress.oneOf.0.firstName.oneOf.0","typeLabel":"string"},{"description":"First name","title":"First Name","type":"null","uniqueKey":"billingAddress.oneOf.0.firstName.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.firstName","typeLabel":"string | null"},"lastName":{"oneOf":[{"description":"Last name","title":"Last Name","type":"string","uniqueKey":"billingAddress.oneOf.0.lastName.oneOf.0","typeLabel":"string"},{"description":"Last name","title":"Last Name","type":"null","uniqueKey":"billingAddress.oneOf.0.lastName.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.lastName","typeLabel":"string | null"},"provinceCode":{"oneOf":[{"description":"Province or state code","title":"Province Code","type":"string","uniqueKey":"billingAddress.oneOf.0.provinceCode.oneOf.0","typeLabel":"string"},{"description":"Province or state code","title":"Province Code","type":"null","uniqueKey":"billingAddress.oneOf.0.provinceCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.provinceCode","typeLabel":"string | null"},"zip":{"oneOf":[{"description":"Postal/ZIP code","title":"ZIP","type":"string","uniqueKey":"billingAddress.oneOf.0.zip.oneOf.0","typeLabel":"string"},{"description":"Postal/ZIP code","title":"ZIP","type":"null","uniqueKey":"billingAddress.oneOf.0.zip.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.zip","typeLabel":"string | null"},"countryCode":{"oneOf":[{"description":"Country code (ISO)","title":"Country Code","type":"string","uniqueKey":"billingAddress.oneOf.0.countryCode.oneOf.0","typeLabel":"string"},{"description":"Country code (ISO)","title":"Country Code","type":"null","uniqueKey":"billingAddress.oneOf.0.countryCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.countryCode","typeLabel":"string | null"},"phone":{"oneOf":[{"description":"Phone number","title":"Phone","type":"string","uniqueKey":"billingAddress.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"description":"Phone number","title":"Phone","type":"null","uniqueKey":"billingAddress.oneOf.0.phone.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress.oneOf.0.phone","typeLabel":"string | null"}},"title":"Billing Address","type":"object","uniqueKey":"billingAddress.oneOf.0","typeLabel":"Billing Address · object"},{"description":"Billing address","properties":{"address1":{"oneOf":[{"description":"Address line 1","title":"Address Line 1","type":"string"},{"description":"Address line 1","title":"Address Line 1","type":"null"}]},"address2":{"oneOf":[{"description":"Address line 2","title":"Address Line 2","type":"string"},{"description":"Address line 2","title":"Address Line 2","type":"null"}]},"city":{"oneOf":[{"description":"City","title":"City","type":"string"},{"description":"City","title":"City","type":"null"}]},"company":{"oneOf":[{"description":"Company name","title":"Company","type":"string"},{"description":"Company name","title":"Company","type":"null"}]},"firstName":{"oneOf":[{"description":"First name","title":"First Name","type":"string"},{"description":"First name","title":"First Name","type":"null"}]},"lastName":{"oneOf":[{"description":"Last name","title":"Last Name","type":"string"},{"description":"Last name","title":"Last Name","type":"null"}]},"provinceCode":{"oneOf":[{"description":"Province or state code","title":"Province Code","type":"string"},{"description":"Province or state code","title":"Province Code","type":"null"}]},"zip":{"oneOf":[{"description":"Postal/ZIP code","title":"ZIP","type":"string"},{"description":"Postal/ZIP code","title":"ZIP","type":"null"}]},"countryCode":{"oneOf":[{"description":"Country code (ISO)","title":"Country Code","type":"string"},{"description":"Country code (ISO)","title":"Country Code","type":"null"}]},"phone":{"oneOf":[{"description":"Phone number","title":"Phone","type":"string"},{"description":"Phone number","title":"Phone","type":"null"}]}},"title":"Billing Address","type":"null","uniqueKey":"billingAddress.oneOf.1","typeLabel":"null"}],"uniqueKey":"billingAddress","typeLabel":"Billing Address · object | null"},"salesChannel":{"oneOf":[{"description":"Sales channel where order was placed","title":"Sales Channel","type":"string","uniqueKey":"salesChannel.oneOf.0","typeLabel":"string"},{"description":"Sales channel where order was placed","title":"Sales Channel","type":"null","uniqueKey":"salesChannel.oneOf.1","typeLabel":"null"}],"uniqueKey":"salesChannel","typeLabel":"string | null"},"source":{"oneOf":[{"description":"The integration that sent this order, when Redo has a dedicated integration for it. Leave it out for orders from your own system.","enum":["TeamworkCommerce",null],"title":"Source","type":"string","uniqueKey":"source.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"The integration that sent this order, when Redo has a dedicated integration for it. Leave it out for orders from your own system.","enum":["TeamworkCommerce",null],"title":"Source","type":"null","uniqueKey":"source.oneOf.1","typeLabel":"null"}],"uniqueKey":"source","typeLabel":"enum\u003cstring> | null"},"tags":{"default":[],"description":"Order tags","items":{"type":"string","uniqueKey":"tags.items.[INDEX]","typeLabel":"string"},"title":"Tags","type":"array","uniqueKey":"tags","typeLabel":"string[]"},"metafields":{"description":"Namespaced key-value pairs for the order as a whole.","items":{"description":"Namespaced key-value pair carried through to Redo","properties":{"namespace":{"description":"Metafield namespace","title":"Namespace","type":"string","isRequired":true,"uniqueKey":"metafields.items.[INDEX].namespace","typeLabel":"string"},"key":{"description":"Metafield key","title":"Key","type":"string","isRequired":true,"uniqueKey":"metafields.items.[INDEX].key","typeLabel":"string"},"value":{"description":"Metafield value, sent as a string","title":"Value","type":"string","isRequired":true,"uniqueKey":"metafields.items.[INDEX].value","typeLabel":"string"}},"required":["namespace","key","value"],"title":"Custom Order Metafield","type":"object","uniqueKey":"metafields.items.[INDEX]","typeLabel":"Custom Order Metafield · object"},"title":"Metafields","type":"array","uniqueKey":"metafields","typeLabel":"Custom Order Metafield · object[]"},"cancelledAt":{"oneOf":[{"description":"Timestamp the order was cancelled in your system. Omit or send null for live orders. A cancelled order is recorded with a `voided` financial status and stops producing order tracking updates.","title":"Cancelled At","type":"string","uniqueKey":"cancelledAt.oneOf.0","typeLabel":"string"},{"description":"Timestamp the order was cancelled in your system. Omit or send null for live orders. A cancelled order is recorded with a `voided` financial status and stops producing order tracking updates.","title":"Cancelled At","type":"null","uniqueKey":"cancelledAt.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelledAt","typeLabel":"string | null"},"cancelReason":{"oneOf":[{"description":"Why the order was cancelled. Optional, even when cancelled.","enum":["customer","fraud","inventory","declined","other","staff",null],"example":"customer","title":"Cancel Reason","type":"string","uniqueKey":"cancelReason.oneOf.0","typeLabel":"enum\u003cstring>"},{"description":"Why the order was cancelled. Optional, even when cancelled.","enum":["customer","fraud","inventory","declined","other","staff",null],"example":"customer","title":"Cancel Reason","type":"null","uniqueKey":"cancelReason.oneOf.1","typeLabel":"null"}],"uniqueKey":"cancelReason","typeLabel":"enum\u003cstring> | null"},"transactions":{"default":[],"description":"Payment transactions","items":{"additionalProperties":true,"description":"Payment transaction for custom order integration.\n\nGateway-specific fields may be sent alongside the standard fields. When\n`paymentGateway` is `authorize_net`, include `additionalDetails` so Redo can\nissue refunds through Authorize.net.\n","properties":{"paymentId":{"description":"Payment transaction ID","title":"Payment ID","type":"string","isRequired":true,"uniqueKey":"transactions.items.[INDEX].paymentId","typeLabel":"string"},"amount":{"description":"Transaction amount","title":"Amount","type":"number","isRequired":true,"uniqueKey":"transactions.items.[INDEX].amount","typeLabel":"number"},"currency":{"description":"Transaction currency","title":"Currency","type":"string","isRequired":true,"uniqueKey":"transactions.items.[INDEX].currency","typeLabel":"string"},"createdDate":{"description":"Transaction creation date","title":"Created Date","type":"string","isRequired":true,"uniqueKey":"transactions.items.[INDEX].createdDate","typeLabel":"string"},"paymentGateway":{"description":"Payment gateway used, e.g. \"authorize_net\"","title":"Payment Gateway","type":"string","isRequired":true,"uniqueKey":"transactions.items.[INDEX].paymentGateway","typeLabel":"string"},"additionalDetails":{"description":"Gateway-specific details. Required for Authorize.net refunds.","properties":{"creditCardLastFour":{"description":"Last four digits of the card used for the transaction","maxLength":4,"minLength":4,"title":"Credit Card Last Four","type":"string","isRequired":true,"uniqueKey":"transactions.items.[INDEX].additionalDetails.creditCardLastFour","typeLabel":"string"}},"required":["creditCardLastFour"],"title":"Additional Details","type":"object","uniqueKey":"transactions.items.[INDEX].additionalDetails","typeLabel":"Additional Details · object"}},"required":["paymentId","amount","currency","createdDate","paymentGateway"],"title":"Custom Order Transaction","type":"object","uniqueKey":"transactions.items.[INDEX]","typeLabel":"Custom Order Transaction · object"},"title":"Transactions","type":"array","uniqueKey":"transactions","typeLabel":"Custom Order Transaction · object[]"},"refunds":{"default":[],"description":"Refunds already issued against this order. Redo uses them to work out what has already been returned to the shopper and to derive the order's financial status. Send the full set on every sync.","items":{"description":"A refund already issued against the order in your system.\n\nRefunds are informational: Redo uses them to know what has already been\nreturned to the shopper, and does not issue them. Send every refund on the\norder each time you sync it.\n","properties":{"id":{"description":"Refund ID in external system. Unique within the order.","title":"ID","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].id","typeLabel":"string"},"createdAt":{"description":"Timestamp the refund was issued","title":"Created At","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].createdAt","typeLabel":"string"},"note":{"oneOf":[{"description":"Note recorded with the refund","title":"Note","type":"string","uniqueKey":"refunds.items.[INDEX].note.oneOf.0","typeLabel":"string"},{"description":"Note recorded with the refund","title":"Note","type":"null","uniqueKey":"refunds.items.[INDEX].note.oneOf.1","typeLabel":"null"}],"uniqueKey":"refunds.items.[INDEX].note","typeLabel":"string | null"},"lineItems":{"default":[],"description":"Line items refunded by this refund","items":{"description":"A line item refunded by a refund on a custom order.\n\n`lineItemId` must match the `id` of a line item on the same order. A refund\nline item that references an unknown line item is ignored.\n","properties":{"lineItemId":{"description":"ID of the order line item being refunded","title":"Line Item ID","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].lineItemId","typeLabel":"string"},"quantity":{"description":"Quantity refunded. Must be greater than zero.","minimum":1,"title":"Quantity","type":"integer","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].quantity","typeLabel":"integer"},"subtotalSet":{"description":"Refunded amount for this line, excluding tax","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Subtotal Set","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].subtotalSet","typeLabel":"Subtotal Set · object"},"totalTaxSet":{"description":"Refunded tax for this line","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Total Tax Set","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX].totalTaxSet","typeLabel":"Total Tax Set · object"}},"required":["lineItemId","quantity","subtotalSet","totalTaxSet"],"title":"Custom Order Refund Line Item","type":"object","uniqueKey":"refunds.items.[INDEX].lineItems.items.[INDEX]","typeLabel":"Custom Order Refund Line Item · object"},"title":"Line Items","type":"array","uniqueKey":"refunds.items.[INDEX].lineItems","typeLabel":"Custom Order Refund Line Item · object[]"},"shippingRefunds":{"default":[],"description":"Shipping amounts refunded by this refund","items":{"description":"A refunded amount that is not tied to a line item, used for shipping refunds\nand order-level refunds. Send amounts as positive values.\n","properties":{"amountSet":{"description":"Refunded amount, excluding tax","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Amount Set","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].amountSet","typeLabel":"Amount Set · object"},"taxAmountSet":{"description":"Tax refunded with this amount. Defaults to zero.","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Tax Amount Set","type":"object","uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].taxAmountSet","typeLabel":"Tax Amount Set · object"},"reason":{"description":"Free-text reason recorded with the refund","title":"Reason","type":"string","uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX].reason","typeLabel":"string"}},"required":["amountSet"],"title":"Custom Order Refund Amount","type":"object","uniqueKey":"refunds.items.[INDEX].shippingRefunds.items.[INDEX]","typeLabel":"Custom Order Refund Amount · object"},"title":"Shipping Refunds","type":"array","uniqueKey":"refunds.items.[INDEX].shippingRefunds","typeLabel":"Custom Order Refund Amount · object[]"},"orderLevelRefunds":{"default":[],"description":"Amounts refunded against the order as a whole rather than a line item or shipping, such as a goodwill adjustment.","items":{"description":"A refunded amount that is not tied to a line item, used for shipping refunds\nand order-level refunds. Send amounts as positive values.\n","properties":{"amountSet":{"description":"Refunded amount, excluding tax","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Amount Set","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].amountSet","typeLabel":"Amount Set · object"},"taxAmountSet":{"description":"Tax refunded with this amount. Defaults to zero.","properties":{"presentmentMoney":{"description":"Amount in presentment currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet.presentmentMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet.presentmentMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Presentment Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet.presentmentMoney","typeLabel":"Presentment Money · object"},"shopMoney":{"description":"Amount in shop currency","properties":{"amount":{"description":"Amount as a decimal string","examples":["50.20","1.78"],"title":"Amount","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet.shopMoney.amount","typeLabel":"string"},"currencyCode":{"description":"ISO 4217 currency code","examples":["USD","EUR"],"title":"Currency Code","type":"string","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet.shopMoney.currencyCode","typeLabel":"string"}},"required":["amount","currencyCode"],"title":"Shop Money","type":"object","isRequired":true,"uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet.shopMoney","typeLabel":"Shop Money · object"}},"required":["presentmentMoney","shopMoney"],"title":"Tax Amount Set","type":"object","uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].taxAmountSet","typeLabel":"Tax Amount Set · object"},"reason":{"description":"Free-text reason recorded with the refund","title":"Reason","type":"string","uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX].reason","typeLabel":"string"}},"required":["amountSet"],"title":"Custom Order Refund Amount","type":"object","uniqueKey":"refunds.items.[INDEX].orderLevelRefunds.items.[INDEX]","typeLabel":"Custom Order Refund Amount · object"},"title":"Order Level Refunds","type":"array","uniqueKey":"refunds.items.[INDEX].orderLevelRefunds","typeLabel":"Custom Order Refund Amount · object[]"}},"required":["id","createdAt"],"title":"Custom Order Refund","type":"object","uniqueKey":"refunds.items.[INDEX]","typeLabel":"Custom Order Refund · object"},"title":"Refunds","type":"array","uniqueKey":"refunds","typeLabel":"Custom Order Refund · object[]"},"coverage":{"description":"Redo coverage the shopper bought at checkout, priced by a Coverage\nProducts quote.\n\nSet `purchased: true` with the `id` from the Coverage Products response\nas `quoteId`. Redo checks that the order's line items match the quoted\ncart and that the order is eligible for every quoted coverage type, and\nanswers 400 if not. Once a quote is bound to the order, later syncs keep\nit, even if they omit `coverage` or send `purchased: false`.\n\nUse this or the Redo coverage line item, not both. An order with a Redo\ncoverage line item is billed from that line item.\n","properties":{"purchased":{"description":"Whether the shopper bought the quoted coverage.","title":"Purchased","type":"boolean","isRequired":true,"uniqueKey":"coverage.purchased","typeLabel":"boolean"},"quoteId":{"description":"The `id` from the Coverage Products response. Required when `purchased` is true.","title":"Quote ID","type":"string","uniqueKey":"coverage.quoteId","typeLabel":"string"}},"required":["purchased"],"title":"Coverage","type":"object","uniqueKey":"coverage","typeLabel":"Coverage · object"}},"required":["id","type","createdAt","presentmentCurrency","shopCurrency","customer","lineItems","orderDiscounts","shippingLines","fulfillments","shippingAddress","updatedAt"],"title":"Custom Order Sync","type":"object","uniqueKey":"","typeLabel":"Custom Order Sync · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","type":"order","createdAt":"\u003cstring>","presentmentCurrency":"\u003cstring>","shopCurrency":"\u003cstring>","customer":{"email":"jsmith@example.com","firstName":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>","id":"\u003cstring>","tags":[]},"lineItems":[{"id":"\u003cstring>","quantity":123,"priceSet":{"presentmentMoney":{"amount":"50.20","currencyCode":"USD"},"shopMoney":{"amount":"50.20","currencyCode":"USD"}},"title":"\u003cstring>","productId":"\u003cstring>","sku":"\u003cstring>","returnableQuantity":123,"variantTitle":"\u003cstring>","vendor":"\u003cstring>","fulfillmentService":"\u003cstring>","variantId":"\u003cstring>","additionalProductId":"\u003cstring>","properties":[],"tags":[],"metafields":[{"namespace":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"weight":{"value":123,"unit":"\u003cstring>"},"image":"\u003cstring>","images":[],"discounts":[],"taxLines":[]}],"orderDiscounts":[{"amountSet":{"presentmentMoney":{"amount":"50.20","currencyCode":"USD"},"shopMoney":{"amount":"50.20","currencyCode":"USD"}},"discountId":"\u003cstring>","discountTitle":"\u003cstring>","discountCode":"\u003cstring>"}],"shippingLines":[{"id":"\u003cstring>","title":"\u003cstring>","priceSet":{"presentmentMoney":{"amount":"50.20","currencyCode":"USD"},"shopMoney":{"amount":"50.20","currencyCode":"USD"}},"code":"\u003cstring>","discounts":[],"taxLines":[]}],"fulfillments":[{"id":"\u003cstring>","lineItems":[{"id":"\u003cstring>","quantity":123}],"trackingNumbers":[],"trackingUrls":[],"shippingDate":"\u003cstring>","deliveryDate":"\u003cstring>"}],"shippingAddress":{"address1":"\u003cstring>","city":"\u003cstring>","provinceCode":"\u003cstring>","zip":"\u003cstring>","countryCode":"\u003cstring>","address2":"\u003cstring>","company":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","phone":"\u003cstring>"},"updatedAt":"\u003cstring>","billingAddress":{"address1":"\u003cstring>","address2":"\u003cstring>","city":"\u003cstring>","company":"\u003cstring>","firstName":"\u003cstring>","lastName":"\u003cstring>","provinceCode":"\u003cstring>","zip":"\u003cstring>","countryCode":"\u003cstring>","phone":"\u003cstring>"},"salesChannel":"\u003cstring>","tags":[],"metafields":[{"namespace":"\u003cstring>","key":"\u003cstring>","value":"\u003cstring>"}],"cancelledAt":"\u003cstring>","cancelReason":"customer","transactions":[],"refunds":[]}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"c6d8aa97-12d8-4062-8f72-572d6f04dcef":{"description":"Order synced successfully","content":{"application/json":{"schema":{"description":"Response returned when an order is synced successfully","properties":{"message":{"description":"Always \"Order synced successfully\"","title":"Message","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"orderId":{"description":"The order ID you supplied in the request body","title":"Order ID","type":"string","isRequired":true,"uniqueKey":"orderId","typeLabel":"string"},"redoId":{"description":"The Redo order ID for the synced order","title":"Redo ID","type":"string","isRequired":true,"uniqueKey":"redoId","typeLabel":"string"}},"required":["message","orderId","redoId"],"title":"Custom Order Sync Response","type":"object","uniqueKey":"","typeLabel":"Custom Order Sync Response · object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","orderId":"\u003cstring>","redoId":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"6dea72eb-22c2-4f65-8521-80d1324872d6":{"content":{"application/json":{"schema":{"description":"Error returned by the custom order sync endpoint","properties":{"error":{"description":"Human-readable summary of the problem","title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errors":{"description":"Field-level validation details, present only when the request body fails schema validation. Keys mirror the request body structure.","title":"Errors","type":"object","uniqueKey":"errors","typeLabel":"Errors · object"}},"required":["error"],"title":"Custom Order Error","type":"object","uniqueKey":"","typeLabel":"Custom Order Error · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"description":"Invalid order data. `errors` contains the field-level validation details.","exampleType":"generated"},"08b2adf4-a667-461e-89ec-5fa8949d0139":{"content":{"application/json":{"schema":{"description":"Error returned by the custom order sync endpoint","properties":{"error":{"description":"Human-readable summary of the problem","title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errors":{"description":"Field-level validation details, present only when the request body fails schema validation. Keys mirror the request body structure.","title":"Errors","type":"object","uniqueKey":"errors","typeLabel":"Errors · object"}},"required":["error"],"title":"Custom Order Error","type":"object","uniqueKey":"","typeLabel":"Custom Order Error · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"description":"Missing or invalid API token","exampleType":"generated"},"a708fb34-83ed-4334-bb09-3ea440edabd0":{"content":{"application/problem+json":{"schema":{"description":"Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).","properties":{"detail":{"description":"Human-readable description of the problem.","title":"Detail","type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"description":"A URI reference that identifies this problem.","format":"uri-reference","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"title":{"description":"Human-readable summary of the problem type.","title":"Title","type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference that identifies the problem type.","format":"uri-reference","type":"string","uniqueKey":"type","typeLabel":"string\u003curi-reference>"}},"title":"Problem details","type":"object","uniqueKey":"","typeLabel":"Problem details · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","instance":"\u003cstring>","title":"\u003cstring>","type":"about:blank"}}},"exampleType":"generated"}},"description":"Token does not have access to this store","exampleType":"generated"},"0d59b191-826c-4f98-a481-18fe47ff94bb":{"content":{"application/problem+json":{"schema":{"description":"Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).","properties":{"detail":{"description":"Human-readable description of the problem.","title":"Detail","type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"description":"A URI reference that identifies this problem.","format":"uri-reference","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"title":{"description":"Human-readable summary of the problem type.","title":"Title","type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference that identifies the problem type.","format":"uri-reference","type":"string","uniqueKey":"type","typeLabel":"string\u003curi-reference>"}},"title":"Problem details","type":"object","uniqueKey":"","typeLabel":"Problem details · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","instance":"\u003cstring>","title":"\u003cstring>","type":"about:blank"}}},"exampleType":"generated"}},"description":"Store does not exist","exampleType":"generated"},"b6475768-4d8c-47af-987d-f28ad4720fde":{"content":{"application/json":{"schema":{"description":"Error returned by the custom order sync endpoint","properties":{"error":{"description":"Human-readable summary of the problem","title":"Error","type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"errors":{"description":"Field-level validation details, present only when the request body fails schema validation. Keys mirror the request body structure.","title":"Errors","type":"object","uniqueKey":"errors","typeLabel":"Errors · object"}},"required":["error"],"title":"Custom Order Error","type":"object","uniqueKey":"","typeLabel":"Custom Order Error · object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","errors":{}}}},"exampleType":"generated"}},"description":"Failed to process order","exampleType":"generated"},"b40a9afa-61df-49d7-a582-451b34bf6d71":{"content":{"application/problem+json":{"schema":{"description":"Problem details. See [RFC 7807 Section 3](https://datatracker.ietf.org/doc/html/rfc7807#section-3).","properties":{"detail":{"description":"Human-readable description of the problem.","title":"Detail","type":"string","uniqueKey":"detail","typeLabel":"string"},"instance":{"description":"A URI reference that identifies this problem.","format":"uri-reference","type":"string","uniqueKey":"instance","typeLabel":"string\u003curi-reference>"},"title":{"description":"Human-readable summary of the problem type.","title":"Title","type":"string","uniqueKey":"title","typeLabel":"string"},"type":{"default":"about:blank","description":"A URI reference that identifies the problem type.","format":"uri-reference","type":"string","uniqueKey":"type","typeLabel":"string\u003curi-reference>"}},"title":"Problem details","type":"object","uniqueKey":"","typeLabel":"Problem details · object"},"examples":{"Example":{"title":"Example","value":{"detail":"\u003cstring>","instance":"\u003cstring>","title":"\u003cstring>","type":"about:blank"}}},"exampleType":"generated"}},"description":"Error","exampleType":"generated"}},"security":{"624aaace-dca5-4072-9983-fad107596153":{"Bearer":{"scheme":"bearer","type":"http","scopes":[],"schemeName":"Bearer"}}},"servers":{"f0381a4e-06ae-4d7c-ae97-6567cce9d9a5":{"url":"https://api.getredo.com/v2.2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"scheme":"bearer","type":"http","scopes":[],"schemeName":"Bearer"},"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":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"api-schema/openapi.yaml"},"subdomain":"redo-44af351d","siteName":"Redo","title":"Sync Custom Order - Redo","navMaps":{"firstHrefInVersion":{"v3 (GraphQL)":{"href":"/docs/api-reference/v3/introduction","matchLevel":3},"v2 (REST)":{"href":"/api-reference/returns-custom-integration/sync-custom-order","matchLevel":0},"v3":{"href":"/docs/shopper-api/v3/overview","matchLevel":4}},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T22:04:05.360Z","originalFileLocation":"api-reference/returns-custom-integration/sync-custom-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=\"Sync an order to Redo so your shoppers can return it. This is the returns integration path for commerce platforms Redo does not support directly. Orders pushed here become returnable: the shopper can look up the order in the return portal, and Redo uses the line items, discounts, and taxes you send to decide what is eligible for return and what to refund. Syncing the same order ID again updates the existing Redo order, so this is safe to call on every order create and update. For a walkthrough of the full integration, including field-by-field mapping and a complete example payload, see the Custom Returns Integration guide. Important: If Redo protection is attached to this order, include a line item with: - vendor: \u0026quot;re:do\u0026quot; - sku: \u0026quot;x-redo\u0026quot; - tags: \u0026quot;returns\u0026quot;, \u0026quot;package protection\u0026quot;, or \u0026quot;both\u0026quot; - properties: _redo_type with value \u0026quot;return\u0026quot;, \u0026quot;package protection\u0026quot;, or \u0026quot;both\u0026quot; If you priced coverage with a Coverage Products quote instead, send coverage: { purchased: true, quoteId } with the quote\u0026#x27;s id.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Redo\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_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/redo-44af351d/EQY-0EZG4e-KYhl3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Sync Custom Order - Redo\">\u003cmeta data-mint-head property=\"og:description\" content=\"Sync an order to Redo so your shoppers can return it. This is the returns integration path for commerce platforms Redo does not support directly. Orders pushed here become returnable: the shopper can look up the order in the return portal, and Redo uses the line items, discounts, and taxes you send to decide what is eligible for return and what to refund. Syncing the same order ID again updates the existing Redo order, so this is safe to call on every order create and update. For a walkthrough of the full integration, including field-by-field mapping and a complete example payload, see the Custom Returns Integration guide. Important: If Redo protection is attached to this order, include a line item with: - vendor: \u0026quot;re:do\u0026quot; - sku: \u0026quot;x-redo\u0026quot; - tags: \u0026quot;returns\u0026quot;, \u0026quot;package protection\u0026quot;, or \u0026quot;both\u0026quot; - properties: _redo_type with value \u0026quot;return\u0026quot;, \u0026quot;package protection\u0026quot;, or \u0026quot;both\u0026quot; If you priced coverage with a Coverage Products quote instead, send coverage: { purchased: true, quoteId } with the quote\u0026#x27;s id.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Redo\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://redo-44af351d.mintlify.site/_mintlify/api/og/v2?division=Returns+Custom+Integration\u0026amp;title=Sync+Custom+Order\u0026amp;description=Sync+an+order+to+Redo+so+your+shoppers+can+return+it.%0A%0AThis+is+the+returns+integration+path+for+commerce+platforms+Redo+does+not%0Asupport+directly.+Orders+pushed\u0026amp;theme=811c1b99001e8a554631eff8\u0026amp;signature=94952385275b39843212abd4945469f17c380af0fe32d5a1a9decf014001602e\">\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=\"Sync Custom Order - Redo\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Sync an order to Redo so your shoppers can return it. This is the returns integration path for commerce platforms Redo does not support directly. Orders pushed here become returnable: the shopper can look up the order in the return portal, and Redo uses the line items, discounts, and taxes you send to decide what is eligible for return and what to refund. Syncing the same order ID again updates the existing Redo order, so this is safe to call on every order create and update. For a walkthrough of the full integration, including field-by-field mapping and a complete example payload, see the Custom Returns Integration guide. Important: If Redo protection is attached to this order, include a line item with: - vendor: \u0026quot;re:do\u0026quot; - sku: \u0026quot;x-redo\u0026quot; - tags: \u0026quot;returns\u0026quot;, \u0026quot;package protection\u0026quot;, or \u0026quot;both\u0026quot; - properties: _redo_type with value \u0026quot;return\u0026quot;, \u0026quot;package protection\u0026quot;, or \u0026quot;both\u0026quot; If you priced coverage with a Coverage Products quote instead, send coverage: { purchased: true, quoteId } with the quote\u0026#x27;s id.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://redo-44af351d.mintlify.site/_mintlify/api/og/v2?division=Returns+Custom+Integration\u0026amp;title=Sync+Custom+Order\u0026amp;description=Sync+an+order+to+Redo+so+your+shoppers+can+return+it.%0A%0AThis+is+the+returns+integration+path+for+commerce+platforms+Redo+does+not%0Asupport+directly.+Orders+pushed\u0026amp;theme=811c1b99001e8a554631eff8\u0026amp;signature=94952385275b39843212abd4945469f17c380af0fe32d5a1a9decf014001602e\">\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/redo-44af351d/EQY-0EZG4e-KYhl3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Redo\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#FF4405\">\u003clink data-mint-head rel=\"canonical\" href=\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-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/returns-custom-integration/sync-custom-order.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://developers.redo.com/#organization\",\"name\":\"Redo\",\"url\":\"https://developers.redo.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/redo-44af351d/KtmWeYG860C3iLpm/docs/logo/light.svg?fit=max\u0026auto=format\u0026n=KtmWeYG860C3iLpm\u0026q=85\u0026s=d7d25c69bed7e16ea3f3ad1334492765\"}},{\"@type\":\"WebSite\",\"@id\":\"https://developers.redo.com#website\",\"name\":\"Redo\",\"url\":\"https://developers.redo.com\",\"publisher\":{\"@id\":\"https://developers.redo.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order#webpage\",\"url\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order\",\"name\":\"Sync Custom Order\",\"description\":\"Sync an order to Redo so your shoppers can return it. This is the returns integration path for commerce platforms Redo does not support directly. Orders pushed here become returnable: the shopper can look up the order in the return portal, and Redo uses the line items, discounts, and taxes you send to decide what is eligible for return and what to refund. Syncing the same order ID again updates the existing Redo order, so this is safe to call on every order create and update. For a walkthrough of the full integration, including field-by-field mapping and a complete example payload, see the Custom Returns Integration guide. Important: If Redo protection is attached to this order, include a line item with: - vendor: \\\"re:do\\\" - sku: \\\"x-redo\\\" - tags: \\\"returns\\\", \\\"package protection\\\", or \\\"both\\\" - properties: _redo_type with value \\\"return\\\", \\\"package protection\\\", or \\\"both\\\" If you priced coverage with a Coverage Products quote instead, send coverage: { purchased: true, quoteId } with the quote's id.\",\"dateModified\":\"2026-11-13T22:04:05.360Z\",\"isPartOf\":{\"@id\":\"https://developers.redo.com#website\"},\"breadcrumb\":{\"@id\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://developers.redo.com/api-reference/bundles/list-bundles\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sync Custom Order\",\"item\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order#apireference\",\"headline\":\"Sync Custom Order\",\"name\":\"Sync Custom Order\",\"description\":\"Sync an order to Redo so your shoppers can return it. This is the returns integration path for commerce platforms Redo does not support directly. Orders pushed here become returnable: the shopper can look up the order in the return portal, and Redo uses the line items, discounts, and taxes you send to decide what is eligible for return and what to refund. Syncing the same order ID again updates the existing Redo order, so this is safe to call on every order create and update. For a walkthrough of the full integration, including field-by-field mapping and a complete example payload, see the Custom Returns Integration guide. Important: If Redo protection is attached to this order, include a line item with: - vendor: \\\"re:do\\\" - sku: \\\"x-redo\\\" - tags: \\\"returns\\\", \\\"package protection\\\", or \\\"both\\\" - properties: _redo_type with value \\\"return\\\", \\\"package protection\\\", or \\\"both\\\" If you priced coverage with a Coverage Products quote instead, send coverage: { purchased: true, quoteId } with the quote's id.\",\"url\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order\",\"mainEntityOfPage\":{\"@id\":\"https://developers.redo.com/api-reference/returns-custom-integration/sync-custom-order#webpage\"},\"dateModified\":\"2026-11-13T22:04:05.360Z\",\"publisher\":{\"@id\":\"https://developers.redo.com/#organization\"},\"isPartOf\":{\"@id\":\"https://developers.redo.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Redo\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Redo\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/returns-custom-integration/sync-custom-order.md","siteName":"Redo","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":"/docs"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/docs/guides/introduction"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/docs/integrations/introduction"}]},{"tab":"Shopper API","hidden":true,"versions":[{"version":"v3","groups":[{"group":"Getting started","pages":[{"title":"Shopper API","href":"/docs/shopper-api/v3/overview"}]},{"group":"Reference","pages":[{"group":"Common","root":{"title":"Common","href":"/docs/shopper-api/v3/reference/common/overview"},"pages":[{"group":"Queries","pages":[{"title":"shopperConfiguration","href":"/docs/shopper-api/v3/reference/common/queries/shopper-configuration"},{"title":"shopperSession","href":"/docs/shopper-api/v3/reference/common/queries/shopper-session"}]},{"group":"Mutations","pages":[{"title":"shopperOrderAuthenticate","href":"/docs/shopper-api/v3/reference/common/mutations/shopper-order-authenticate"},{"title":"shopperOrderSelect","href":"/docs/shopper-api/v3/reference/common/mutations/shopper-order-select"}]},{"group":"Objects","pages":[{"title":"Money","href":"/docs/shopper-api/v3/reference/common/money"},{"title":"Node","href":"/docs/shopper-api/v3/reference/common/node"},{"title":"ShopperConfiguration","href":"/docs/shopper-api/v3/reference/common/shopper-configuration"},{"title":"ShopperCredentials","href":"/docs/shopper-api/v3/reference/common/shopper-credentials"},{"title":"ShopperOrderAuthentication","href":"/docs/shopper-api/v3/reference/common/shopper-order-authentication"},{"title":"ShopperOrderChoice","href":"/docs/shopper-api/v3/reference/common/shopper-order-choice"},{"title":"ShopperOrderSelection","href":"/docs/shopper-api/v3/reference/common/shopper-order-selection"},{"title":"ShopperSession","href":"/docs/shopper-api/v3/reference/common/shopper-session"}]}]},{"group":"Orders","root":{"title":"Orders","href":"/docs/shopper-api/v3/reference/orders/overview"},"pages":[{"group":"Queries","pages":[{"title":"order","href":"/docs/shopper-api/v3/reference/orders/queries/order"},{"title":"orders","href":"/docs/shopper-api/v3/reference/orders/queries/orders"}]},{"group":"Objects","pages":[{"title":"MailingAddress","href":"/docs/shopper-api/v3/reference/orders/mailing-address"},{"title":"Order","href":"/docs/shopper-api/v3/reference/orders/order"},{"title":"OrderCoverage","href":"/docs/shopper-api/v3/reference/orders/order-coverage"},{"title":"OrderLineItem","href":"/docs/shopper-api/v3/reference/orders/order-line-item"},{"title":"OrderTotals","href":"/docs/shopper-api/v3/reference/orders/order-totals"}]}]},{"group":"Returns","root":{"title":"Returns","href":"/docs/shopper-api/v3/reference/returns/overview"},"pages":[{"group":"Objects","pages":[{"title":"Return","href":"/docs/shopper-api/v3/reference/returns/return"},{"title":"ReturnItem","href":"/docs/shopper-api/v3/reference/returns/return-item"}]}]},{"group":"Shipping","root":{"title":"Shipping","href":"/docs/shopper-api/v3/reference/shipping/overview"},"pages":[{"group":"Queries","pages":[{"title":"shipment","href":"/docs/shopper-api/v3/reference/shipping/queries/shipment"}]},{"group":"Objects","pages":[{"title":"Shipment","href":"/docs/shopper-api/v3/reference/shipping/shipment"},{"title":"ShipmentItem","href":"/docs/shopper-api/v3/reference/shipping/shipment-item"},{"title":"TrackingEvent","href":"/docs/shopper-api/v3/reference/shipping/tracking-event"},{"title":"TrackingLocation","href":"/docs/shopper-api/v3/reference/shipping/tracking-location"}]}]},{"title":"Access scopes","href":"/docs/shopper-api/v3/reference/scopes"}]}]}]},{"tab":"API Reference","versions":[{"version":"v3 (GraphQL)","default":true,"pages":[{"title":"v3 (GraphQL)","href":"/docs/api-reference/v3/introduction"}]},{"version":"v2 (REST)","groups":[{"group":"Getting Started","pages":[{"title":"Introduction","icon":"hand-wave","href":"/docs/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/docs/api-reference/authentication"},{"title":"Access scopes","icon":"lock","href":"/docs/api-reference/scopes"},{"title":"API errors","icon":"triangle-exclamation","href":"/docs/api-reference/errors"},{"title":"Pagination","icon":"list","href":"/docs/api-reference/pagination"},{"title":"Loop-compatible API","icon":"repeat","href":"/docs/api-reference/loop-compatible-api"}]},{"group":"Endpoints","pages":[{"group":"Bundles","pages":[{"title":"List bundles","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/bundles","href":"/api-reference/bundles/list-bundles"},{"title":"Add or replace bundles","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /stores/{storeId}/bundles","href":"/api-reference/bundles/add-or-replace-bundles"},{"title":"Delete a bundle","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml delete /stores/{storeId}/bundles/{parentSku}","href":"/api-reference/bundles/delete-a-bundle"}]},{"group":"Checkout Buttons","pages":[{"title":"Checkout Buttons UI","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/checkout-buttons-ui","href":"/api-reference/checkout-buttons/checkout-buttons-ui"}]},{"group":"Checkout A/B Tests","pages":[{"title":"List checkout A/B tests","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/checkout-ab-tests","href":"/api-reference/checkout-ab-tests/list-checkout-ab-tests"}]},{"group":"Checkout Experiences","pages":[{"title":"List checkout experiences","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/checkout-experiences","href":"/api-reference/checkout-experiences/list-checkout-experiences"},{"title":"Create checkout experience","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/checkout-experiences","href":"/api-reference/checkout-experiences/create-checkout-experience"},{"title":"Get checkout experience","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/checkout-experiences/{checkoutExperienceId}","href":"/api-reference/checkout-experiences/get-checkout-experience"},{"title":"Delete checkout experience","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml delete /stores/{storeId}/checkout-experiences/{checkoutExperienceId}","href":"/api-reference/checkout-experiences/delete-checkout-experience"},{"title":"Update checkout experience","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml patch /stores/{storeId}/checkout-experiences/{checkoutExperienceId}","href":"/api-reference/checkout-experiences/update-checkout-experience"},{"title":"Duplicate checkout experience","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/duplicate","href":"/api-reference/checkout-experiences/duplicate-checkout-experience"},{"title":"Set auto-selected shipping methods","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/auto-selected-shipping-methods","href":"/api-reference/checkout-experiences/set-auto-selected-shipping-methods"},{"title":"Create shipping method","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/shipping-methods","href":"/api-reference/checkout-experiences/create-shipping-method"},{"title":"Update shipping method","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/shipping-methods/{shippingMethodId}","href":"/api-reference/checkout-experiences/update-shipping-method"},{"title":"Delete shipping method","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml delete /stores/{storeId}/checkout-experiences/{checkoutExperienceId}/shipping-methods/{shippingMethodId}","href":"/api-reference/checkout-experiences/delete-shipping-method"}]},{"group":"Coverage Info","pages":[{"title":"Navigate to Coverage Info","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/coverage-info","href":"/api-reference/coverage-info/navigate-to-coverage-info"}]},{"group":"Coverage Products","pages":[{"title":"Coverage Products","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/coverage-products","href":"/api-reference/coverage-products/coverage-products"}]},{"group":"Custom Events","pages":[{"title":"Create custom event","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/events","href":"/api-reference/custom-events/create-custom-event"},{"title":"Bulk create custom events","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/events/bulk","href":"/api-reference/custom-events/bulk-create-custom-events"}]},{"group":"Customer Portal","pages":[{"title":"Navigate to Customer Portal","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/customer-portal","href":"/api-reference/customer-portal/navigate-to-customer-portal"}]},{"group":"Customer Subscriptions","pages":[{"title":"Update Customer Subscriptions","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/customer-subscriptions","href":"/api-reference/customer-subscriptions/update-customer-subscriptions"}]},{"group":"Customers","pages":[{"title":"Get customer by email","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/customers","href":"/api-reference/customers/get-customer-by-email"},{"title":"Create or update customer","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /stores/{storeId}/customers","href":"/api-reference/customers/create-or-update-customer"}]},{"group":"Inbound Shipments","pages":[{"title":"List Inbound Shipments","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/inbound-shipments","href":"/api-reference/inbound-shipments/list-inbound-shipments"},{"title":"Get Inbound Shipment","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/inbound-shipments/{inboundShipmentId}","href":"/api-reference/inbound-shipments/get-inbound-shipment"}]},{"group":"Inventory Items","pages":[{"title":"List Inventory Items","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/inventory-items","href":"/api-reference/inventory-items/list-inventory-items"},{"title":"Get Inventory Item","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/inventory-items/{inventoryItemId}","href":"/api-reference/inventory-items/get-inventory-item"}]},{"group":"Inventory Levels","pages":[{"title":"List Inventory Levels","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/inventory-levels","href":"/api-reference/inventory-levels/list-inventory-levels"},{"title":"Get Inventory Level","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/inventory-levels/{inventoryLevelId}","href":"/api-reference/inventory-levels/get-inventory-level"}]},{"group":"Invoices","pages":[{"title":"Invoice (CSV)","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /invoices/{invoiceId}/items.csv","href":"/api-reference/invoices/invoice-csv"},{"title":"List Invoices","description":"Get a list of invoices. Requires the [`invoices_read`](/docs/api-reference/scopes) scope.","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/invoices","href":"/api-reference/invoices/list-invoices"}]},{"group":"Returns Custom Integration","pages":[{"title":"Sync Custom Order","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/custom/orders","href":"/api-reference/returns-custom-integration/sync-custom-order"}]},{"group":"Orders","pages":[{"title":"Create Order","description":"Create a new order in the system with line items, customer information, and shipping details. Requires the [`orders_write`](/docs/api-reference/scopes) scope.","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/orders","href":"/api-reference/orders/create-order"},{"title":"Get Order","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/orders/{orderId}","href":"/api-reference/orders/get-order"},{"title":"Delete Order","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml delete /stores/{storeId}/orders/{orderId}","href":"/api-reference/orders/delete-order"},{"title":"Create Fulfillment","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/orders/{orderId}/fulfillments","href":"/api-reference/orders/create-fulfillment"},{"title":"Update Fulfillment Status","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/orders/{orderId}/fulfillments/{fulfillmentId}/shipment-status","href":"/api-reference/orders/update-fulfillment-status"}]},{"group":"Products","pages":[{"title":"Bulk upload products","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/products/bulk-upload","href":"/api-reference/products/bulk-upload-products"}]},{"group":"Returns","pages":[{"title":"Return","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /returns/{returnId}","href":"/api-reference/returns/return"},{"title":"Create Return Comment","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /returns/{returnId}/comments","href":"/api-reference/returns/create-return-comment"},{"title":"Process Return","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /returns/{returnId}/process","href":"/api-reference/returns/process-return"},{"title":"Return Status","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /returns/{returnId}/status","href":"/api-reference/returns/return-status"},{"title":"Update Return Status","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /returns/{returnId}/status","href":"/api-reference/returns/update-return-status"},{"title":"List Returns","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/returns","href":"/api-reference/returns/list-returns"},{"title":"Create Return","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/returns","href":"/api-reference/returns/create-return"},{"title":"Import Returns","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/returns/bulk","href":"/api-reference/returns/import-returns"},{"title":"List Return Tags","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/return-tags","href":"/api-reference/returns/list-return-tags"},{"title":"Upsert Return Tag","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /stores/{storeId}/return-tags/{name}","href":"/api-reference/returns/upsert-return-tag"},{"title":"Delete Return Tag","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml delete /stores/{storeId}/return-tags/{name}","href":"/api-reference/returns/delete-return-tag"},{"title":"Return event","version":null,"deprecated":null,"openapi":"/api-schema/openapi.yaml webhook return","href":"/api-reference/returns/return-event"}]},{"group":"Storefront","pages":[{"title":"Receive Storefront Events","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/storefront/events","href":"/api-reference/storefront/receive-storefront-events"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /stores/{storeId}/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create or Update Webhook","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /stores/{storeId}/webhooks","href":"/api-reference/webhooks/create-or-update-webhook"},{"title":"Webhook","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml get /webhooks/{webhookId}","href":"/api-reference/webhooks/webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml put /webhooks/{webhookId}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml delete /webhooks/{webhookId}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Replay Webhook","deprecated":null,"version":null,"openapi":"/api-schema/openapi.yaml post /webhooks/{webhookId}/replay","href":"/api-reference/webhooks/replay-webhook"}]}]}]}]},{"tab":"MCP Server","pages":[{"title":"MCP Server","href":"/docs/mcp-server/introduction"}]}]},"basePath":"","title":"Sync Custom Order - Redo","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}