{"items":[{"type":"link","label":"Order API","link":"/cdp/order-rest-api","routeSlug":"/cdp/order-rest-api","content":{"contentType":"overview","meta":{"name":"Order API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"index.json","url":"/_bundle/cdp/order-rest-api/index.json?download"},{"kind":"download","label":"index.yaml","url":"/_bundle/cdp/order-rest-api/index.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Order API (v2.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the Order REST API to create, retrieve, update, and delete order data in Sitecore CDP."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This REST API lets you interact with the following objects:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order - the parent for all other objects, containing attributes common to the entire order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item - something that has been purchased as part of the order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order contact - the primary contact person for an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order consumer - the person that consumes the order item."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order data extension - any key-value pairs you want to add to the order object."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Order item data extension - any key-value pairs you want to add to the order item object."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note the following:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To use this REST API, you must authenticate your API requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All API requests are made in your production environment."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This reference documentation describes Sitecore CDP functionality for data model 2.1."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For more information, see the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/developers/api/index-en.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"official Sitecore CDP developer documentation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", including "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/developers/api/examples-of-order-items-rest-api-v2-1.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"examples"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of order items and order item data extensions."},"children":[]}]}]}]}],"sectionId":"/cdp/order-rest-api"}],"sectionId":"/cdp/order-rest-api"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/authentication"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Authentication"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Order REST API uses basic authentication."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Basic authentication involves sending a user name and a password with every request."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To find your user name and password, in Sitecore CDP, on the navigation pane, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" > "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The user name is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Client key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The password is the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"API token"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You must include the user name and password in every request you make. For example:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"curl -X GET '{baseURL}/v2.1/orders' \\ \n-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \\ \n-H 'Accept: application/json' \n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"curl -X GET '{baseURL}/v2.1/orders' \\ \n-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \\ \n-H 'Accept: application/json' \n"},"children":[]}]}]}],"sectionId":"/cdp/order-rest-api/section/authentication"},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":2,"id":"section/get-started"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Get started"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To create your first order and find it in Sitecore CDP:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order. The response contains the order reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create an order contact using the order reference. Make sure to provide enough identity information according to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/users/sitecore-cdp/identifying-guests-in-sitecore-cdp.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your organization's identity rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This associates a guest with the order. In the response, in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guest.href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the guest reference is the string that follows the final slash."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Copy the guest reference."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In Sitecore CDP, click "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guests"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Search"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field, enter the guest reference, then click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest type: All"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter. Then, Sitecore CDP lists the guest profile for the guest."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"On the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Guest Profile"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" page, click the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Orders"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" tab. The order you previously created displays."},"children":[]}]}]}]}]}],"sectionId":"/cdp/order-rest-api/section/get-started"}]}]}},{"type":"link","label":"Authentication","link":"/cdp/order-rest-api/section/authentication","routeSlug":"/cdp/order-rest-api/section/authentication","content":null},{"type":"link","label":"Get started","link":"/cdp/order-rest-api/section/get-started","routeSlug":"/cdp/order-rest-api/section/get-started","content":null},{"type":"group","label":"Order","link":"/cdp/order-rest-api/order","routeSlug":"/cdp/order-rest-api/order","items":[{"label":"Create an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order/createorder","routeSlug":"/cdp/order-rest-api/order/createorder","metadata":{"seo":{"title":"Create an order","description":"Creates an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrder","name":"Create an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order reference. Use the order reference to interact with a specific order, for example, to retrieve it, update it, or create a data extension for it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"schemaId":"components/schemas/OrderCreateRequest","pointer":"/paths/~1v2.1~1orders/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/orders","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"responseCodes":["201","400","401","409"],"pointer":"/v2.1/orders","href":"order/createorder","openApiOperationId":"CreateOrder","summary":"Create an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}},"schemaId":"components/schemas/OrderCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBadRequestResponse"}},"schemaId":"components/schemas/OrderBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"},{"code":"409","description":"Already exists","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderAlreadyExistsResponse"}},"schemaId":"components/schemas/OrderAlreadyExistsResponse"}],"pointer":"/paths/~1v2.1~1orders/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}}},{"code":"400","schemaId":"components/schemas/OrderBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}},{"code":"409","schemaId":"components/schemas/OrderAlreadyExistsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderAlreadyExistsResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/createorder"}],"panels":[]}]},"httpPath":"/v2.1/orders"},{"label":"List orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order/retrieveorders","routeSlug":"/cdp/order-rest-api/order/retrieveorders","metadata":{"seo":{"title":"List orders","description":"Retrieves a list of orders that either have the same reference ID or belong to the same guest. You must include either the referenceId of the order or the guestRef as a query string parameter in the URI of the request, but not both."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrders","name":"List orders","isWebhook":false,"pointer":"/paths/~1v2.1~1orders/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List orders","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of orders that either have the same reference ID or belong to the same guest. You must include either the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the order or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guestRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as a query string parameter in the URI of the request, but not both."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order reference. Use the order reference to interact with a specific order, for example, to retrieve it, update it, or create a data extension for it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"referenceId","in":"query","schemaId":"schema_849"},{"name":"guestRef","in":"query","schemaId":"schema_850"},{"name":"offset","in":"query","schemaId":"schema_851"},{"name":"limit","in":"query","schemaId":"schema_852"},{"name":"expand","in":"query","schemaId":"components/schemas/Expand"},{"name":"sort","in":"query","schemaId":"schema_853"}],"pointer":"/paths/~1v2.1~1orders/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[],"query":[{"name":"referenceId","in":"query","example":"B94TXY-1","schemaId":"schema_849"},{"name":"guestRef","in":"query","schemaId":"schema_850"},{"name":"offset","in":"query","example":0,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"},{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"},{"name":"sort","in":"query","schemaId":"schema_853"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/orders","href":"order/retrieveorders","openApiOperationId":"RetrieveOrders","summary":"List orders"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrdersResponse"}},"schemaId":"components/schemas/RetrieveOrdersResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrdersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrdersResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/retrieveorders"}],"panels":[]}]},"httpPath":"/v2.1/orders"},{"label":"Retrieve an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order/retrieveorder","routeSlug":"/cdp/order-rest-api/order/retrieveorder","metadata":{"seo":{"title":"Retrieve an order","description":"Retrieves an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrder","name":"Retrieve an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"components/schemas/Expand"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders/{orderRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/orders/{orderRef}","href":"order/retrieveorder","openApiOperationId":"RetrieveOrder","summary":"Retrieve an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}},"schemaId":"components/schemas/OrderCreateResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/retrieveorder"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}"},{"label":"Update an order","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order/updateorder","routeSlug":"/cdp/order-rest-api/order/updateorder","metadata":{"seo":{"title":"Update an order","description":"Updates an order. You can update orders that have the same referenceId and have orderedAt values (purchase dates) within two days of another. referenceId and orderedAt cannot be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrder","name":"Update an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an order. You can update orders that have the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values (purchase dates) within two days of another. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"schemaId":"components/schemas/OrderCreateRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/orders/{orderRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orders/{orderRef}","href":"order/updateorder","openApiOperationId":"UpdateOrder","summary":"Update an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}},"schemaId":"components/schemas/OrderCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBadRequestResponse"}},"schemaId":"components/schemas/OrderBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}}},{"code":"400","schemaId":"components/schemas/OrderBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/updateorder"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}"},{"label":"Partially update an order","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order/updateorder_1","routeSlug":"/cdp/order-rest-api/order/updateorder_1","metadata":{"seo":{"title":"Partially update an order","description":"Partially updates an order. You can update orders that have the same referenceId and have orderedAt values (purchase dates) within two days of another. referenceId and orderedAt cannot be updated."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrder_1","name":"Partially update an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Partially updates an order. You can update orders that have the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values (purchase dates) within two days of another. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cannot be updated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"schemaId":"components/schemas/OrderCreateRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/orders/{orderRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orders/{orderRef}","href":"order/updateorder_1","openApiOperationId":"UpdateOrder_1","summary":"Partially update an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}},"schemaId":"components/schemas/OrderCreateResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBadRequestResponse"}},"schemaId":"components/schemas/OrderBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderCreateResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderCreateResponse"}}},{"code":"400","schemaId":"components/schemas/OrderBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/updateorder_1"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}"},{"label":"Delete an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order/deleteorder_1","routeSlug":"/cdp/order-rest-api/order/deleteorder_1","metadata":{"seo":{"title":"Delete an order","description":"Deletes an order. An empty, 204 No Content response means that the deletion was successful."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOrder_1","name":"Delete an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an order. An empty, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"204 No Content"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response means that the deletion was successful."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orders/{orderRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/v2.1/orders/{orderRef}","href":"order/deleteorder_1","openApiOperationId":"DeleteOrder_1","summary":"Delete an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order/deleteorder_1"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}"}],"content":{"contentType":"group","meta":{"name":"Order"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An order object is the parent for all other objects and contains attributes that are common to the entire order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Order REST API matches orders that have the same "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values and have "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values (purchase dates) within two days of another."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/orders","summary":"Create an order","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order/createorder","deprecated":false},{"title":"/v2.1/orders","summary":"List orders","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/retrieveorders","deprecated":false},{"title":"/v2.1/orders/{orderRef}","summary":"Retrieve an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order/retrieveorder","deprecated":false},{"title":"/v2.1/orders/{orderRef}","summary":"Update an order","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order/updateorder","deprecated":false},{"title":"/v2.1/orders/{orderRef}","summary":"Partially update an order","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order/updateorder_1","deprecated":false},{"title":"/v2.1/orders/{orderRef}","summary":"Delete an order","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order/deleteorder_1","deprecated":false}]}]}]}]}},{"type":"group","label":"Order item","link":"/cdp/order-rest-api/order-item","routeSlug":"/cdp/order-rest-api/order-item","items":[{"label":"Create an order item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item/createorderitem","routeSlug":"/cdp/order-rest-api/order-item/createorderitem","metadata":{"seo":{"title":"Create an order item","description":"Creates an order item on an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrderItem","name":"Create an order item","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order item on an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order item reference. Use the order item reference to interact with a specific order item, for example, to retrieve it, update it, or create a data extension for it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"schemaId":"components/schemas/OrderItemRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/orders/{orderRef}/orderItems","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"responseCodes":["201","401"],"pointer":"/v2.1/orders/{orderRef}/orderItems","href":"order-item/createorderitem","openApiOperationId":"CreateOrderItem","summary":"Create an order item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderItemRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}},"schemaId":"components/schemas/OrderItemRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderItemRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item/createorderitem"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/orderItems"},{"label":"List order items for an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item/retrieveorderitems_1","routeSlug":"/cdp/order-rest-api/order-item/retrieveorderitems_1","metadata":{"seo":{"title":"List order items for an order","description":"Retrieves a list of order items for an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderItems_1","name":"List order items for an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order items for an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of order items for an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order item reference. Use the order item reference to interact with a specific order item, for example, to retrieve or update it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","schemaId":"schema_851"},{"name":"limit","in":"query","schemaId":"schema_852"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders/{orderRef}/orderItems","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","example":0,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/orders/{orderRef}/orderItems","href":"order-item/retrieveorderitems_1","openApiOperationId":"RetrieveOrderItems_1","summary":"List order items for an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderItemsResponse"}},"schemaId":"components/schemas/RetrieveOrderItemsResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1orderItems/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrderItemsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderItemsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item/retrieveorderitems_1"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/orderItems"},{"label":"Retrieve an order item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item/retrieveorderitem","routeSlug":"/cdp/order-rest-api/order-item/retrieveorderitem","metadata":{"seo":{"title":"Retrieve an order item","description":"Retrieves an order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderItem","name":"Retrieve an order item","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"components/schemas/Expand"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orderItems/{orderItemRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/orderItems/{orderItemRef}","href":"order-item/retrieveorderitem","openApiOperationId":"RetrieveOrderItem","summary":"Retrieve an order item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}},"schemaId":"components/schemas/OrderItemRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item/retrieveorderitem"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}"},{"label":"Update an order item","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item/updatesorderitem","routeSlug":"/cdp/order-rest-api/order-item/updatesorderitem","metadata":{"seo":{"title":"Update an order item","description":"Updates an order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdatesOrderItem","name":"Update an order item","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"schemaId":"components/schemas/OrderItemRequest","pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/orderItems/{orderItemRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"responseCodes":["200","401"],"pointer":"/v2.1/orderItems/{orderItemRef}","href":"order-item/updatesorderitem","openApiOperationId":"UpdatesOrderItem","summary":"Update an order item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderItemRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}},"schemaId":"components/schemas/OrderItemRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item/updatesorderitem"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}"},{"label":"Partially update an order item","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item/partiallyupdatesorderitem","routeSlug":"/cdp/order-rest-api/order-item/partiallyupdatesorderitem","metadata":{"seo":{"title":"Partially update an order item","description":"Partially updates an order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartiallyUpdatesOrderItem","name":"Partially update an order item","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates an order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"schemaId":"components/schemas/OrderItemRequest","pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/orderItems/{orderItemRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"responseCodes":["200","401"],"pointer":"/v2.1/orderItems/{orderItemRef}","href":"order-item/partiallyupdatesorderitem","openApiOperationId":"PartiallyUpdatesOrderItem","summary":"Partially update an order item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderItemRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderItemRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}},"schemaId":"components/schemas/OrderItemRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item/partiallyupdatesorderitem"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}"},{"label":"Delete an order item","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item/deleteorderitem","routeSlug":"/cdp/order-rest-api/order-item/deleteorderitem","metadata":{"seo":{"title":"Delete an order item","description":"Deletes an order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOrderItem","name":"Delete an order item","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order item","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes an order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orderItems/{orderItemRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/v2.1/orderItems/{orderItemRef}","href":"order-item/deleteorderitem","openApiOperationId":"DeleteOrderItem","summary":"Delete an order item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item/deleteorderitem"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}"}],"content":{"contentType":"group","meta":{"name":"Order item"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item","showPageActions":true},{"nodeType":"markdoc","content":"The order item object represents something that has been purchased as part of the order. For an airline reservation, an order item is typically one or more flight segments, or an ancillary item purchased in addition to the flight, such as excess baggage allowance or priority boarding."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/orders/{orderRef}/orderItems","summary":"Create an order item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-item/createorderitem","deprecated":false},{"title":"/v2.1/orders/{orderRef}/orderItems","summary":"List order items for an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-item/retrieveorderitems_1","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}","summary":"Retrieve an order item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-item/retrieveorderitem","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}","summary":"Update an order item","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-item/updatesorderitem","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}","summary":"Partially update an order item","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-item/partiallyupdatesorderitem","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}","summary":"Delete an order item","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-item/deleteorderitem","deprecated":false}]}]}]}]}},{"type":"group","label":"Order contact","link":"/cdp/order-rest-api/order-contact","routeSlug":"/cdp/order-rest-api/order-contact","items":[{"label":"Create an order contact","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-contact/createordercontact","routeSlug":"/cdp/order-rest-api/order-contact/createordercontact","metadata":{"seo":{"title":"Create an order contact","description":"Creates the primary contact on an order.In identifiers, make sure to provide enough identity information according to your organization's identity rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrderContact","name":"Create an order contact","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates the primary contact on an order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", make sure to provide enough identity information according to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/users/sitecore-cdp/identifying-guests-in-sitecore-cdp.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your organization's identity rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order contact reference. Use the order contact reference to interact with a specific contact, for example, to retrieve or update it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"schemaId":"components/schemas/OrderContactRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/orders/{orderRef}/contacts","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"responseCodes":["201","401"],"pointer":"/v2.1/orders/{orderRef}/contacts","href":"order-contact/createordercontact","openApiOperationId":"CreateOrderContact","summary":"Create an order contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderContactRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}},"schemaId":"components/schemas/OrderContactResponseObject"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderContactResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-contact/createordercontact"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/contacts"},{"label":"List order contacts for an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-contact/retrieveordercontacts","routeSlug":"/cdp/order-rest-api/order-contact/retrieveordercontacts","metadata":{"seo":{"title":"List order contacts for an order","description":"Retrieves a list of order contacts for an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderContacts","name":"List order contacts for an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List order contacts for an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of order contacts for an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order contact reference. Use the order contact reference to interact with a specific order contact, for example, to retrieve or update it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_856"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders/{orderRef}/contacts","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/expand"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/orders/{orderRef}/contacts","href":"order-contact/retrieveordercontacts","openApiOperationId":"RetrieveOrderContacts","summary":"List order contacts for an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderContactsResponse"}},"schemaId":"components/schemas/RetrieveOrderContactsResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1contacts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrderContactsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderContactsResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-contact/retrieveordercontacts"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/contacts"},{"label":"Retrieve an order contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-contact/retrievesordercontact","routeSlug":"/cdp/order-rest-api/order-contact/retrievesordercontact","metadata":{"seo":{"title":"Retrieve an order contact","description":"Retrieves an order contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrievesOrderContact","name":"Retrieve an order contact","isWebhook":false,"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an order contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderContactRef","in":"path","schemaId":"schema_857","required":true}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orderContacts/{orderContactRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderContactRef","in":"path","required":true,"example":"3b5cb55e-c616-424a-991c-a241d0024896","schemaId":"schema_857"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2.1/orderContacts/{orderContactRef}","href":"order-contact/retrievesordercontact","openApiOperationId":"RetrievesOrderContact","summary":"Retrieve an order contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}},"schemaId":"components/schemas/OrderContactResponseObject"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderContactResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-contact/retrievesordercontact"}],"panels":[]}]},"httpPath":"/v2.1/orderContacts/{orderContactRef}"},{"label":"Update an order contact","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-contact/updateordercontact","routeSlug":"/cdp/order-rest-api/order-contact/updateordercontact","metadata":{"seo":{"title":"Update an order contact","description":"Updates an order contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrderContact","name":"Update an order contact","isWebhook":false,"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an order contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderContactRef","in":"path","schemaId":"schema_857","required":true}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"schemaId":"components/schemas/OrderContactRequest","pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/orderContacts/{orderContactRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderContactRef","in":"path","required":true,"example":"3b5cb55e-c616-424a-991c-a241d0024896","schemaId":"schema_857"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orderContacts/{orderContactRef}","href":"order-contact/updateordercontact","openApiOperationId":"UpdateOrderContact","summary":"Update an order contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderContactRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}},"schemaId":"components/schemas/OrderContactResponseObject"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderContactResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-contact/updateordercontact"}],"panels":[]}]},"httpPath":"/v2.1/orderContacts/{orderContactRef}"},{"label":"Partially update an order contact","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-contact/partiallyupdateordercontact_1","routeSlug":"/cdp/order-rest-api/order-contact/partiallyupdateordercontact_1","metadata":{"seo":{"title":"Partially update an order contact","description":"Partially updates an order contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartiallyUpdateOrderContact_1","name":"Partially update an order contact","isWebhook":false,"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates an order contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderContactRef","in":"path","schemaId":"schema_857","required":true}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"schemaId":"components/schemas/OrderContactRequest","pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/orderContacts/{orderContactRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderContactRef","in":"path","required":true,"example":"3b5cb55e-c616-424a-991c-a241d0024896","schemaId":"schema_857"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orderContacts/{orderContactRef}","href":"order-contact/partiallyupdateordercontact_1","openApiOperationId":"PartiallyUpdateOrderContact_1","summary":"Partially update an order contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderContactRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderContactRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}},"schemaId":"components/schemas/OrderContactResponseObject"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderContactResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactResponseObject"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-contact/partiallyupdateordercontact_1"}],"panels":[]}]},"httpPath":"/v2.1/orderContacts/{orderContactRef}"},{"label":"Delete an order contact","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-contact/partiallyupdateordercontact","routeSlug":"/cdp/order-rest-api/order-contact/partiallyupdateordercontact","metadata":{"seo":{"title":"Delete an order contact","description":"Partially updates an order contact."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartiallyUpdateOrderContact","name":"Delete an order contact","isWebhook":false,"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order contact","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates an order contact."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderContactRef","in":"path","schemaId":"schema_857","required":true}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orderContacts/{orderContactRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderContactRef","in":"path","required":true,"example":"3b5cb55e-c616-424a-991c-a241d0024896","schemaId":"schema_857"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","401"],"pointer":"/v2.1/orderContacts/{orderContactRef}","href":"order-contact/partiallyupdateordercontact","openApiOperationId":"PartiallyUpdateOrderContact","summary":"Delete an order contact"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderContacts~1{orderContactRef}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-contact/partiallyupdateordercontact"}],"panels":[]}]},"httpPath":"/v2.1/orderContacts/{orderContactRef}"}],"content":{"contentType":"group","meta":{"name":"Order contact"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order contact","showPageActions":true},{"nodeType":"markdoc","content":"An order contact is a person who is the primary contact for an order. The same guest can be both the order contact and order consumer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/orders/{orderRef}/contacts","summary":"Create an order contact","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-contact/createordercontact","deprecated":false},{"title":"/v2.1/orders/{orderRef}/contacts","summary":"List order contacts for an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-contact/retrieveordercontacts","deprecated":false},{"title":"/v2.1/orderContacts/{orderContactRef}","summary":"Retrieve an order contact","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-contact/retrievesordercontact","deprecated":false},{"title":"/v2.1/orderContacts/{orderContactRef}","summary":"Update an order contact","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-contact/updateordercontact","deprecated":false},{"title":"/v2.1/orderContacts/{orderContactRef}","summary":"Partially update an order contact","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-contact/partiallyupdateordercontact_1","deprecated":false},{"title":"/v2.1/orderContacts/{orderContactRef}","summary":"Delete an order contact","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-contact/partiallyupdateordercontact","deprecated":false}]}]}]}]}},{"type":"group","label":"Order consumer","link":"/cdp/order-rest-api/order-consumer","routeSlug":"/cdp/order-rest-api/order-consumer","items":[{"label":"Create an order consumer","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/createorderconsumer","routeSlug":"/cdp/order-rest-api/order-consumer/createorderconsumer","metadata":{"seo":{"title":"Create an order consumer","description":"Creates a consumer on an order.In identifiers, make sure to provide enough identity information according to your organization's identity rules."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrderConsumer","name":"Create an order consumer","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a consumer on an order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"identifiers"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", make sure to provide enough identity information according to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://doc.sitecore.com/cdp/en/users/sitecore-cdp/identifying-guests-in-sitecore-cdp.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your organization's identity rules"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order consumer reference. Use the order consumer reference to interact with a specific consumer, for example, to retrieve or update it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"schemaId":"components/schemas/OrderConsumerRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/orders/{orderRef}/consumers","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"responseCodes":["200","401"],"pointer":"/v2.1/orders/{orderRef}/consumers","href":"order-consumer/createorderconsumer","openApiOperationId":"CreateOrderConsumer","summary":"Create an order consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderConsumerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}},"schemaId":"components/schemas/OrderConsumerResponseObject"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderConsumerResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/createorderconsumer"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/consumers"},{"label":"List consumers of an order","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/retrieveorderconsumers","routeSlug":"/cdp/order-rest-api/order-consumer/retrieveorderconsumers","metadata":{"seo":{"title":"List consumers of an order","description":"Retrieves a list of order consumers for an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderConsumers","name":"List consumers of an order","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List consumers of an order","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a list of order consumers for an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the response, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"items.ref"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains the order consumer reference. Use the order consumer reference to interact with a specific order consumer, for example, to retrieve or update it."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_858"},{"name":"offset","in":"query","schemaId":"schema_851"},{"name":"limit","in":"query","schemaId":"schema_852"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders/{orderRef}/consumers","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","example":0,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401"],"pointer":"/v2.1/orders/{orderRef}/consumers","href":"order-consumer/retrieveorderconsumers","openApiOperationId":"RetrieveOrderConsumers","summary":"List consumers of an order"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderConsumersResponse"}},"schemaId":"components/schemas/RetrieveOrderConsumersResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1consumers/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrderConsumersResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderConsumersResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/retrieveorderconsumers"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/consumers"},{"label":"Retrieve an order consumer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/retrieveorderconsumer","routeSlug":"/cdp/order-rest-api/order-consumer/retrieveorderconsumer","metadata":{"seo":{"title":"Retrieve an order consumer","description":"Retrieves an order consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderConsumer","name":"Retrieve an order consumer","isWebhook":false,"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves an order consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderConsumerRef","in":"path","schemaId":"schema_859","required":true}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orderConsumers/{orderConsumerRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderConsumerRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_859"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["201","400","401"],"pointer":"/v2.1/orderConsumers/{orderConsumerRef}","href":"order-consumer/retrieveorderconsumer","openApiOperationId":"RetrieveOrderConsumer","summary":"Retrieve an order consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}},"schemaId":"components/schemas/OrderConsumerResponseObject"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}},"schemaId":"components/schemas/OrderConsumerBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"201","schemaId":"components/schemas/OrderConsumerResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}}},{"code":"400","schemaId":"components/schemas/OrderConsumerBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/retrieveorderconsumer"}],"panels":[]}]},"httpPath":"/v2.1/orderConsumers/{orderConsumerRef}"},{"label":"Update an order consumer","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/updateorderconsumer","routeSlug":"/cdp/order-rest-api/order-consumer/updateorderconsumer","metadata":{"seo":{"title":"Update an order consumer","description":"Updates an order consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrderConsumer","name":"Update an order consumer","isWebhook":false,"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Updates an order consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderConsumerRef","in":"path","schemaId":"schema_859","required":true}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"schemaId":"components/schemas/OrderConsumerRequest","pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/orderConsumers/{orderConsumerRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderConsumerRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_859"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orderConsumers/{orderConsumerRef}","href":"order-consumer/updateorderconsumer","openApiOperationId":"UpdateOrderConsumer","summary":"Update an order consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderConsumerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}},"schemaId":"components/schemas/OrderConsumerResponseObject"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}},"schemaId":"components/schemas/OrderConsumerBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderConsumerResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}}},{"code":"400","schemaId":"components/schemas/OrderConsumerBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/updateorderconsumer"}],"panels":[]}]},"httpPath":"/v2.1/orderConsumers/{orderConsumerRef}"},{"label":"Partially update an order consumer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/partiallyupdateordeconsumer","routeSlug":"/cdp/order-rest-api/order-consumer/partiallyupdateordeconsumer","metadata":{"seo":{"title":"Partially update an order consumer","description":"Partially updates an order consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PartiallyUpdateOrdeConsumer","name":"Partially update an order consumer","isWebhook":false,"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates an order consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderConsumerRef","in":"path","schemaId":"schema_859","required":true}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"schemaId":"components/schemas/OrderConsumerRequest","pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/orderConsumers/{orderConsumerRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderConsumerRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_859"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orderConsumers/{orderConsumerRef}","href":"order-consumer/partiallyupdateordeconsumer","openApiOperationId":"PartiallyUpdateOrdeConsumer","summary":"Partially update an order consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/OrderConsumerRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/OrderConsumerRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}},"schemaId":"components/schemas/OrderConsumerResponseObject"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}},"schemaId":"components/schemas/OrderConsumerBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderConsumerResponseObject","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerResponseObject"}}},{"code":"400","schemaId":"components/schemas/OrderConsumerBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/partiallyupdateordeconsumer"}],"panels":[]}]},"httpPath":"/v2.1/orderConsumers/{orderConsumerRef}"},{"label":"Delete an order consumer","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/deleteorder","routeSlug":"/cdp/order-rest-api/order-consumer/deleteorder","metadata":{"seo":{"title":"Delete an order consumer","description":"Delete an order consumer. An empty, 204 response means that the deletion was successful."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOrder","name":"Delete an order consumer","isWebhook":false,"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order consumer","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete an order consumer. An empty, 204 response means that the deletion was successful."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderConsumerRef","in":"path","schemaId":"schema_859","required":true}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orderConsumers/{orderConsumerRef}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderConsumerRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_859"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","401"],"pointer":"/v2.1/orderConsumers/{orderConsumerRef}","href":"order-consumer/deleteorder","openApiOperationId":"DeleteOrder","summary":"Delete an order consumer"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Successful operation"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/deleteorder"}],"panels":[]}]},"httpPath":"/v2.1/orderConsumers/{orderConsumerRef}"},{"label":"List a consumer's order items","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-consumer/retrieveorderitems","routeSlug":"/cdp/order-rest-api/order-consumer/retrieveorderitems","metadata":{"seo":{"title":"List a consumer's order items","description":"Retrieves order items for a consumer."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderItems","name":"List a consumer's order items","isWebhook":false,"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}~1orderItems/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List a consumer's order items","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves order items for a consumer."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderConsumerRef","in":"path","schemaId":"schema_859","required":true}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}~1orderItems/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orderConsumers/{orderConsumerRef}/orderItems","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderConsumerRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_859"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2.1/orderConsumers/{orderConsumerRef}/orderItems","href":"order-consumer/retrieveorderitems","openApiOperationId":"RetrieveOrderItems","summary":"List a consumer's order items"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderItemsResponse"}},"schemaId":"components/schemas/RetrieveOrderItemsResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}},"schemaId":"components/schemas/OrderConsumerBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderConsumers~1{orderConsumerRef}~1orderItems/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrderItemsResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderItemsResponse"}}},{"code":"400","schemaId":"components/schemas/OrderConsumerBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderConsumerBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-consumer/retrieveorderitems"}],"panels":[]}]},"httpPath":"/v2.1/orderConsumers/{orderConsumerRef}/orderItems"}],"content":{"contentType":"group","meta":{"name":"Order consumer"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order consumer","showPageActions":true},{"nodeType":"markdoc","content":"An order consumer represents a person who is consuming an order item. If the order item is a flight, the order consumer is the traveler or passenger of the flight segment. If more than one order consumer is consuming the same order item, the order item has a quantity representing the number of order consumers.\n\n The same guest can be both the order contact and order consumer."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/orders/{orderRef}/consumers","summary":"Create an order consumer","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-consumer/createorderconsumer","deprecated":false},{"title":"/v2.1/orders/{orderRef}/consumers","summary":"List consumers of an order","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-consumer/retrieveorderconsumers","deprecated":false},{"title":"/v2.1/orderConsumers/{orderConsumerRef}","summary":"Retrieve an order consumer","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-consumer/retrieveorderconsumer","deprecated":false},{"title":"/v2.1/orderConsumers/{orderConsumerRef}","summary":"Update an order consumer","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-consumer/updateorderconsumer","deprecated":false},{"title":"/v2.1/orderConsumers/{orderConsumerRef}","summary":"Partially update an order consumer","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-consumer/partiallyupdateordeconsumer","deprecated":false},{"title":"/v2.1/orderConsumers/{orderConsumerRef}","summary":"Delete an order consumer","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-consumer/deleteorder","deprecated":false},{"title":"/v2.1/orderConsumers/{orderConsumerRef}/orderItems","summary":"List a consumer's order items","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-consumer/retrieveorderitems","deprecated":false}]}]}]}]}},{"type":"group","label":"Order data extension","link":"/cdp/order-rest-api/order-data-extension","routeSlug":"/cdp/order-rest-api/order-data-extension","items":[{"label":"Create an order data extension","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/createorderdataextension","routeSlug":"/cdp/order-rest-api/order-data-extension/createorderdataextension","metadata":{"seo":{"title":"Create an order data extension","description":"Creates an order data extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrderDataExtension","name":"Create an order data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order data extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To avoid creating key-value pairs that already exist in the data extension for an order, first retrieve all the data extensions for an order to check that the keys you intend to create are unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"order-data-extension/createorderdataextension/request/creating-the-request-body","deepLinkHash":"/order-data-extension/createorderdataextension#order-data-extension/createorderdataextension/request/creating-the-request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating the request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the request body, you must provide one object. This object represents the data extension. Note the following about the object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can contain primitive values only. You cannot nest objects. If you need to group key-value pairs, use prefixes for the key names."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can contain a maximum of 100 key-value pairs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key-value pairs you include in the object become the extension data. For example, if you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"firstTimeOrder\": true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the object, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"First Time Order"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes extension data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"level2\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"floating-point number, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"99.9"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"order-data-extension/createorderdataextension/request/naming-keys","deepLinkHash":"/order-data-extension/createorderdataextension#order-data-extension/createorderdataextension/request/naming-keys"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Naming keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The keys you enter in the request body must be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric [A-Z,a-z,0-9] as per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7159"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON RFC 7159"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In camel case."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"order-data-extension/createorderdataextension/request/example-request-body","deepLinkHash":"/order-data-extension/createorderdataextension#order-data-extension/createorderdataextension/request/example-request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here's an example request body:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{ \n\"firstTimeOrder\": true, \n\"storeLocation\": \"London\", \n\"totalUnits\": 8, \n\"totalDiscount\": \"20%\"\n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{ \n\"firstTimeOrder\": true, \n\"storeLocation\": \"London\", \n\"totalUnits\": 8, \n\"totalDiscount\": \"20%\"\n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This creates four key-value pairs for the order."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"schemaId":"components/schemas/DataExtensionCreateRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","href":"order-data-extension/createorderdataextension","openApiOperationId":"CreateOrderDataExtension","summary":"Create an order data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/DataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}},"schemaId":"components/schemas/DataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/createorderdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}"},{"label":"Retrieve an order data extension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/retrieveorderdataextension","routeSlug":"/cdp/order-rest-api/order-data-extension/retrieveorderdataextension","metadata":{"seo":{"title":"Retrieve an order data extension","description":"Retrieves a data extension for an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderDataExtension","name":"Retrieve an order data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a data extension for an order."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_861","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_862","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03","schemaId":"schema_861"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_862"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","href":"order-data-extension/retrieveorderdataextension","openApiOperationId":"RetrieveOrderDataExtension","summary":"Retrieve an order data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully retrieved.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}},"schemaId":"components/schemas/DataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/retrieveorderdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}"},{"label":"Update an order data extension","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/putorderdataextension","routeSlug":"/cdp/order-rest-api/order-data-extension/putorderdataextension","metadata":{"seo":{"title":"Update an order data extension","description":"Fully updates a data extension for an order, replacing the entire resource including all the key-value pairs with the data you send in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutOrderDataExtension","name":"Update an order data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fully updates a data extension for an order, replacing the entire resource including all the key-value pairs with the data you send in the request.\n\nTo update certain key-value pairs only, use the Partially update a data extension endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_862","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"schemaId":"components/schemas/DataExtensionCreateRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_862"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"responseCodes":["200","400"],"pointer":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","href":"order-data-extension/putorderdataextension","openApiOperationId":"PutOrderDataExtension","summary":"Update an order data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/DataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}},"schemaId":"components/schemas/DataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/putorderdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}"},{"label":"Partially update an order data extension","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/updateorderdataextension","routeSlug":"/cdp/order-rest-api/order-data-extension/updateorderdataextension","metadata":{"seo":{"title":"Partially update an order data extension","description":"Partially updates a data extension for an order, replacing only those key-value pairs in the resource that you provide in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrderDataExtension","name":"Partially update an order data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a data extension for an order, replacing only those key-value pairs in the resource that you provide in the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_862","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"schemaId":"components/schemas/DataExtensionCreateRequest","pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_862"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"responseCodes":["200","400"],"pointer":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","href":"order-data-extension/updateorderdataextension","openApiOperationId":"UpdateOrderDataExtension","summary":"Partially update an order data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/DataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}},"schemaId":"components/schemas/DataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/updateorderdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}"},{"label":"Delete an order data extension","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/deleteorderdataextension","routeSlug":"/cdp/order-rest-api/order-data-extension/deleteorderdataextension","metadata":{"seo":{"title":"Delete an order data extension","description":"Deletes the data extension for an order, including all the key-value pairs in the data extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOrderDataExtension","name":"Delete an order data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the data extension for an order, including all the key-value pairs in the data extension.\n\nTo delete certain key-value pairs only, use the Delete key-value pairs from a data extension endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_862","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_862"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","href":"order-data-extension/deleteorderdataextension","openApiOperationId":"DeleteOrderDataExtension","summary":"Delete an order data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"404","description":"Order data extension not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionNotFoundResponse"}},"schemaId":"components/schemas/DataExtensionNotFoundResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"404","schemaId":"components/schemas/DataExtensionNotFoundResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionNotFoundResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/deleteorderdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}"},{"label":"Delete key-value pairs from an order data extension","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/deleteorderdataextensionfields","routeSlug":"/cdp/order-rest-api/order-data-extension/deleteorderdataextensionfields","metadata":{"seo":{"title":"Delete key-value pairs from an order data extension","description":"Deletes the key-value pairs you provide in the name query parameter from a data extension for an order."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrderDataExtensionFields","name":"Delete key-value pairs from an order data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}~1fields/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete key-value pairs from an order data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the key-value pairs you provide in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter from a data extension for an order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if your data extension contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstTimeOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storeLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys, you can delete both keys and their values by making the following request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{baseURL}/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields?name=firstTimeOrder|storeLocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't provide the query parameter, this operation will empty the data extension: the data extension itself will not be deleted, but all the key-value pairs in it will."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_862","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}~1fields/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"components/schemas/name"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}~1fields/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_862"}],"query":[{"name":"name","in":"query","example":"withWarranty|color","schemaId":"components/schemas/name"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields","href":"order-data-extension/deleteorderdataextensionfields","openApiOperationId":"deleteOrderDataExtensionFields","summary":"Delete key-value pairs from an order data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}},"schemaId":"components/schemas/DataExtensionResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions~1{dataExtensionName}~1fields/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/deleteorderdataextensionfields"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields"},{"label":"Retrieve the URL for an order's data extension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-data-extension/retrieveorderdataextensions","routeSlug":"/cdp/order-rest-api/order-data-extension/retrieveorderdataextensions","metadata":{"seo":{"title":"Retrieve the URL for an order's data extension","description":"Retrieves the URL for the order's data extension. This lets you check if the data extension exists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"RetrieveOrderDataExtensions","name":"Retrieve the URL for an order's data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the URL for an order's data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the URL for the order's data extension. This lets you check if the data extension exists."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderRef","in":"path","schemaId":"schema_854","required":true}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","schemaId":"schema_851"},{"name":"limit","in":"query","schemaId":"schema_852"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orders/{orderRef}/extensions","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_854"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","example":0,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","401"],"pointer":"/v2.1/orders/{orderRef}/extensions","href":"order-data-extension/retrieveorderdataextensions","openApiOperationId":"RetrieveOrderDataExtensions","summary":"Retrieve the URL for an order's data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderDataExtensionResponse"}},"schemaId":"components/schemas/RetrieveOrderDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orders~1{orderRef}~1extensions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrderDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-data-extension/retrieveorderdataextensions"}],"panels":[]}]},"httpPath":"/v2.1/orders/{orderRef}/extensions"}],"content":{"contentType":"group","meta":{"name":"Order data extension"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order data extension","showPageActions":true},{"nodeType":"markdoc","content":"An order data extension is an object that lets you specify any key-value pairs you want. Order data extensions are optional and enable your organization to capture more robust information about your orders.\n\n To get started with this API, create a data extension for the order you previously created."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","summary":"Create an order data extension","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-data-extension/createorderdataextension","deprecated":false},{"title":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","summary":"Retrieve an order data extension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-data-extension/retrieveorderdataextension","deprecated":false},{"title":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","summary":"Update an order data extension","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-data-extension/putorderdataextension","deprecated":false},{"title":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","summary":"Partially update an order data extension","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-data-extension/updateorderdataextension","deprecated":false},{"title":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}","summary":"Delete an order data extension","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-data-extension/deleteorderdataextension","deprecated":false},{"title":"/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields","summary":"Delete key-value pairs from an order data extension","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-data-extension/deleteorderdataextensionfields","deprecated":false},{"title":"/v2.1/orders/{orderRef}/extensions","summary":"Retrieve the URL for an order's data extension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-data-extension/retrieveorderdataextensions","deprecated":false}]}]}]}]}},{"type":"group","label":"Order item data extension","link":"/cdp/order-rest-api/order-item-data-extension","routeSlug":"/cdp/order-rest-api/order-item-data-extension","items":[{"label":"Create an order item data extension","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/createorderitemdataextension","routeSlug":"/cdp/order-rest-api/order-item-data-extension/createorderitemdataextension","metadata":{"seo":{"title":"Create an order item data extension","description":"Creates an order item data extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"CreateOrderItemDataExtension","name":"Create an order item data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an order item data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an order item data extension."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To avoid creating key-value pairs that already exist in the data extension for an order item, first retrieve all the data extensions for an order item to check that the keys you intend to create are unique."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"order-item-data-extension/createorderitemdataextension/request/creating-the-request-body","deepLinkHash":"/order-item-data-extension/createorderitemdataextension#order-item-data-extension/createorderitemdataextension/request/creating-the-request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creating the request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In the request body, you must provide one object. This object represents the data extension. Note the following about the object:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can contain primitive values only. You cannot nest objects. If you need to group key-value pairs, use prefixes for the key names."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Can contain a maximum of 100 key-value pairs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The key-value pairs you include in the object become the extension data. For example, if you include "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"withWarranty\": true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the object, "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"With Warranty"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes extension data."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values:"},"children":[]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"string, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"level2\""},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"boolean, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"integer, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"9"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"floating-point number, for example "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"99.9"},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"order-item-data-extension/createorderitemdataextension/request/naming-keys","deepLinkHash":"/order-item-data-extension/createorderitemdataextension#order-item-data-extension/createorderitemdataextension/request/naming-keys"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Naming keys"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The keys you enter in the request body must be:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Alphanumeric [A-Z,a-z,0-9] as per the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc7159"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON RFC 7159"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"In camel case."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"order-item-data-extension/createorderitemdataextension/request/example-request-body","deepLinkHash":"/order-item-data-extension/createorderitemdataextension#order-item-data-extension/createorderitemdataextension/request/example-request-body"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example request body"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Here's an example request body:"},"children":[]}]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"{\n\"withWarranty\": true,\n\"color\": \"obsidian\", \n\"capacityInGb\": 128 \n}\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"{\n\"withWarranty\": true,\n\"color\": \"obsidian\", \n\"capacityInGb\": 128 \n}\n"},"children":[]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This creates three key-value pairs for the order item."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"schemaId":"components/schemas/DataExtensionCreateRequest","pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"responseCodes":["200","400","401"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","href":"order-item-data-extension/createorderitemdataextension","openApiOperationId":"CreateOrderItemDataExtension","summary":"Create an order item data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/DataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource successfully created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}},"schemaId":"components/schemas/DataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}},"schemaId":"components/schemas/OrderContactBadRequestResponse"},{"code":"401","description":"Unauthorized request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}},"schemaId":"components/schemas/UnauthorizedResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/DataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/OrderContactBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderContactBadRequestResponse"}}},{"code":"401","schemaId":"components/schemas/UnauthorizedResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/UnauthorizedResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/createorderitemdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}"},{"label":"Retrieve an order item data extension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/retrieveorderitemdataextension","routeSlug":"/cdp/order-rest-api/order-item-data-extension/retrieveorderitemdataextension","metadata":{"seo":{"title":"Retrieve an order item data extension","description":"Retrieves a data extension for an order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveOrderItemDataExtension","name":"Retrieve an order item data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an order item data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves a data extension for an order item."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","href":"order-item-data-extension/retrieveorderitemdataextension","openApiOperationId":"retrieveOrderItemDataExtension","summary":"Retrieve an order item data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}},"schemaId":"components/schemas/OrderItemDataExtensionResponse"},{"code":"404","description":"Order Item data extension not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionConflictResponse"}},"schemaId":"components/schemas/DataExtensionConflictResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}}},{"code":"404","schemaId":"components/schemas/DataExtensionConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/retrieveorderitemdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}"},{"label":"Update an order item data extension","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/putorderitemdataextension","routeSlug":"/cdp/order-rest-api/order-item-data-extension/putorderitemdataextension","metadata":{"seo":{"title":"Update an order item data extension","description":"Fully updates a data extension for an order item, replacing the entire resource including all the key-value pairs with the data you send in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PutOrderItemDataExtension","name":"Update an order item data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an order item data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Fully updates a data extension for an order item, replacing the entire resource including all the key-value pairs with the data you send in the request.\n\nTo update certain key-value pairs only, use the Partially update a data extension endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"schemaId":"components/schemas/DataExtensionCreateRequest","pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"responseCodes":["200","400"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","href":"order-item-data-extension/putorderitemdataextension","openApiOperationId":"PutOrderItemDataExtension","summary":"Update an order item data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/DataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}},"schemaId":"components/schemas/OrderItemDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/putorderitemdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}"},{"label":"Partially update an order item data extension","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/updateorderitemdataextension_1","routeSlug":"/cdp/order-rest-api/order-item-data-extension/updateorderitemdataextension_1","metadata":{"seo":{"title":"Partially update an order item data extension","description":"Partially updates a data extension for an order, replacing only those key-value pairs in the resource that you provide in the request."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrderItemDataExtension_1","name":"Partially update an order item data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partially update an order item data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Partially updates a data extension for an order, replacing only those key-value pairs in the resource that you provide in the request."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"schemaId":"components/schemas/DataExtensionCreateRequest","pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"responseCodes":["200","400"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","href":"order-item-data-extension/updateorderitemdataextension_1","openApiOperationId":"UpdateOrderItemDataExtension_1","summary":"Partially update an order item data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"schemaId":"components/schemas/DataExtensionCreateRequest","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DataExtensionCreateRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}},"schemaId":"components/schemas/OrderItemDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/updateorderitemdataextension_1"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}"},{"label":"Delete an order item data extension","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/deleteorderitemdataextension","routeSlug":"/cdp/order-rest-api/order-item-data-extension/deleteorderitemdataextension","metadata":{"seo":{"title":"Delete an order item data extension","description":"Deletes the data extension for an order item, including all the key-value pairs in the data extension."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DeleteOrderItemDataExtension","name":"Delete an order item data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an order item data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Deletes the data extension for an order item, including all the key-value pairs in the data extension.\n\nTo delete certain key-value pairs only, use the Delete key-value pairs from a data extension endpoint instead."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","href":"order-item-data-extension/deleteorderitemdataextension","openApiOperationId":"DeleteOrderItemDataExtension","summary":"Delete an order item data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"404","description":"Order Item data extension not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionConflictResponse"}},"schemaId":"components/schemas/DataExtensionConflictResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{}}},{"code":"404","schemaId":"components/schemas/DataExtensionConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/deleteorderitemdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}"},{"label":"Delete key-value pairs from an order item data extension","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/updateorderitemdataextension","routeSlug":"/cdp/order-rest-api/order-item-data-extension/updateorderitemdataextension","metadata":{"seo":{"title":"Delete key-value pairs from an order item data extension","description":"Deletes the key-value pairs you provide in the name query parameter from a data extension for an order item."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"UpdateOrderItemDataExtension","name":"Delete key-value pairs from an order item data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}~1fields/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete key-value pairs from an order item data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes the key-value pairs you provide in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter from a data extension for an order item."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, if your data extension contains the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstTimeOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"storeLocation"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" keys, you can delete both keys and their values by making the following request:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{baseURL}/v2.1/orders/{orderRef}/extensions/{dataExtensionName}/fields?name=firstTimeOrder|storeLocation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you don't provide the query parameter, this operation will empty the data extension: the data extension itself will not be deleted, but all the key-value pairs in it will."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true},{"name":"dataExtensionName","in":"path","schemaId":"schema_860","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}~1fields/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"components/schemas/name"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}~1fields/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}/fields","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"},{"name":"dataExtensionName","in":"path","required":true,"example":"ext","schemaId":"schema_860"}],"query":[{"name":"name","in":"query","example":"withWarranty|color","schemaId":"components/schemas/name"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}/fields","href":"order-item-data-extension/updateorderitemdataextension","openApiOperationId":"UpdateOrderItemDataExtension","summary":"Delete key-value pairs from an order item data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}},"schemaId":"components/schemas/OrderItemDataExtensionResponse"},{"code":"400","description":"Bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}},"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions~1{dataExtensionName}~1fields/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/OrderItemDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/OrderItemDataExtensionResponse"}}},{"code":"400","schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionUpdateBadRequestResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/updateorderitemdataextension"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}/fields"},{"label":"Retrieve the URL for an order item's data extension","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/cdp/order-rest-api/order-item-data-extension/retrieveorderitemdataextensions","routeSlug":"/cdp/order-rest-api/order-item-data-extension/retrieveorderitemdataextensions","metadata":{"seo":{"title":"Retrieve the URL for an order item's data extension","description":"Retrieves the URL for the order item's data extension. This lets you check if the data extension exists."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"retrieveOrderItemDataExtensions","name":"Retrieve the URL for an order item's data extension","isWebhook":false,"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the URL for an order item's data extension","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves the URL for the order item's data extension. This lets you check if the data extension exists."},{"nodeType":"security","requirements":[{"schemes":[{"name":"BasicAuth","scopes":[],"type":"http","scheme":"basic"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"orderItemRef","in":"path","schemaId":"schema_855","required":true}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","schemaId":"schema_851"},{"name":"limit","in":"query","schemaId":"schema_852"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2.1/orderItems/{orderItemRef}/extensions","servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"parameters":{"path":[{"name":"orderItemRef","in":"path","required":true,"example":"2d7de9df-45a2-45ea-872c-30e45139007d","schemaId":"schema_855"}],"query":[{"name":"expand","in":"query","example":true,"schemaId":"components/schemas/Expand"},{"name":"offset","in":"query","example":0,"schemaId":"components/schemas/Offset"},{"name":"limit","in":"query","example":40,"schemaId":"components/schemas/Limit"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"BasicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v2.1/orderItems/{orderItemRef}/extensions","href":"order-item-data-extension/retrieveorderitemdataextensions","openApiOperationId":"retrieveOrderItemDataExtensions","summary":"Retrieve the URL for an order item's data extension"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderItemDataExtensionResponse"}},"schemaId":"components/schemas/RetrieveOrderItemDataExtensionResponse"},{"code":"404","description":"Order Item data extension not found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionConflictResponse"}},"schemaId":"components/schemas/DataExtensionConflictResponse"}],"pointer":"/paths/~1v2.1~1orderItems~1{orderItemRef}~1extensions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"components/schemas/RetrieveOrderItemDataExtensionResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/RetrieveOrderItemDataExtensionResponse"}}},{"code":"404","schemaId":"components/schemas/DataExtensionConflictResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DataExtensionConflictResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/order-item-data-extension/retrieveorderitemdataextensions"}],"panels":[]}]},"httpPath":"/v2.1/orderItems/{orderItemRef}/extensions"}],"content":{"contentType":"group","meta":{"name":"Order item data extension"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Order item data extension","showPageActions":true},{"nodeType":"markdoc","content":"An order item data extension is an object that lets you specify any key-value pairs you want. Order data extensions are optional and enable your organization to capture more robust information about your order items.\n\n To get started with this API, create a data extension for the order items you previously created."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","summary":"Create an order item data extension","prefix":{"name":"post","color":"post"},"badges":[],"link":"/order-item-data-extension/createorderitemdataextension","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","summary":"Retrieve an order item data extension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-item-data-extension/retrieveorderitemdataextension","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","summary":"Update an order item data extension","prefix":{"name":"put","color":"put"},"badges":[],"link":"/order-item-data-extension/putorderitemdataextension","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","summary":"Partially update an order item data extension","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/order-item-data-extension/updateorderitemdataextension_1","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}","summary":"Delete an order item data extension","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-item-data-extension/deleteorderitemdataextension","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}/extensions/{dataExtensionName}/fields","summary":"Delete key-value pairs from an order item data extension","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/order-item-data-extension/updateorderitemdataextension","deprecated":false},{"title":"/v2.1/orderItems/{orderItemRef}/extensions","summary":"Retrieve the URL for an order item's data extension","prefix":{"name":"get","color":"get"},"badges":[],"link":"/order-item-data-extension/retrieveorderitemdataextensions","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/UnauthorizedResponse":{"id":"components/schemas/UnauthorizedResponse","kind":"json-schema","title":"UnauthorizedResponse","data":{"type":"object","properties":{"status":{"type":"string","description":"The HTTP request status.","format":"uppercase","example":"UNAUTHORIZED"},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":401},"message":{"type":"string","description":"Error description.","example":"Authentication credentials are required to access the resource. All requests must be authenticated."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/OrderItemLinkFirst":{"id":"components/schemas/OrderItemLinkFirst","kind":"json-schema","title":"OrderItemLinkFirst","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/111d106a-feff-42b2-90fb-a6ed136ec333"}},"description":"The request's first list of order items URL."}},"components/schemas/OrderItemLinkLast":{"id":"components/schemas/OrderItemLinkLast","kind":"json-schema","title":"OrderItemLinkLast","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/111d106a-feff-42b2-90fb-a6ed136ec333"}},"description":"The request's last list of order items URL."}},"components/schemas/OrderItemNext":{"id":"components/schemas/OrderItemNext","kind":"json-schema","title":"OrderItemNext","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/orderItems?offset=1&limit=10"}},"description":"The request's next list of order items URL."}},"components/schemas/RetrieveOrderItemsResponse":{"id":"components/schemas/RetrieveOrderItemsResponse","kind":"json-schema","title":"RetrieveOrderItemsResponse","data":{"type":"object","properties":{"offset":{"type":"integer","description":"The request's offset.","format":"int32","example":0},"limit":{"type":"integer","description":"The request's limit.","format":"int32","example":10},"first":{"$ref":"#/components/schemas/OrderItemLinkFirst"},"last":{"$ref":"#/components/schemas/OrderItemLinkLast"},"next":{"$ref":"#/components/schemas/OrderItemNext"},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/orderItems?offset=0&limit=10"},"items":{"type":"array","format":"List","items":{"$ref":"#/components/schemas/items"}}}}},"components/schemas/items":{"id":"components/schemas/items","kind":"json-schema","title":"items","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/111d106a-feff-42b2-90fb-a6ed136ec333"}},"description":"orderItems"}},"components/schemas/OrderConsumerBadRequestResponse":{"id":"components/schemas/OrderConsumerBadRequestResponse","kind":"json-schema","title":"OrderConsumerBadRequestResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":400},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":400},"message":{"type":"string","description":"firstName: firstName may not be null."},"developerMessage":{"type":"string","description":"Error description for developers.","example":"firstName: may not be null."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/CollectionResourceLink":{"id":"components/schemas/CollectionResourceLink","kind":"json-schema","title":"CollectionResourceLink","data":{"type":"object","properties":{"href":{"type":"string"},"offset":{"type":"object"},"nextOffset":{"type":"object"},"limit":{"type":"integer","format":"int32"},"first":{"$ref":"#/components/schemas/Link"},"prev":{"$ref":"#/components/schemas/Link"},"next":{"$ref":"#/components/schemas/Link"},"last":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Link"}}}}},"components/schemas/Link":{"id":"components/schemas/Link","kind":"json-schema","title":"Link","data":{"type":"object","properties":{"href":{"type":"string"}}}},"components/schemas/OrderConsumerResponseObject":{"id":"components/schemas/OrderConsumerResponseObject","kind":"json-schema","title":"OrderConsumerResponseObject","data":{"type":"object","properties":{"ref":{"type":"string","description":"The order consumer reference.\n","format":"UUID","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"href":{"type":"string","description":"The link to the order consumer.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderConsumers/2d7de9df-45a2-45ea-872c-30e45139007d"},"title":{"type":"string","description":"The title of the person.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","format":"title case","example":"Mr"},"firstName":{"type":"string","description":"The person's first name.","format":"title case","example":"John"},"lastName":{"type":"string","description":"The person's last name.","format":"title case recommended","example":"Doe"},"gender":{"type":"string","description":"The person's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","format":"lowercase","example":"male","enum":["male","female","unknown"]},"dateOfBirth":{"type":"string","description":"The person's date of birth. Validation: Date must be in the past.\n","format":"date-time","example":"1991-01-01T16:17:16Z"},"emails":{"type":"array","description":"All the email addresses of the person.\n","example":["john.doe@gmail.com"],"items":{"type":"string","description":"All the email addresses of the person.\n","example":"[\"john.doe@gmail.com\"]"}},"phoneNumbers":{"type":"array","description":"The phone numbers of the person.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numbers of the person.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"nationality":{"type":"string","description":"The person's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","format":"title case","example":"Irish"},"passportNumber":{"type":"string","description":"The passport number of the guest.\n","format":"uppercase","example":"PZ4A9565"},"country":{"type":"string","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","format":"2-letter ISO 3166-1 Alpha-2 country code","example":"IE"},"orderItems":{"$ref":"#/components/schemas/OrderItemResponseObj"},"order":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"}},"description":"The link to the order."},"guest":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"}},"description":"The link to the guest."}}}},"components/schemas/OrderItemResponseObj":{"id":"components/schemas/OrderItemResponseObj","kind":"json-schema","title":"OrderItemResponseObj","data":{"type":"object","properties":{"orderItems":{"type":"array","format":"List","items":{"$ref":"#/components/schemas/OrderItemLinkLast"}}},"description":"Order item details, containing a list of items."}},"components/schemas/guest":{"id":"components/schemas/guest","kind":"json-schema","title":"guest","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"}},"description":"The link to the guest.\n","format":"object"}},"components/schemas/order":{"id":"components/schemas/order","kind":"json-schema","title":"order","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"}},"description":"The link to the order.\n","format":"object"}},"components/schemas/Identifier":{"id":"components/schemas/Identifier","kind":"json-schema","title":"Identifier","data":{"type":"object","properties":{"provider":{"type":"string","description":"The identifier provider.","example":"ProfileSystem"},"id":{"type":"string","description":"The identifier ID.","example":"B7524AE6-CF1C-440F-B1A2-0C9D42F5CB41"}}}},"components/schemas/OrderConsumerRequest":{"id":"components/schemas/OrderConsumerRequest","kind":"json-schema","title":"OrderConsumerRequest","data":{"type":"object","properties":{"title":{"type":"string","description":"The title of the person.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","format":"title case","example":"Mr"},"firstName":{"type":"string","description":"The person's first name.","format":"title case","example":"John"},"lastName":{"type":"string","description":"The person's last name.","format":"title case recommended","example":"Doe"},"gender":{"type":"string","description":"The person's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","format":"lowercase","example":"male","enum":["male","female","unknown"]},"dateOfBirth":{"type":"string","description":"The person's date of birth. Validation: Date must be in the past.\n","format":"date-time","example":"1991-01-01T16:17:16Z"},"emails":{"type":"array","description":"All the email addresses of the person.\n","example":["john.doe@gmail.com"],"items":{"type":"string","description":"All the email addresses of the person.\n","example":"[\"john.doe@gmail.com\"]"}},"phoneNumbers":{"type":"array","description":"The phone numbers of the person.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numbers of the person.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"nationality":{"type":"string","description":"The person's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","format":"title case","example":"Irish"},"passportNumber":{"type":"string","description":"The passport number of the guest.\n","format":"uppercase","example":"PZ4A9565"},"country":{"type":"string","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","format":"2-letter ISO 3166-1 Alpha-2 country code","example":"IE"},"identifiers":{"type":"array","description":"The guest's identifiers.","items":{"$ref":"#/components/schemas/Identifier"}}}}},"components/schemas/OrderContactBadRequestResponse":{"id":"components/schemas/OrderContactBadRequestResponse","kind":"json-schema","title":"OrderContactBadRequestResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":400},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":400},"message":{"type":"string","description":"description message","example":"firstName: may not be null."},"developerMessage":{"type":"string","description":"Error description for developers.","example":"firstName: may not be null."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/GuestLink":{"id":"components/schemas/GuestLink","kind":"json-schema","title":"GuestLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"}},"description":"List of order contacts.","example":[]}},"components/schemas/OrderContactResponseObject":{"id":"components/schemas/OrderContactResponseObject","kind":"json-schema","title":"OrderContactResponseObject","data":{"type":"object","properties":{"ref":{"type":"string","description":"The order contact reference.\n","format":"UUID","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"href":{"type":"string","description":"The link to the order contact.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderContacts/2d7de9df-45a2-45ea-872c-30e45139007d"},"firstName":{"type":"string","description":"The person's first name.","format":"title case","example":"John"},"lastName":{"type":"string","description":"The person's last name.","format":"title case recommended","example":"Doe"},"emails":{"type":"array","description":"All the email addresses of the person.\n","example":["john.doe@gmail.com"],"items":{"type":"string","description":"All the email addresses of the person.\n","example":"[\"john.doe@gmail.com\"]"}},"identifiers":{"type":"array","description":"The guest's identifiers.","items":{"$ref":"#/components/schemas/Identifier"}},"street":{"type":"array","description":"The order contact's street address.","example":["Tara St.","Main Ave."],"items":{"type":"string"}},"city":{"type":"string","description":"The order contact's city.","format":"String","example":"Dublin"},"state":{"type":"string","description":"The order contact's state.","format":"String","example":"New York"},"postCode":{"type":"string","description":"The order contact's post code.","format":"String","example":"10001"},"title":{"type":"string","description":"The title of the person.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","format":"title case","example":"Mr"},"gender":{"type":"string","description":"The person's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","format":"lowercase","example":"male","enum":["male","female","unknown"]},"dateOfBirth":{"type":"string","description":"The person's date of birth. Validation: Date must be in the past.\n","format":"date-time","example":"1991-01-01T16:17:16Z"},"phoneNumbers":{"type":"array","description":"The phone numbers of the person.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numbers of the person.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"nationality":{"type":"string","description":"The person's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","format":"title case","example":"Irish"},"passportNumber":{"type":"string","description":"The passport number of the contact.\n","format":"uppercase","example":"PZ4A9565"},"country":{"type":"string","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","format":"2-letter ISO 3166-1 Alpha-2 country code","example":"IE"},"order":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"}},"description":"The link to the order."},"guest":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/guests/f7aabbca-1c1b-4fc2-be72-3e16294a4f03"}},"description":"The link to the guest."}}}},"components/schemas/OrderLinkFirst":{"id":"components/schemas/OrderLinkFirst","kind":"json-schema","title":"OrderLinkFirst","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"}},"description":"The request's first list of orders URL."}},"components/schemas/OrderContactRequest":{"id":"components/schemas/OrderContactRequest","kind":"json-schema","title":"OrderContactRequest","data":{"type":"object","properties":{"firstName":{"type":"string","description":"The person's first name.","format":"title case","example":"John"},"lastName":{"type":"string","description":"The person's last name.","format":"title case recommended","example":"Doe"},"emails":{"type":"array","description":"All the email addresses of the person.\n","example":["john.doe@gmail.com"],"items":{"type":"string","description":"All the email addresses of the person.\n","example":"[\"john.doe@gmail.com\"]"}},"identifiers":{"type":"array","description":"The guest's identifiers.","items":{"$ref":"#/components/schemas/Identifier"}},"street":{"type":"array","description":"The order contact's street address.","example":["Tara St.","Main Ave."],"items":{"type":"string"}},"city":{"type":"string","description":"The order contact's city.","format":"String","example":"Dublin"},"state":{"type":"string","description":"The order contact's post code.","format":"String","example":"10001"},"title":{"type":"string","description":"The title of the person.\n\nExample values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","format":"title case","example":"Mr"},"gender":{"type":"string","description":"The person's gender.\n\nExample values: \"male\", \"female\", \"unknown\"\n","format":"lowercase","example":"male","enum":["male","female","unknown"]},"dateOfBirth":{"type":"string","description":"The person's date of birth. Validation: Date must be in the past.\n","format":"date-time","example":"1991-01-01T16:17:16Z"},"phoneNumbers":{"type":"array","description":"The phone numbers of the person.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numbers of the person.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"nationality":{"type":"string","description":"The person's nationality.\n\nExample values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","format":"title case","example":"Irish"},"passportNumber":{"type":"string","description":"The passport number of the contact.\n","format":"uppercase","example":"PZ4A9565"},"country":{"type":"string","description":"The guest's country.\n\nExample values: \"IE\", \"GB\", \"ES\", \"FR\"","format":"2-letter ISO 3166-1 Alpha-2 country code","example":"IE"}}}},"components/schemas/DataExtensionResponse":{"id":"components/schemas/DataExtensionResponse","kind":"json-schema","title":"DataExtensionResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the data extension.","example":"ext"},"href":{"type":"string","description":"The URL of the order extension.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions/ext"},"ref":{"type":"string","description":"The order extension reference.\n","example":"6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2"},"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"default\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"default"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was last updated in Sitecore CDP.","format":"date-time","example":"2024-01-01T16:17:16Z"},"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values: string, boolean, integer, floating-point number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"firstTimeOrder\": true"},"children":[]}]}]}],"example":"{exampleValue1}"},"{exampleKey2}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values: string, boolean, integer, floating-point number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"storeLocation\": \"London\""},"children":[]}]}]}],"example":"{exampleValue2}"},"order":{"$ref":"#/components/schemas/OrderLinkFirst"}}}},"components/schemas/DataExtensionCreateRequest":{"id":"components/schemas/DataExtensionCreateRequest","kind":"json-schema","title":"DataExtensionCreateRequest","data":{"required":["name"],"type":"object","properties":{"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values: string, boolean, integer, floating-point number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"firstTimeOrder\": true"},"children":[]}]}]}],"example":"{exampleValue1}"},"{exampleKey2}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair of your choice."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported data types for the values: string, boolean, integer, floating-point number."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example:"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"storeLocation\": \"London\""},"children":[]}]}]}],"example":"{exampleValue2}"}}}},"components/schemas/DataExtensionNotFoundResponse":{"id":"components/schemas/DataExtensionNotFoundResponse","kind":"json-schema","title":"DataExtensionNotFoundResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":404},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":404},"message":{"type":"string","description":"Error description.","example":"The specified resource does not exist."},"developerMessage":{"type":"string","description":"Error description for developers.","example":"Data extension ext2 for Guest ref ea9b4612-3488-47d9-beea-17404876f5d6 and client key ... was not found for v2.1"},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/name":{"id":"components/schemas/name","kind":"json-schema","title":"name","data":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":"The fields in the data extension object that you want to delete.","example":"withWarranty|color","items":{"type":"string","description":"The fields in the data extension object that you want to delete.","example":"withWarranty|color","default":""}}},"components/schemas/OrderDataExtensionFirstLink":{"id":"components/schemas/OrderDataExtensionFirstLink","kind":"json-schema","title":"OrderDataExtensionFirstLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"}},"description":"The request's first list of order data extensions URL."}},"components/schemas/OrderDataExtensionLastLink":{"id":"components/schemas/OrderDataExtensionLastLink","kind":"json-schema","title":"OrderDataExtensionLastLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"}},"description":"The request's last list of order data extensions URL."}},"components/schemas/OrderDataExtensionLink":{"id":"components/schemas/OrderDataExtensionLink","kind":"json-schema","title":"OrderDataExtensionLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions/ext"}}}},"components/schemas/OrderDataExtensionNextLink":{"id":"components/schemas/OrderDataExtensionNextLink","kind":"json-schema","title":"OrderDataExtensionNextLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"}},"description":"The request's next list of order data extensions URL."}},"components/schemas/OrderHref":{"id":"components/schemas/OrderHref","kind":"json-schema","title":"OrderHref","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51"}}}},"components/schemas/RetrieveOrderDataExtensionResponse":{"id":"components/schemas/RetrieveOrderDataExtensionResponse","kind":"json-schema","title":"RetrieveOrderDataExtensionResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the data extension.","example":"ext"},"offset":{"type":"integer","description":"The request's offset.","format":"int32","example":0},"limit":{"type":"integer","description":"The request's limit.","format":"int32","example":10},"first":{"$ref":"#/components/schemas/OrderDataExtensionFirstLink"},"last":{"$ref":"#/components/schemas/OrderDataExtensionLastLink"},"next":{"$ref":"#/components/schemas/OrderDataExtensionNextLink"},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions/ext"},"items":{"type":"array","description":"The request's data extension items.","format":"List","items":{"$ref":"#/components/schemas/OrderDataExtensionLink"}},"order":{"$ref":"#/components/schemas/OrderHref"}}}},"components/schemas/Expand":{"id":"components/schemas/Expand","kind":"json-schema","title":"Expand","data":{"type":"array","properties":{"empty":{"type":"boolean"}},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":true,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":"true","default":""}}},"components/schemas/Offset":{"id":"components/schemas/Offset","kind":"json-schema","title":"Offset","data":{"type":"object","description":"Collection responses use offset pagination. The offset query parameter is used to exclude from a response the first N items of the entire resource collection.","example":0,"default":"0"}},"components/schemas/Limit":{"id":"components/schemas/Limit","kind":"json-schema","title":"Limit","data":{"maximum":100,"minimum":10,"type":"object","description":"Collection responses use offset pagination. This query parameter lets you adjust the maximum number of collection items to return for a single request.\n","example":40,"default":"10"}},"components/schemas/DataExtensionUpdateBadRequestResponse":{"id":"components/schemas/DataExtensionUpdateBadRequestResponse","kind":"json-schema","title":"DataExtensionUpdateBadRequestResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":400},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":400},"message":{"type":"string","description":"Error description.","example":"Unable to parse JSON string"},"developerMessage":{"type":"string","description":"Error description for developers.","example":"JSON parse error [line: 7, column: 6]."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"http://support.sitecore.com"}}}},"components/schemas/DataExtensionConflictResponse":{"id":"components/schemas/DataExtensionConflictResponse","kind":"json-schema","title":"DataExtensionConflictResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":409},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":409},"message":{"type":"string","description":"Error description.","example":"Data extension ext already exists."},"developerMessage":{"type":"string","description":"Error description for developers.","example":"409 (Conflict): Data extension ext already exists."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/OrderItemDataExtensionResponse":{"id":"components/schemas/OrderItemDataExtensionResponse","kind":"json-schema","title":"OrderItemDataExtensionResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the data extension.","example":"ext"},"href":{"type":"string","description":"The URL of the order item extension.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/f7aabbca-1c1b-4fc2-be72-3e16294a4f03/extensions/ext"},"ref":{"type":"string","description":"The order item extension reference.\n","example":"6a5cb3c2-1a4a-56d8-8a01-1ede232b9db2"},"key":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"default\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"default"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was last updated in Sitecore CDP.","format":"date-time","example":"2024-01-01T16:17:16Z"},"{exampleKey1}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair in the data extension."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"withWarranty\": true"},"children":[]}]}]}],"example":"{exampleValue1}"},"{exampleKey2}":{"type":["string","boolean","integer","number"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A key-value pair in the data extension."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"\"color\": \"obsidian\""},"children":[]}]}]}],"example":"{exampleValue2}"},"orderItem":{"$ref":"#/components/schemas/OrderItemLinkLast"}}}},"components/schemas/OrderItemDataExtensionFirstLink":{"id":"components/schemas/OrderItemDataExtensionFirstLink","kind":"json-schema","title":"OrderItemDataExtensionFirstLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"}},"description":"The request's first list of order item data extensions URL."}},"components/schemas/OrderItemDataExtensionLastLink":{"id":"components/schemas/OrderItemDataExtensionLastLink","kind":"json-schema","title":"OrderItemDataExtensionLastLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"}},"description":"The request's last list of order item data extensions URL."}},"components/schemas/OrderItemDataExtensionLink":{"id":"components/schemas/OrderItemDataExtensionLink","kind":"json-schema","title":"OrderItemDataExtensionLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions/ext"}}}},"components/schemas/OrderItemDataExtensionNextLink":{"id":"components/schemas/OrderItemDataExtensionNextLink","kind":"json-schema","title":"OrderItemDataExtensionNextLink","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"}},"description":"The request's next list of order item data extensions URL."}},"components/schemas/RetrieveOrderItemDataExtensionResponse":{"id":"components/schemas/RetrieveOrderItemDataExtensionResponse","kind":"json-schema","title":"RetrieveOrderItemDataExtensionResponse","data":{"type":"object","properties":{"name":{"type":"string","description":"The name of the data extension.","example":"ext"},"offset":{"type":"integer","description":"The request's offset.","format":"int32","example":0},"limit":{"type":"integer","description":"The request's limit.","format":"int32","example":10},"first":{"$ref":"#/components/schemas/OrderItemDataExtensionFirstLink"},"last":{"$ref":"#/components/schemas/OrderItemDataExtensionLastLink"},"next":{"$ref":"#/components/schemas/OrderItemDataExtensionNextLink"},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/cadd106a-feff-42b2-90fb-a6ed136ece51/extensions"},"items":{"type":"array","description":"The request's data extension items.","format":"List","items":{"$ref":"#/components/schemas/OrderItemDataExtensionLink"}},"order":{"$ref":"#/components/schemas/OrderHref"}}}},"components/schemas/OrderItemRequestResponse":{"id":"components/schemas/OrderItemRequestResponse","kind":"json-schema","title":"OrderItemRequestResponse","data":{"type":"object","properties":{"ref":{"type":"string","description":"The order item reference. This is a unique identifier of the order item. Use the order item reference to interact with a specific order item, for example, to retrieve it, update it, or create a data extension for it.\n","format":"UUID","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"href":{"type":"string","description":"The link to the order item.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderItems/2d7de9df-45a2-45ea-872c-30e45139007d"},"name":{"type":"string","description":"The name of the order item. Free text value. Maximum character limit: 128 \n","example":"Mobile AZ10"},"description":{"type":"string","description":"The description of the order item. \n","example":"Mobile AZ10 description"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was updated in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"orderedAt":{"type":"string","description":"The date and time when the order item was made.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"type":{"type":"string","description":"The type of order item.\n","example":"MOBILE"},"productId":{"type":"string","description":"The ID of the product.\n","example":"1233-44"},"price":{"type":"number","description":"The organization's price for the order item.\n","example":105},"currencyCode":{"type":"string","description":"The organization's currency code for the order item. \n","example":"EUR"},"originalPrice":{"type":"number","description":"The unit price of the order item before conversion to the organization's currency. \n","example":110},"originalCurrencyCode":{"type":"string","description":"The original currency code for the order item. \n","example":"USD"},"referenceId":{"type":"string","description":"An ID generated by the client to reference the order item. \n","example":"AAAAA-134"},"vendor":{"type":"string","description":"The organization that is selling the order item. \n","example":"Vendor XYZ"},"status":{"type":"string","description":"The status of the order item. \n","example":"CONFIRMED"},"language":{"type":"string","description":"The language used when making the order.\n","example":"EN"},"quantity":{"type":"integer","description":"The number or quantity of the order item. \n","format":"int32","example":1},"channel":{"type":"string","description":"The channel used in the order. \n","example":"WEB"},"order":{"$ref":"#/components/schemas/OrderLinkFirst"}}}},"components/schemas/OrderItemRequest":{"id":"components/schemas/OrderItemRequest","kind":"json-schema","title":"OrderItemRequest","data":{"required":["currencyCode","name","price","status","type"],"type":"object","properties":{"name":{"type":"string","description":"The name of the order item. Free text value. Maximum character limit: 128 \n","example":"Mobile AZ10"},"description":{"type":"string","description":"The description of the order item. \n","example":"Mobile AZ10 description"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of order item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must not be set to any of the following: \"FLIGHT\", \"HOTEL\", \"MORTGAGE\", \"MORTGAGE_APPLICATION\", \"LOAN_APPLICATION\", \"PERSONAL_LOAN\", \"RAIL\""},"children":[]}]}]}],"example":"MOBILE"},"productId":{"type":"string","description":"The ID of the product.\n","example":"1233-44"},"price":{"type":"number","description":"The organization's price for the order item.\n","example":105},"currencyCode":{"type":"string","description":"The organization's currency code for the order item. \n","example":"EUR"},"originalPrice":{"type":"number","description":"The unit price of the order item before conversion to the organization's currency.\n","example":110},"originalCurrencyCode":{"type":"string","description":"The original currency code for the order item. \n","example":"USD"},"referenceId":{"type":"string","description":"An ID generated by the client to reference the order item.\n","example":"AAAAA-134"},"vendor":{"type":"string","description":"The organization that is selling the order item.\n","example":"Vendor XYZ"},"status":{"type":"string","description":"The status of the order item.\n","example":"CONFIRMED"},"language":{"type":"string","description":"The language used when making the order.\n","example":"EN"},"quantity":{"type":"integer","description":"The number or quantity of the order item. \n","format":"int32","example":1},"channel":{"type":"string","description":"The channel used in the order. \n","example":"WEB"}}}},"components/schemas/OrderConsumerItem":{"id":"components/schemas/OrderConsumerItem","kind":"json-schema","title":"OrderConsumerItem","data":{"type":"object","description":"An individual contact item such as email, phone number, etc.","example":[]}},"components/schemas/OrderConsumerResponse":{"id":"components/schemas/OrderConsumerResponse","kind":"json-schema","title":"OrderConsumerResponse","data":{"type":"object","properties":{"items":{"type":"array","description":"List of consumers.","example":[],"items":{"$ref":"#/components/schemas/OrderConsumerItem"}}},"description":"Consumer details, containing a list of items."}},"components/schemas/OrderContactResponse":{"id":"components/schemas/OrderContactResponse","kind":"json-schema","title":"OrderContactResponse","data":{"type":"object","properties":{"items":{"type":"array","description":"List of order contacts.","example":[],"items":{"$ref":"#/components/schemas/GuestLink"}}},"description":"Contact details, containing a list of items."}},"components/schemas/OrderCreateResponse":{"id":"components/schemas/OrderCreateResponse","kind":"json-schema","title":"OrderCreateResponse","data":{"type":"object","properties":{"ref":{"type":"string","description":"The order reference. This is a unique identifier of the order record. Use the order reference to interact with a specific order, for example, to retrieve it, update it, or create a data extension for it.\n","format":"UUID","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"href":{"type":"string","description":"The link to the order.\n","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was updated in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"orderedAt":{"type":"string","description":"The date and time when the order was made.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"currencyCode":{"type":"string","description":"The currency the guest used to complete a purchase.\n","format":"3 letter ISO 4217","example":"EUR"},"price":{"type":"number","description":"The amount paid for the order.\n","format":"number (currency)","example":50},"referenceId":{"type":"string","description":"A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.\n","format":"string","example":"B94TXY-1"},"paymentType":{"type":"string","description":"The method of payment for the order.\n","format":"string (title case recommended)","example":"Card"},"cardType":{"type":"string","description":"The card type used to pay for the order.\n","format":"string (title case recommended)","example":"Visa"},"pointOfSale":{"type":"string","description":"The point of sale used in the order.\n","format":"string (predefined by the client)","example":"home"},"channel":{"type":"string","description":"The channel used in the order.\n","example":"WEB","enum":["WEB","MOBILE_WEB","MOBILE_APP","CALL_CENTER","AIRPORT_KIOSK","BRANCH","KIOSK","OFFLINE","GDS","OTA","OTHER"]},"status":{"type":"string","description":"The status of the order.\n","example":"PURCHASED","enum":["BROWSED","CANCELLED","CONFIRMED","DECLINED","PARTIALY_CONFIRMED","PARTIALY_REFUNDED","PAYMENT_PENDING","PENDING","PURCHASED","REFUNDED","RESERVED","SEARCHED","UNKNOWN"]},"contacts":{"$ref":"#/components/schemas/OrderContactResponse"},"consumers":{"$ref":"#/components/schemas/OrderConsumerResponse"},"orderItems":{"$ref":"#/components/schemas/OrderItemResponse"}}}},"components/schemas/OrderItem":{"id":"components/schemas/OrderItem","kind":"json-schema","title":"OrderItem","data":{"type":"object","description":"An order item.","example":[]}},"components/schemas/OrderItemResponse":{"id":"components/schemas/OrderItemResponse","kind":"json-schema","title":"OrderItemResponse","data":{"type":"object","properties":{"items":{"type":"array","description":"List of order items.","example":[],"items":{"$ref":"#/components/schemas/OrderItem"}}},"description":"Order item details, containing a list of items."}},"components/schemas/OrderBadRequestResponse":{"id":"components/schemas/OrderBadRequestResponse","kind":"json-schema","title":"OrderBadRequestResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":400},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":400},"message":{"type":"string","description":"Error description.","example":"orderedAt: may not be null."},"developerMessage":{"type":"string","description":"Error description for developers.","example":"orderedAt: may not be null."},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/OrderAlreadyExistsResponse":{"id":"components/schemas/OrderAlreadyExistsResponse","kind":"json-schema","title":"OrderAlreadyExistsResponse","data":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP request status.","format":"int32","example":409},"code":{"type":"integer","description":"The HTTP response status code.","format":"int32","example":409},"message":{"type":"string","description":"The resource already exists so it can't be created."},"developerMessage":{"type":"string","description":"Error description for developers.","example":"Order with ref AAA-9999 and orderedAt Wed Jun 23 17:49:07 CEST 2004 for client key ... already exist"},"moreInfoUrl":{"type":"string","description":"URL to get more information about the error.","example":"https://support.sitecore.com"}}}},"components/schemas/OrderCreateRequest":{"id":"components/schemas/OrderCreateRequest","kind":"json-schema","title":"OrderCreateRequest","data":{"required":["currencyCode","orderedAt","price","referenceId"],"type":"object","properties":{"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was updated in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"orderedAt":{"type":"string","description":"The date and time when the order was made.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"currencyCode":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The currency the guest used to complete a purchase. Set this to the organization’s default currency."},"children":[]}]}]}],"format":"3 letter ISO 4217","example":"EUR"},"price":{"type":"number","description":"The amount paid for the order.\n","format":"number (currency)","example":50},"referenceId":{"type":"string","description":"A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR.\n","format":"string","example":"B94TXY-1"},"paymentType":{"type":"string","description":"The method of payment for the order.\n","format":"string (title case recommended)","example":"Card"},"cardType":{"type":"string","description":"The card type used to pay for the order.\n","format":"string (title case recommended)","example":"Visa"},"pointOfSale":{"type":"string","description":"The point of sale used in the order.\n","format":"string (predefined by the client)","example":"home"},"channel":{"type":"string","description":"The channel used in the order.\n","example":"WEB","enum":["WEB","MOBILE_WEB","MOBILE_APP","CALL_CENTER","AIRPORT_KIOSK","BRANCH","KIOSK","OFFLINE","GDS","OTA","OTHER"]},"status":{"type":"string","description":"The status of the order.\n","example":"PURCHASED","enum":["BROWSED","CANCELLED","CONFIRMED","DECLINED","PARTIALY_CONFIRMED","PARTIALY_REFUNDED","PAYMENT_PENDING","PENDING","PURCHASED","REFUNDED","RESERVED","SEARCHED","UNKNOWN"]}}}},"components/schemas/OrderConsumerLinkFirst":{"id":"components/schemas/OrderConsumerLinkFirst","kind":"json-schema","title":"OrderConsumerLinkFirst","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/consumers?offset=1&limit=10"}},"description":"The request's first list of order consumers URL."}},"components/schemas/OrderConsumerLinkLast":{"id":"components/schemas/OrderConsumerLinkLast","kind":"json-schema","title":"OrderConsumerLinkLast","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/consumers?offset=1&limit=10"}},"description":"The request's last list of order consumers URL."}},"components/schemas/OrderConsumerNext":{"id":"components/schemas/OrderConsumerNext","kind":"json-schema","title":"OrderConsumerNext","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/111d106a-feff-42b2-90fb-a6ed136ec333/consumers?offset=1&limit=10"}},"description":"The request's next list of order consumers URL."}},"components/schemas/RetrieveOrderConsumersResponse":{"id":"components/schemas/RetrieveOrderConsumersResponse","kind":"json-schema","title":"RetrieveOrderConsumersResponse","data":{"type":"object","properties":{"offset":{"type":"integer","description":"The request's offset.","format":"int32","example":0},"limit":{"type":"integer","description":"The request's limit.","format":"int32","example":10},"first":{"$ref":"#/components/schemas/OrderConsumerLinkFirst"},"last":{"$ref":"#/components/schemas/OrderConsumerLinkLast"},"next":{"$ref":"#/components/schemas/OrderConsumerNext"},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/consumers?offset=0&limit=10"},"items":{"type":"array","description":"The order consumer's items.","format":"List","items":{"$ref":"#/components/schemas/items"}}}}},"components/schemas/OrderContactHref":{"id":"components/schemas/OrderContactHref","kind":"json-schema","title":"OrderContactHref","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/contacts/111d106a-feff-42b2-90fb-a6ed136ec333"}},"description":"The order contacts's items."}},"components/schemas/OrderContactLinkFirst":{"id":"components/schemas/OrderContactLinkFirst","kind":"json-schema","title":"OrderContactLinkFirst","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts?offset=1&limit=10"}},"description":"The request's first list of order contacts URL."}},"components/schemas/OrderContactLinkLast":{"id":"components/schemas/OrderContactLinkLast","kind":"json-schema","title":"OrderContactLinkLast","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts?offset=1&limit=10"}},"description":"The request's last list of order contacts URL."}},"components/schemas/OrderContactNext":{"id":"components/schemas/OrderContactNext","kind":"json-schema","title":"OrderContactNext","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/2d7de9df-45a2-45ea-872c-30e45139007d/contacts?offset=1&limit=10"}},"description":"The request's next list of order contacts URL."}},"components/schemas/RetrieveOrderContactsResponse":{"id":"components/schemas/RetrieveOrderContactsResponse","kind":"json-schema","title":"RetrieveOrderContactsResponse","data":{"type":"object","properties":{"offset":{"type":"integer","description":"The request's offset.","format":"int32","example":0},"limit":{"type":"integer","description":"The request's limit.","format":"int32","example":10},"first":{"$ref":"#/components/schemas/OrderContactLinkFirst"},"last":{"$ref":"#/components/schemas/OrderContactLinkLast"},"next":{"$ref":"#/components/schemas/OrderContactNext"},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders/cadd106a-feff-42b2-90fb-a6ed136ece51/contacts?offset=0&limit=10"},"items":{"type":"array","description":"The order contacts's items.","format":"List","items":{"$ref":"#/components/schemas/OrderContactHref"}}}}},"components/schemas/expand":{"id":"components/schemas/expand","kind":"json-schema","title":"expand","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can expand items in a collection by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This eliminates the need to send multiple follow-up requests (one for the collection and another for each of its items). This also helps you check if the data you intend to create already exists."},"children":[]}]}]}],"example":true}},"components/schemas/OrderLinkLast":{"id":"components/schemas/OrderLinkLast","kind":"json-schema","title":"OrderLinkLast","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"}},"description":"The request's last list of orders URL."}},"components/schemas/OrdersNext":{"id":"components/schemas/OrdersNext","kind":"json-schema","title":"OrdersNext","data":{"type":"object","properties":{"href":{"type":"string","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=2d7de9df-45a2-45ea-872c-30e45139007d&offset=1&limit=10"}},"description":"The request's next list of orders URL."}},"components/schemas/RetrieveOrdersResponse":{"id":"components/schemas/RetrieveOrdersResponse","kind":"json-schema","title":"RetrieveOrdersResponse","data":{"type":"object","properties":{"offset":{"type":"integer","description":"The request's offset.","format":"int32","example":0},"limit":{"type":"integer","description":"The request's limit.","format":"int32","example":10},"first":{"$ref":"#/components/schemas/OrderLinkFirst"},"last":{"$ref":"#/components/schemas/OrderLinkLast"},"next":{"$ref":"#/components/schemas/OrdersNext"},"href":{"type":"string","description":"The request's URL.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orders?guestRef=cadd106a-feff-42b2-90fb-a6ed136ece51/contacts?offset=0&limit=10"},"items":{"type":"array","format":"List","items":{"$ref":"#/components/schemas/OrderHref"}}}}},"components/schemas/Arrears":{"id":"components/schemas/Arrears","kind":"json-schema","title":"Arrears","data":{"type":"object","properties":{"daysPastDue":{"type":"integer","format":"int32"},"daysPastDueDate":{"type":"string","format":"date-time"},"daysInArrears":{"type":"integer","format":"int32"},"daysInArrearsDate":{"type":"string","format":"date-time"},"baselIIDaysPastDue":{"type":"integer","format":"int32"},"baselIIDaysPastDueDate":{"type":"string","format":"date-time"}}}},"components/schemas/CollectionResourceDataExtension":{"id":"components/schemas/CollectionResourceDataExtension","kind":"json-schema","title":"CollectionResourceDataExtension","data":{"type":"object","properties":{"href":{"type":"string"},"offset":{"type":"object"},"nextOffset":{"type":"object"},"limit":{"type":"integer","format":"int32"},"first":{"$ref":"#/components/schemas/Link"},"prev":{"$ref":"#/components/schemas/Link"},"next":{"$ref":"#/components/schemas/Link"},"last":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/DataExtension"}}}}},"components/schemas/CollectionResourceEntity":{"id":"components/schemas/CollectionResourceEntity","kind":"json-schema","title":"CollectionResourceEntity","data":{"type":"object","properties":{"href":{"type":"string"},"offset":{"type":"object"},"nextOffset":{"type":"object"},"limit":{"type":"integer","format":"int32"},"first":{"$ref":"#/components/schemas/Link"},"prev":{"$ref":"#/components/schemas/Link"},"next":{"$ref":"#/components/schemas/Link"},"last":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Entity"}}}}},"components/schemas/CollectionResourceOrderConsumer":{"id":"components/schemas/CollectionResourceOrderConsumer","kind":"json-schema","title":"CollectionResourceOrderConsumer","data":{"type":"object","properties":{"href":{"type":"string"},"offset":{"type":"object"},"nextOffset":{"type":"object"},"limit":{"type":"integer","format":"int32"},"first":{"$ref":"#/components/schemas/Link"},"prev":{"$ref":"#/components/schemas/Link"},"next":{"$ref":"#/components/schemas/Link"},"last":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderConsumer"}}}}},"components/schemas/CollectionResourceOrderContact":{"id":"components/schemas/CollectionResourceOrderContact","kind":"json-schema","title":"CollectionResourceOrderContact","data":{"type":"object","properties":{"href":{"type":"string"},"offset":{"type":"object"},"nextOffset":{"type":"object"},"limit":{"type":"integer","format":"int32"},"first":{"$ref":"#/components/schemas/Link"},"prev":{"$ref":"#/components/schemas/Link"},"next":{"$ref":"#/components/schemas/Link"},"last":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderContact"}}}}},"components/schemas/CollectionResourceOrderItem":{"id":"components/schemas/CollectionResourceOrderItem","kind":"json-schema","title":"CollectionResourceOrderItem","data":{"type":"object","properties":{"href":{"type":"string"},"offset":{"type":"object"},"nextOffset":{"type":"object"},"limit":{"type":"integer","format":"int32"},"first":{"$ref":"#/components/schemas/Link"},"prev":{"$ref":"#/components/schemas/Link"},"next":{"$ref":"#/components/schemas/Link"},"last":{"$ref":"#/components/schemas/Link"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}}}}},"components/schemas/DataExtension":{"id":"components/schemas/DataExtension","kind":"json-schema","title":"DataExtension","data":{"required":["key","name"],"type":"object","properties":{"href":{"type":"string"},"ref":{"type":"string"},"key":{"maxLength":50,"minLength":0,"pattern":"^(?![bB][xX])((?![bB][oO][xX][eE][vV][eE][rR])[a-zA-Z-0-9])*$","type":"string","description":"Optional. Default and only allowed value: \"default\"","example":"default"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was last updated in Sitecore CDP.","format":"date-time","example":"2024-01-01T16:17:16Z"},"values":{"type":"object","additionalProperties":{"type":"object"},"writeOnly":true}},"description":"The data extension object."}},"components/schemas/Entity":{"id":"components/schemas/Entity","kind":"json-schema","title":"Entity","data":{"type":"object","properties":{"href":{"type":"string"},"ref":{"type":"string"}}}},"components/schemas/FlightOrderItem":{"id":"components/schemas/FlightOrderItem","kind":"json-schema","title":"FlightOrderItem","data":{"required":["currencyCode","price","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"flightSegments":{"type":"array","items":{"$ref":"#/components/schemas/FlightSegment"}},"tripType":{"type":"string"},"passengerTypeCode":{"type":"string"},"consumerTypeCode":{"type":"string"}}}]}},"components/schemas/FlightSegment":{"id":"components/schemas/FlightSegment","kind":"json-schema","title":"FlightSegment","data":{"required":["arrivalDateTime","carrier","departureDateTime","destination","origin"],"type":"object","properties":{"id":{"type":"string"},"origin":{"type":"string"},"destination":{"type":"string"},"departureDateTime":{"type":"string"},"arrivalDateTime":{"type":"string"},"flightNumber":{"type":"string"},"fareClass":{"type":"string"},"fareFamily":{"type":"string"},"carrier":{"type":"string"},"originDestination":{"type":"string"},"bookingClass":{"type":"string"},"operatingCarrier":{"type":"string"},"operatingCarrierFlightNumber":{"type":"string"},"equipmentType":{"pattern":"^[^\\s].*$","type":"string"}}}},"components/schemas/HotelOrderItem":{"id":"components/schemas/HotelOrderItem","kind":"json-schema","title":"HotelOrderItem","data":{"required":["adults","checkInDateTime","checkOutDateTime","children","currencyCode","infants","numberOfNights","price","roomRate","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"roomRate":{"minimum":0,"type":"number"},"roomType":{"type":"string"},"roomRateCode":{"type":"string"},"checkInDateTime":{"type":"string","format":"date-time"},"checkOutDateTime":{"type":"string","format":"date-time"},"numberOfNights":{"minimum":0,"type":"integer","format":"int32"},"adults":{"minimum":0,"type":"integer","format":"int32"},"children":{"minimum":0,"type":"integer","format":"int32"},"infants":{"minimum":0,"type":"integer","format":"int32"},"starRating":{"maximum":10,"minimum":0,"type":"integer","format":"int32"},"cityCode":{"type":"string"},"cityName":{"type":"string"}}}]}},"components/schemas/LoanApplicationOrderItem":{"id":"components/schemas/LoanApplicationOrderItem","kind":"json-schema","title":"LoanApplicationOrderItem","data":{"required":["currencyCode","price","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"applicationStatus":{"type":"string"},"applicationStatusDate":{"type":"string","format":"date-time"},"drawdownStatus":{"type":"string"},"drawdownStatusDate":{"type":"string","format":"date-time"},"openStatus":{"type":"string"},"openDate":{"type":"string","format":"date-time"},"applicationID":{"type":"string"},"applicationPreferredFulfilmentChannel":{"type":"string"},"applicationOriginatorChannel":{"type":"string"},"applicationReferralChannel":{"type":"string"},"inArrears":{"type":"boolean"},"arrears":{"$ref":"#/components/schemas/Arrears"},"balance":{"type":"number"},"contractMaturityDate":{"type":"string","format":"date-time"},"feePeriod":{"type":"string"},"interestRate":{"type":"number"},"interestRateType":{"type":"string"},"lastFeeCharge":{"type":"number"},"loanAmount":{"type":"number"},"mainAccount":{"type":"boolean"},"nextRepaymentDate":{"type":"string","format":"date-time"},"nickName":{"type":"string"},"partyStatus":{"type":"string"},"primaryApplicantOrHolder":{"type":"string"},"category":{"type":"string"},"productParty":{"type":"array","items":{"type":"string"}},"purpose":{"type":"string"},"remainingBalance":{"type":"number"},"repaymentFrequency":{"type":"string"},"termMonths":{"type":"integer","format":"int32"},"topUpInd":{"type":"boolean"},"firstTimeBuyer":{"type":"boolean"},"smeInDifficultyInd":{"type":"boolean"},"valueTransPermittedInd":{"type":"boolean"},"productReportingCode":{"type":"string"},"signatureAuthorisationCode":{"type":"string"},"activeStandingOrder":{"type":"boolean"},"stageBusinessArea":{"type":"string"},"LTV":{"type":"number"}}}]}},"components/schemas/MortgageApplicationOrderItem":{"id":"components/schemas/MortgageApplicationOrderItem","kind":"json-schema","title":"MortgageApplicationOrderItem","data":{"required":["currencyCode","price","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"applicationStatus":{"type":"string"},"applicationStatusDate":{"type":"string","format":"date-time"},"drawdownStatus":{"type":"string"},"drawdownStatusDate":{"type":"string","format":"date-time"},"openStatus":{"type":"string"},"openDate":{"type":"string","format":"date-time"},"applicationID":{"type":"string"},"applicationPreferredFulfilmentChannel":{"type":"string"},"applicationOriginatorChannel":{"type":"string"},"applicationReferralChannel":{"type":"string"},"inArrears":{"type":"boolean"},"arrears":{"$ref":"#/components/schemas/Arrears"},"balance":{"type":"number"},"contractMaturityDate":{"type":"string","format":"date-time"},"feePeriod":{"type":"string"},"interestRate":{"type":"number"},"interestRateType":{"type":"string"},"lastFeeCharge":{"type":"number"},"loanAmount":{"type":"number"},"mainAccount":{"type":"boolean"},"nextRepaymentDate":{"type":"string","format":"date-time"},"nickName":{"type":"string"},"partyStatus":{"type":"string"},"primaryApplicantOrHolder":{"type":"string"},"category":{"type":"string"},"productParty":{"type":"array","items":{"type":"string"}},"purpose":{"type":"string"},"remainingBalance":{"type":"number"},"repaymentFrequency":{"type":"string"},"termMonths":{"type":"integer","format":"int32"},"topUpInd":{"type":"boolean"},"firstTimeBuyer":{"type":"boolean"},"smeInDifficultyInd":{"type":"boolean"},"valueTransPermittedInd":{"type":"boolean"},"productReportingCode":{"type":"string"},"signatureAuthorisationCode":{"type":"string"},"activeStandingOrder":{"type":"boolean"},"stageBusinessArea":{"type":"string"},"LTV":{"type":"number"}}}]}},"components/schemas/MortgageOrderItem":{"id":"components/schemas/MortgageOrderItem","kind":"json-schema","title":"MortgageOrderItem","data":{"required":["currencyCode","price","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"applicationStatus":{"type":"string"},"applicationStatusDate":{"type":"string","format":"date-time"},"drawdownStatus":{"type":"string"},"drawdownStatusDate":{"type":"string","format":"date-time"},"openStatus":{"type":"string"},"openDate":{"type":"string","format":"date-time"},"applicationID":{"type":"string"},"applicationPreferredFulfilmentChannel":{"type":"string"},"applicationOriginatorChannel":{"type":"string"},"applicationReferralChannel":{"type":"string"},"inArrears":{"type":"boolean"},"arrears":{"$ref":"#/components/schemas/Arrears"},"balance":{"type":"number"},"contractMaturityDate":{"type":"string","format":"date-time"},"feePeriod":{"type":"string"},"interestRate":{"type":"number"},"interestRateType":{"type":"string"},"lastFeeCharge":{"type":"number"},"loanAmount":{"type":"number"},"mainAccount":{"type":"boolean"},"nextRepaymentDate":{"type":"string","format":"date-time"},"nickName":{"type":"string"},"partyStatus":{"type":"string"},"primaryApplicantOrHolder":{"type":"string"},"category":{"type":"string"},"productParty":{"type":"array","items":{"type":"string"}},"purpose":{"type":"string"},"remainingBalance":{"type":"number"},"repaymentFrequency":{"type":"string"},"termMonths":{"type":"integer","format":"int32"},"topUpInd":{"type":"boolean"},"firstTimeBuyer":{"type":"boolean"},"smeInDifficultyInd":{"type":"boolean"},"valueTransPermittedInd":{"type":"boolean"},"productReportingCode":{"type":"string"},"signatureAuthorisationCode":{"type":"string"},"activeStandingOrder":{"type":"boolean"},"stageBusinessArea":{"type":"string"},"LTV":{"type":"number"}}}]}},"components/schemas/Order":{"id":"components/schemas/Order","kind":"json-schema","title":"Order","data":{"required":["currencyCode","orderedAt","price"],"type":"object","properties":{"href":{"type":"string"},"ref":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"modifiedAt":{"type":"string","format":"date-time"},"orderedAt":{"type":"string","format":"date-time"},"currencyCode":{"type":"string"},"price":{"minimum":0,"type":"number"},"referenceId":{"type":"string"},"paymentType":{"type":"string"},"cardType":{"type":"string"},"orderType":{"type":"string"},"pointOfSale":{"type":"string"},"channel":{"type":"string"},"status":{"type":"string","enum":["BROWSED","CANCELLED","CONFIRMED","DECLINED","PARTIALY_CONFIRMED","PARTIALY_REFUNDED","PAYMENT_PENDING","PENDING","PURCHASED","REFUNDED","RESERVED","SEARCHED","UNKNOWN"]},"contacts":{"$ref":"#/components/schemas/CollectionResourceOrderContact"},"consumers":{"$ref":"#/components/schemas/CollectionResourceOrderConsumer"},"orderItems":{"$ref":"#/components/schemas/CollectionResourceOrderItem"},"dataExtensions":{"$ref":"#/components/schemas/CollectionResourceDataExtension"},"items":{"$ref":"#/components/schemas/CollectionResourceOrderItem"}}}},"components/schemas/OrderConsumer":{"id":"components/schemas/OrderConsumer","kind":"json-schema","title":"OrderConsumer","data":{"type":"object","properties":{"href":{"type":"string","description":"The link to the order contact.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderContacts/3b5cb55e-c616-424a-991c-a241d0024896"},"ref":{"type":"string","description":"The order contact reference.","example":"3b5cb55e-c616-424a-991c-a241d0024896"},"order":{"$ref":"#/components/schemas/order"},"title":{"type":"string","description":"The title of the person.\n\n Example values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","format":"title case","example":"Mr"},"firstName":{"type":"string","description":"The person's first name.","format":"title case","example":"John"},"lastName":{"type":"string","description":"The person's last name.","format":"title case recommended","example":"Doe"},"gender":{"type":"string","description":"The person's gender.\n\nExample values:\"male\", \"female\", \"unknown\"\n","format":"lowercase","example":"male"},"dateOfBirth":{"type":"string","description":"The person's date of birth. Validation: Date must be in the past.\n","format":"date-time","example":"1991-01-01T16:17:16Z"},"emails":{"maxItems":1,"minItems":0,"type":"array","description":"All the email addresses of the person.\n","example":["john.doe@gmail.com"],"items":{"type":"string","description":"All the email addresses of the person.\n","example":"[\"john.doe@gmail.com\"]"}},"phoneNumbers":{"type":"array","description":"The phone numbers of the person.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numbers of the person.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"nationality":{"type":"string","description":"The person's nationality.\n\n Example values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","format":"title case","example":"Irish"},"passportNumber":{"type":"string","description":"The passport number of the guest.\n","format":"uppercase","example":"PZ4A9565"},"guest":{"$ref":"#/components/schemas/guest"},"country":{"type":"string","description":"The guest's country.\n\n Example values: \"IE\", \"GB\", \"ES\", \"FR\"","format":"2-letter ISO 3166-1 Alpha-2 country code","example":"IE"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"passportExpiry":{"type":"string","format":"date-time"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was updated in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"orderItems":{"$ref":"#/components/schemas/CollectionResourceEntity"},"consumerTypeCode":{"type":"string","description":"The consumer type.\n","format":"String","example":"traveller"}}}},"components/schemas/OrderContact":{"id":"components/schemas/OrderContact","kind":"json-schema","title":"OrderContact","data":{"type":"object","properties":{"href":{"type":"string","description":"The link to the order contact.","example":"https://api-engage-eu.sitecorecloud.io/v2.1/orderContacts/3b5cb55e-c616-424a-991c-a241d0024896"},"ref":{"type":"string","description":"The order contact reference.","example":"3b5cb55e-c616-424a-991c-a241d0024896"},"order":{"$ref":"#/components/schemas/order"},"title":{"type":"string","description":"The title of the person.\n\n Example values: \"Br\", \"Brigadier\", \"Capt\", \"Colonel\", \"Dame\", \"Dr\", \"Elder\", \"Fr\", \"General\", \"Hon\", \"Judge\", \"Lord\", \"Master\", \"Miss\", \"Mr\", \"Mrs\", \"Ms\", \"Mstr\", \"Prof\", \"Rabbi\", \"Rev\", \"Shaikha\", \"Sheikh\", \"Sir\", \"Sister\", \"Sr\"\n","format":"title case","example":"Mr"},"firstName":{"type":"string","description":"The person's first name.","format":"title case","example":"John"},"lastName":{"type":"string","description":"The person's last name.","format":"title case recommended","example":"Doe"},"gender":{"type":"string","description":"The person's gender.\n\nExample values:\"male\", \"female\", \"unknown\"\n","format":"lowercase","example":"male"},"dateOfBirth":{"type":"string","description":"The person's date of birth. Validation: Date must be in the past.\n","format":"date-time","example":"1991-01-01T16:17:16Z"},"emails":{"maxItems":1,"minItems":0,"type":"array","description":"All the email addresses of the person.\n","example":["john.doe@gmail.com"],"items":{"type":"string","description":"All the email addresses of the person.\n","example":"[\"john.doe@gmail.com\"]"}},"phoneNumbers":{"type":"array","description":"The phone numbers of the person.\n","example":["+353161123345","+353161123346"],"items":{"type":"string","description":"The phone numbers of the person.\n","example":"[\"+353161123345\",\"+353161123346\"]"}},"nationality":{"type":"string","description":"The person's nationality.\n\n Example values: \"Irish\", \"British\", \"Spanish\", \"French\"\n","format":"title case","example":"Irish"},"passportNumber":{"type":"string","description":"The passport number of the guest.\n","format":"uppercase","example":"PZ4A9565"},"guest":{"$ref":"#/components/schemas/guest"},"country":{"type":"string","description":"The guest's country.\n\n Example values: \"IE\", \"GB\", \"ES\", \"FR\"","format":"2-letter ISO 3166-1 Alpha-2 country code","example":"IE"},"identifiers":{"type":"array","items":{"$ref":"#/components/schemas/Identifier"}},"passportExpiry":{"type":"string","format":"date-time"},"createdAt":{"type":"string","description":"The date and time when the resource was created in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"modifiedAt":{"type":"string","description":"The date and time when the resource was updated in Sitecore CDP.\n","format":"date-time","example":"2024-01-01T16:17:16Z"},"street":{"type":"array","description":"The order contact's street address.","example":["Tara St.","Main Ave."],"items":{"type":"string"}},"city":{"type":"string","description":"The order contact's city.","format":"String","example":"Dublin"},"state":{"type":"string","description":"The order contact's post code.","format":"String","example":"10001"}}}},"components/schemas/PersonalLoanOrderItem":{"id":"components/schemas/PersonalLoanOrderItem","kind":"json-schema","title":"PersonalLoanOrderItem","data":{"required":["currencyCode","price","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"applicationStatus":{"type":"string"},"applicationStatusDate":{"type":"string","format":"date-time"},"drawdownStatus":{"type":"string"},"drawdownStatusDate":{"type":"string","format":"date-time"},"openStatus":{"type":"string"},"openDate":{"type":"string","format":"date-time"},"applicationID":{"type":"string"},"applicationPreferredFulfilmentChannel":{"type":"string"},"applicationOriginatorChannel":{"type":"string"},"applicationReferralChannel":{"type":"string"},"inArrears":{"type":"boolean"},"arrears":{"$ref":"#/components/schemas/Arrears"},"balance":{"type":"number"},"contractMaturityDate":{"type":"string","format":"date-time"},"feePeriod":{"type":"string"},"interestRate":{"type":"number"},"interestRateType":{"type":"string"},"lastFeeCharge":{"type":"number"},"loanAmount":{"type":"number"},"mainAccount":{"type":"boolean"},"nextRepaymentDate":{"type":"string","format":"date-time"},"nickName":{"type":"string"},"partyStatus":{"type":"string"},"primaryApplicantOrHolder":{"type":"string"},"category":{"type":"string"},"productParty":{"type":"array","items":{"type":"string"}},"purpose":{"type":"string"},"remainingBalance":{"type":"number"},"repaymentFrequency":{"type":"string"},"termMonths":{"type":"integer","format":"int32"},"topUpInd":{"type":"boolean"},"firstTimeBuyer":{"type":"boolean"},"smeInDifficultyInd":{"type":"boolean"},"valueTransPermittedInd":{"type":"boolean"},"productReportingCode":{"type":"string"},"signatureAuthorisationCode":{"type":"string"},"activeStandingOrder":{"type":"boolean"},"stageBusinessArea":{"type":"string"},"LTV":{"type":"number"}}}]}},"components/schemas/RailOrderItem":{"id":"components/schemas/RailOrderItem","kind":"json-schema","title":"RailOrderItem","data":{"required":["currencyCode","price","status","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItem"},{"type":"object","properties":{"journeyType":{"type":"string"},"segments":{"type":"array","items":{"$ref":"#/components/schemas/TripSegment"}}}}]}},"components/schemas/TripSegment":{"id":"components/schemas/TripSegment","kind":"json-schema","title":"TripSegment","data":{"required":["arrivalDateTime","departureDateTime"],"type":"object","properties":{"origin":{"type":"string"},"destination":{"type":"string"},"originName":{"type":"string"},"destinationName":{"type":"string"},"originDestination":{"type":"string"},"departureDateTime":{"type":"string"},"arrivalDateTime":{"type":"string"},"carrier":{"type":"string"},"carrierName":{"type":"string"},"carrierNumber":{"type":"string"},"fareClass":{"type":"string"},"fareFamily":{"type":"string"},"equipmentType":{"pattern":"^[^\\s].*$","type":"string"}}}},"schema_849":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A unique identifier generated by your organization to reference the order. For flight orders, this is often the PNR. Specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guestRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the query parameters, not both."},"children":[]}]}]}],"example":"B94TXY-1"},"id":"schema_849"},"schema_850":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The guest reference. This is a unique identifier of the guest record. If you don't know the guest reference, first retrieve guests using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://api-docs.sitecore.com/cdp/guest-rest-api"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sitecore CDP Guest REST API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"referenceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guestRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the query parameters, not both."},"children":[]}]}]}]},"id":"schema_850"},"schema_851":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Offset"},"id":"schema_851"},"schema_852":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Limit"},"id":"schema_852"},"schema_853":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can sort search results by the date and time when the order was created ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or made ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). You can only use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderedAt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if you list orders using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"guestRef"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"id":"schema_853"},"schema_854":{"kind":"json-schema","data":{"type":"string","description":"The order reference. This is a unique identifier of the order record. Automatically generated when you created the order. If you don't know the order reference, first list orders.\n","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"id":"schema_854"},"schema_855":{"kind":"json-schema","data":{"type":"string","description":"The order item reference. This is a unique identifier of the order item. Automatically generated when you created the order item. If you don't know the order item reference, first list order items.\n","format":"UUID","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"id":"schema_855"},"schema_856":{"kind":"json-schema","data":{"$ref":"#/components/schemas/expand"},"id":"schema_856"},"schema_857":{"kind":"json-schema","data":{"type":"string","description":"The order contact reference. This is a unique identifier of the order contact. Automatically generated when you created the order contact. If you don't know the order contact reference, first list order contacts.\n","example":"3b5cb55e-c616-424a-991c-a241d0024896"},"id":"schema_857"},"schema_858":{"kind":"json-schema","data":{"$ref":"#/components/schemas/Expand"},"id":"schema_858"},"schema_859":{"kind":"json-schema","data":{"type":"string","description":"The order consumer reference. This is a unique identifier of the order consumer. Automatically generated when you created the order consumer. If you don't know the order consumer reference, first list order consumers.\n","example":"2d7de9df-45a2-45ea-872c-30e45139007d"},"id":"schema_859"},"schema_860":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The data extension name. You must set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ext"},"id":"schema_860"},"schema_861":{"kind":"json-schema","data":{"type":"string","description":"The order reference. This is a unique identifier of the order record. If you don't know the order reference, first retrieve orders.","example":"f7aabbca-1c1b-4fc2-be72-3e16294a4f03"},"id":"schema_861"},"schema_862":{"kind":"json-schema","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The name of the data extension. Set this to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"ext"},"id":"schema_862"}},"exampleStore":{},"securitySchemeStore":{"BasicAuth":{"id":"BasicAuth","type":"http","scheme":"basic"},"BearerToken":{"id":"BearerToken","type":"http","scheme":"bearer","bearerFormat":"JWT"}},"servers":[{"url":"https://api-engage-ap.sitecorecloud.io","description":"Production server AP"},{"url":"https://api-engage-eu.sitecorecloud.io","description":"Production server EU"},{"url":"https://api-engage-jpe.sitecorecloud.io","description":"Production server JP"},{"url":"https://api-engage-us.sitecorecloud.io","description":"Production server US"}],"specType":"openapi"},"options":{"hideInfoMetadata":true,"sanitize":true,"sortRequiredPropsFirst":true,"corsProxyUrl":"https://cors.redoc.ly","mockServer":{"off":true,"position":"off"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/cdp/order-rest-api/index.json?download"},{"url":"/_bundle/cdp/order-rest-api/index.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Order API","description":"Use the Order REST API to create, retrieve, update, and delete order data in Sitecore CDP.\n\nThis REST API lets you interact with the following objects:\n   - Order - the parent for all other objects, containing attributes common to the entire order.\n   - Order item - something that has been purchased as part of the order. \n   - Order contact - the primary contact person for an order. \n   - Order consumer - the person that consumes the order item. \n   - Order data extension - any key-value pairs you want to add to the order object. \n   - Order item data extension - any key-value pairs you want to add to the order item object. \n\nNote the following:\n   - To use this REST API, you must authenticate your API requests.\n   - All API requests are made in your production environment.\n   - This reference documentation describes Sitecore CDP functionality for data model 2.1.\n\n For more information, see the [official Sitecore CDP developer documentation](https://doc.sitecore.com/cdp/en/developers/api/index-en.html), including [examples](https://doc.sitecore.com/cdp/en/developers/api/examples-of-order-items-rest-api-v2-1.html) of order items and order item data extensions.\n## Authentication\nThe Order REST API uses basic authentication.\nBasic authentication involves sending a user name and a password with every request.\nTo find your user name and password, in Sitecore CDP, on the navigation pane, click **Settings** > **API access**:\n   - The user name is the **Client key**.\n   - The password is the **API token**.\n\nYou must include the user name and password in every request you make. For example:\n```\ncurl -X GET '{baseURL}/v2.1/orders' \\ \n-u '{YOUR_USERNAME}:{YOUR_PASSWORD}' \\ \n-H 'Accept: application/json' \n```\n## Get started\nTo create your first order and find it in Sitecore CDP:\n1. Create an order. The response contains the order reference.\n2. Create an order contact using the order reference. Make sure to provide enough identity information according to [your organization's identity rules](https://doc.sitecore.com/cdp/en/users/sitecore-cdp/identifying-guests-in-sitecore-cdp.html).\nThis associates a guest with the order. In the response, in `guest.href`, the guest reference is the string that follows the final slash.\n3. Copy the guest reference.\n4. In Sitecore CDP, click **Guests**. In the **Search** field, enter the guest reference, then click the **Guest type: All** filter. Then, Sitecore CDP lists the guest profile for the guest.\n5. On the **Guest Profile** page, click the **Orders** tab. The order you previously created displays.\n","product":"CDP"}},"baseSlug":"/cdp/order-rest-api","routesMapping":{}}