> For the complete documentation index, see [llms.txt](https://developer.esw.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.esw.com/order-api/resources/first-successful-requests.md).

# First Successful Requests

## Retailer OMS / Order Ingestion

Create the first order successfully with:

```http
POST /v2/{tenantCode}/Order
```

`OrderCreate` requires top-level order identity, action metadata, currencies, destination country, shopper experience, contact details, line items, and delivery option.

{% code title="BASE URL" expandable="true" %}

```bash
https://order-transaction-api.sandbox.eshopworld.com
```

{% endcode %}

A successful submission returns <mark style="color:$success;">**`202 Accepted`**</mark> with `OrderTransactionApiResponse`, which includes `transactionReference`.

{% tabs %}
{% tab title="Try it" %}
{% @code-walkthrough/try-it specLoaded="" specEps="" method="POST" path="/v2/{tenantCode}/Order" baseUrl="<https://api.example.com>" title="Creates an order." defaults="{"path":{"tenantCode":""},"query":{},"headers":{"Content-Type":"application/json"},"body":{"brandOrderReference":"12345","weight":{"weightTotal":0,"weightUnit":"KG"},"orderType":"Offline","parentBrandOrderReference":"P12345","externalOrderId":"987456","transactionReference":"C857B3CD-5EB7-426D-8741-812E5ED214C0","transactionDateTime":"2019-10-14T15:56:18.455Z","actionedBy":"Retailer","actionedByUser":"<johnsmith@test.com>","shopperCurrencyIso":"EUR","retailerCurrencyIso":"USD","deliveryCountryIso":"IE","shopperExperience":{"shopperCultureLanguageIso":"en-IE","registeredProfileId":"44170"},"contactDetails":\[{"contactDetailsType":"IsDelivery","nickName":"NickName","addressId":"AD12345","firstName":"John ","lastName":"Smith","address1":"1234 Line Ave S","address2":"Apt B1","address3":"New York state","city":"New York city","postalCode":"10001","region":"Region","country":"US","email":"<email@test.com>","telephone":"+14211112222","gender":"None","poBox":""}],"lineItems":\[{"lineItemId":"1","quantity":2,"estimatedDeliveryDateFromRetailer":"2020-08-31T11:54:24.631Z","product":{"title":"...","description":"...","customsDescription":"...","productCode":"...","hsCode":"...","countryOfOriginIso":"...","imageUrl":"...","color":"...","size":"...","productUnitPriceInfo":"...","wholesalePriceInfo":"...","weightInfo":"...","isReturnProhibited":"...","isCustomized":"..."},"metadataItems":\["..."]}],"deliveryOption":{"priceInfo":{"price":"..."},"type":"NA","eshopDeliveryOptionCode":"DEFAULT","estimatedDeliveryDateToShopper":"2020-08-31T11:54:24.631Z","vatRate":21},"retailerInvoice":{"number":"784512","date":"2020-05-11"},"payment":{"method":"ApplePay","last4Digits":"1234","paymentAttemptRef":"1CBA8F0C-F7EE-437C-A450-B63ADD08CA5A","priceInfo":{"price":"..."},"deliveryPriceInfo":{"price":"..."},"retailerPriceInfo":{"price":"..."},"retailerDeliveryPriceInfo":{"price":"..."},"paymentStatus":"string","merchantPaymentId":"string","paymentTime":"string","preAuthExpiryTime":"string","authResult":"string"},"originDetails":{"originType":"None","firstName":"John ","lastName":"Smith","telephone":"+14211112222","nickName":"NickName","addressId":"AD12345","address1":"1234 Line Ave S","address2":"Apt B1","address3":"New York state","city":"New York city","postalCode":"10001","region":"Region","country":"US","email":"<email@test.com>","gender":"None","poBox":""},"metadataItems":\[{"name":"KeyName","value":"KeyValue"}],"channelType":"string"}}" mode="closed" %}
{% endtab %}
{% endtabs %}

#### Path Parameter

| Name         | Type     | Description                                                                                                      |
| ------------ | -------- | ---------------------------------------------------------------------------------------------------------------- |
| `tenantCode` | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Tenant code for the retailer integration.</p> |

<details>

<summary>Request Construction</summary>

{% @code-walkthrough/body-builder specIndex="{"defs":{"ActionedBy":{"enum":\["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"},"ActivityStatus":{"enum":\["Cancel","Fulfil"],"type":"string","description":"ActivityStatus"},"AddOrderCommentRequestDto":{"type":"object","properties":{"comment":{"type":"string","description":"Comment text","nullable":true},"user":{"type":"string","description":"User who added the comment (nullable, Nike won't use it)","nullable":true}},"additionalProperties":false,"description":"Request DTO for adding a comment to an order"},"AddOrderCommentResponse":{"type":"object","properties":{"user":{"type":"string","description":"User who added the comment","nullable":true},"time":{"type":"string","description":"Time when the comment was added","format":"date-time"}},"additionalProperties":false,"description":"Response after adding a comment to an order"},"AllocationActivityStatus":{"enum":\["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"},"AppeasementsReasonCode":{"enum":\["Appeasement","LostPackage","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"AppeasementsType":{"enum":\["Merchandise","Shipping","Order"],"type":"string","description":""},"ArticleAllocation":{"required":\["activityStatus","fulfilmentCountryIso"],"type":"object","properties":{"activityStatus":{"$ref":"#/components/schemas/AllocationActivityStatus"},"fulfilmentCountryIso":{"minLength":1,"type":"string","description":"Fulfilment country ISO"},"fulfilmentCentreId":{"type":"string","description":"Fulfilment centre Id","nullable":true},"reasonCode":{"$ref":"#/components/schemas/LineItemActivityReasonCode"}},"additionalProperties":false,"description":"Article allocation"},"ArticleAppeasementDetails":{"type":"object","properties":{"articleId":{"type":"string","description":"Article Id to be appeased","nullable":true},"reasonCode":{"$ref":"#/components/schemas/LineItemAppeasementReasonCode"},"amount":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false}},"additionalProperties":false,"description":"Article Appeasement Details"},"ArticleAppeasementRequest":{"required":\["actionedBy","transactionDateTime","transactionReference"],"type":"object","properties":{"articlesAppeasementDetails":{"type":"array","items":{"$ref":"#/components/schemas/ArticleAppeasementDetails"},"description":"The Ids of the articles to appease","nullable":true,"example":1},"referenceNumber":{"type":"string","description":"Reference Number","nullable":true},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Refund Line Item Dto"},"ContactDetail":{"required":\["address1","city","contactDetailsType","country","email","firstName","lastName","telephone"],"type":"object","properties":{"contactDetailsType":{"$ref":"#/components/schemas/ContactDetailsType"},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true,"example":"NickName"},"addressId":{"type":"string","description":"Address Identifier","nullable":true,"example":"AD12345"},"firstName":{"minLength":1,"type":"string","description":"First name of the address.","example":"John "},"lastName":{"minLength":1,"type":"string","description":"Last name of the address.","example":"Smith"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true,"example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address.","example":"US"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"telephone":{"minLength":1,"type":"string","description":"Phone number.","example":"+14211112222"},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true,"example":""}},"additionalProperties":false,"description":"Contact Details"},"ContactDetailsType":{"enum":\["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"},"CurrencyDetails":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Currency ISO code","nullable":true},"currencyExponent":{"type":"integer","description":"Currency exponent which indicates the number of decimal places used by the currency","format":"int32","nullable":true}},"additionalProperties":false,"description":"Currency details"},"CustomerServiceOrderArticleDto":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"OrderArticleId","format":"int64"},"itemSequence":{"type":"integer","description":"Item Sequence","format":"int32","nullable":true},"orderArticleStatus":{"type":"string","description":"OrderArticleStatus","nullable":true},"cancelStatusId":{"type":"integer","description":"CancelStatusId","format":"int32"},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"refundStatusId":{"type":"integer","description":"RefundStatus","format":"int32"},"returnListingId":{"type":"integer","description":"ReturnListingId","format":"int64","nullable":true},"returnReason":{"type":"string","description":"ReturnReason","nullable":true},"replacementOfArticleId":{"type":"integer","description":"ReplacementOfArticle","format":"int64","nullable":true},"replaced":{"type":"boolean","description":"Replaced","nullable":true},"shipped":{"type":"boolean","description":"Shipped"},"allocated":{"type":"boolean","description":"Allocated"},"isCancellable":{"type":"boolean","description":"IsCancellable"},"unitPrice":{"type":"number","description":"UnitPrice","format":"double"},"unitPriceBase":{"type":"number","description":"UnitPriceBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"actualPrice":{"type":"number","description":"ActualPrice","format":"double"},"actualPriceBase":{"type":"number","description":"ActualPriceBase","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double"},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"vat":{"type":"number","description":"Vat","format":"double"},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"salesTax":{"type":"number","description":"SalesTax","format":"double"},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsFee":{"type":"number","description":"CustomsFee","format":"double"},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double"},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double"},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"productDiscountedAmount":{"type":"number","description":"ProductDiscountedAmount","format":"double","nullable":true},"shippingDiscountedAmount":{"type":"number","description":"ShippingDiscountedAmount","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"productColourCode":{"type":"string","description":"ProductColourCode","nullable":true},"productSizeCode":{"type":"string","description":"ProductSizeCode","nullable":true},"productColourDesc":{"type":"string","description":"ProductColourDesc","nullable":true},"styleNumber":{"type":"string","description":"StyleNumber","nullable":true},"sku":{"type":"string","description":"Sku","nullable":true},"orderProduct":{"$ref":"#/components/schemas/CustomerServiceOrderProductDto"},"statusSummary":{"$ref":"#/components/schemas/OrderArticleStatusSummaryDto"},"refund":{"$ref":"#/components/schemas/OrderArticleRefundDto"},"refundReturn":{"$ref":"#/components/schemas/OrderArticleRefundDto"},"proRataRefund":{"$ref":"#/components/schemas/OrderArticleRefundDetailDto"},"returnListing":{"$ref":"#/components/schemas/CustomerServiceReturnListingDto"}},"additionalProperties":false,"description":"Customer Service Order Article Dto"},"CustomerServiceOrderProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"ProductCode","nullable":true},"shortDescription":{"type":"string","description":"ShortDescription","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"customsDescription":{"type":"string","description":"CustomsDescription","nullable":true},"category":{"type":"string","description":"Category","nullable":true},"productColourCode":{"type":"string","description":"ProductColourCode","nullable":true},"productSizeCode":{"type":"string","description":"ProductSizeCode","nullable":true},"productColourDesc":{"type":"string","description":"ProductColourDesc","nullable":true},"styleNumber":{"type":"string","description":"StyleNumber","nullable":true},"sku":{"type":"string","description":"Sku","nullable":true}},"additionalProperties":false,"description":"Customer Service Order Product"},"CustomerServiceOrderProductDto":{"type":"object","properties":{"productCode":{"type":"string","description":"ProductCode","nullable":true},"shortDescription":{"type":"string","description":"ShortDescription","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"customsDescription":{"type":"string","description":"CustomsDescription","nullable":true},"category":{"type":"string","description":"Category","nullable":true}},"additionalProperties":false,"description":"Customer Service Order Product"},"CustomerServicePaymentActivity":{"type":"object","properties":{"date":{"type":"string","description":"Date","format":"date-time"},"amount":{"type":"number","description":"Amount","format":"double"},"amountBase":{"type":"number","description":"AmountBase","format":"double"},"event":{"type":"string","description":"Event","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"attemptRef":{"type":"string","description":"AttemptRef","nullable":true}},"additionalProperties":false,"description":"Customer service payment activity"},"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"},"DeliveryOption":{"required":\["eshopDeliveryOptionCode"],"type":"object","properties":{"eshopDeliveryOptionCode":{"$ref":"#/components/schemas/ServiceLevel"},"estimatedDeliveryDateToShopper":{"type":"string","description":"Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":21}},"additionalProperties":false,"description":"Delivery Option"},"DeliveryOptionCreate":{"required":\["eshopDeliveryOptionCode","priceInfo"],"type":"object","properties":{"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"type":{"$ref":"#/components/schemas/DeliveryTypeOms"},"eshopDeliveryOptionCode":{"$ref":"#/components/schemas/ServiceLevel"},"estimatedDeliveryDateToShopper":{"type":"string","description":"Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":21}},"additionalProperties":false,"description":"Delivery Option"},"DeliveryTypeOms":{"enum":\["NA","Home","Store","PUDO","Digital"],"type":"string","description":"DeliveryTypeOms"},"EmailLabel":{"type":"object","properties":{"id":{"type":"string","description":"Label Identifier","format":"uuid"},"hasAttachment":{"type":"boolean","description":"HasAttachment"},"data":{"type":"string","description":"Data","nullable":true},"dataUrl":{"type":"string","description":"Data URL","nullable":true}},"additionalProperties":false,"description":"Label information associated to the email details"},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error Identifier code","format":"int32","example":1},"message":{"type":"string","description":"Error Message","nullable":true,"example":"Invalid BrandOrderReference"}},"additionalProperties":false,"description":"Error Response"},"ErrorStatus":{"enum":\["Retry","Processed","Failed","InProgress"],"type":"string","description":"Represents Order Migration/Integration event error status"},"ErrorType":{"enum":\["Migration","Integration","RecalculateAllocation","NonCheckOutOrderCreate","PaymentAttempt","NonCheckoutOrder","PaymentAggregate"],"type":"string","description":"Enumeration for error types to log the error for reprocessing"},"FailedEventRequest":{"type":"object","properties":{"tenantCode":{"type":"string","description":"TenantCode","nullable":true},"errorType":{"$ref":"#/components/schemas/ErrorType"},"batchSize":{"type":"integer","description":"BatchSize","format":"int32"},"retryCount":{"type":"integer","description":"RetryCount","format":"int32"},"errorStatus":{"$ref":"#/components/schemas/ErrorStatus"}},"additionalProperties":false,"description":"FailedEventRequest"},"FailedEventsHandlerResponse":{"type":"object","properties":{"httpStatusCode":{"$ref":"#/components/schemas/HttpStatusCode"},"failedCount":{"type":"integer","description":"","format":"int32"},"successCount":{"type":"integer","description":"","format":"int32"},"totalCount":{"type":"integer","description":"","format":"int32"},"failedIds":{"type":"array","items":{"type":"string"},"description":"","nullable":true}},"additionalProperties":false,"description":"FailedEventsHandlerResponse"},"FinTransDetails":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","nullable":true},"type":{"type":"string","description":"Type","nullable":true},"amount":{"type":"number","description":"Amount","format":"double"},"amountBase":{"type":"number","description":"Amount Base","format":"double"},"status":{"type":"string","description":"Status","nullable":true},"response":{"type":"string","description":"Response","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"transactionType":{"type":"string","description":"Transaction Type","nullable":true},"creationTime":{"type":"string","description":"Creation Time","format":"date-time","nullable":true},"reason":{"type":"string","description":"Reason","nullable":true},"paymentDetailCollectionStatus":{"type":"integer","description":"Payment Detail Collection Status","format":"int32"},"isOfflineRefundEnabled":{"type":"boolean","description":"Is Offline Refund Enabled"},"offlineRefundTooltip":{"type":"string","description":"Offline Refund Tooltip","nullable":true}},"additionalProperties":false,"description":"Financial Transactions Details"},"Gender":{"enum":\["None","Male","Female","Unisex"],"type":"string","description":"Gender"},"GetOrderDetailsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","nullable":true},"orderGuid":{"type":"string","description":"Order Guid","format":"uuid","nullable":true},"eShopOrderReference":{"type":"string","description":"E-Shop Order Reference","nullable":true},"brandOrderReference":{"type":"string","description":"Brand order reference","nullable":true},"brandId":{"type":"integer","description":"Brand identifier","format":"int32"},"brandCode":{"type":"string","description":"Brand code","nullable":true},"brandName":{"type":"string","description":"Brand name","nullable":true},"tenantCode":{"type":"string","description":"Tenant code","nullable":true},"creationTime":{"type":"string","description":"Creation time of the order","format":"date-time"},"orderStatus":{"type":"string","description":"Status of the order","nullable":true},"orderHoldStatus":{"type":"string","description":"Order hold status","nullable":true},"paymentId":{"type":"string","description":"Payment identifier","nullable":true},"orderType":{"type":"string","description":"Order type","nullable":true},"balance":{"$ref":"#/components/schemas/OrderBalanceResponse"},"isCancellable":{"type":"boolean","description":"Is the order cancellable"},"isLineItemCancellable":{"type":"boolean","description":"Is the line item cancellable"},"orderAllocated":{"type":"boolean","description":"Is the order allocated","nullable":true},"allocationMethod":{"type":"string","description":"Allocation method of the order","nullable":true},"serviceLevel":{"type":"string","description":"Service level of the order","nullable":true},"refund":{"$ref":"#/components/schemas/OrderRefundResponse"},"proRataRefund":{"$ref":"#/components/schemas/OrderProRataRefundResponse"},"estimatedDelivery":{"$ref":"#/components/schemas/OrderEstimatedDeliveryResponse"},"deliveryAddress":{"$ref":"#/components/schemas/OrderAddressResponse"},"paymentAddress":{"$ref":"#/components/schemas/OrderAddressResponse"},"orderCharge":{"$ref":"#/components/schemas/OrderChargeResponse"},"payment":{"$ref":"#/components/schemas/OrderPaymentResponse"},"currencies":{"$ref":"#/components/schemas/OrderCurrenciesResponse"},"orderArticles":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticlesResponse"},"description":"Order article details","nullable":true},"replacements":{"type":"array","items":{"$ref":"#/components/schemas/OrderReplacementsResponse"},"description":"Order replacements details","nullable":true},"isRefundProcessExternal":{"type":"boolean","description":"Is the refund process handled by external system"},"isRefundCreationExternal":{"type":"boolean","description":"Is the refund creation handled by external system"},"canAllowNonCheckOutRefund":{"type":"boolean","description":"Can allow non-checkout refund"},"deliveryType":{"type":"string","description":"Delivery type of the order","nullable":true}},"additionalProperties":false,"description":"Get Order details response"},"GetTransaction":{"type":"object","properties":{"refundAmounts":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of refund amounts.","nullable":true},"refundAmountsInRetailerCurrency":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of refund amounts.","nullable":true},"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"reasonCode":{"type":"string","description":"Reason","nullable":true,"example":"LostPackage"},"lastUpdateTime":{"type":"string","description":"LastUpdateTime","format":"date-time","nullable":true},"creationTime":{"type":"string","description":"CreationTime","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Get Full Transaction Details which includes refund amount"},"HttpStatusCode":{"enum":\["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","UseProxy","Unused","RedirectKeepVerb","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"LineItemActivityReasonCode":{"enum":\["OutOfStock","ShopperCancel","ItemFulfilled"],"type":"string","description":"Order Activity Reason Code"},"LineItemActivityRequest":{"required":\["actionedBy","activityStatus","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"The Id of the line item to cancel. Either lineItemId or product code is required.","nullable":true,"example":"1"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item. Either lineItemId or product code is required.","nullable":true,"example":"241563"},"quantity":{"type":"integer","description":"Quantity of products to cancel.","format":"int32","example":2},"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"reasonCode":{"$ref":"#/components/schemas/LineItemActivityReasonCode"},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"LineItemActivityRequest"},"LineItemAppeasementReasonCode":{"enum":\["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"LineItemAppeasementRequest":{"required":\["actionedBy","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"The Id of the line item to appease. Either lineItemId or product code is required.","nullable":true,"example":"1"},"productCode":{"type":"string","description":"Product code. Either lineItemId or productId is required.\r\n Example: ‘277906’","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to appease","format":"int32","example":2},"reasonCode":{"$ref":"#/components/schemas/LineItemAppeasementReasonCode"},"transaction":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"LineItemAppeasementRequest"},"LineItemRequest":{"required":\["actionedBy","quantity","reasonCode","replacementOrderDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true,"example":"2"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32","example":2},"reasonCode":{"$ref":"#/components/schemas/ReplaceOrderItemsReasonCode"},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"LineItemUpdateRequest":{"required":\["actionedBy","lineItemId","productCode","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item to be updated.","example":"2"},"quantity":{"type":"integer","description":"Quantity to be updated.","format":"int32","example":2},"productCode":{"minLength":1,"type":"string","description":"New product code or stock-keeping unit (SKU) number of the item.","example":"277906"},"reasonCode":{"$ref":"#/components/schemas/UpdateLineItemReasonCode"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Update line items request"},"LineItemsAddRequest":{"required":\["actionedBy","contactDetails","deliveryCountryIso","deliveryOption","lineItems","orderType","retailerCurrencyIso","shopperCurrencyIso","shopperExperience","transactionDateTime","transactionReference"],"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"P12345"},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true,"example":"987456"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","example":"EUR"},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","example":"USD"},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","example":"IE"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemToCreate"},"description":"Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required."},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOptionCreate"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"payment":{"$ref":"#/components/schemas/Payment"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true},"channelType":{"type":"string","description":"Channel Type","nullable":true}},"additionalProperties":false,"description":"Add line items request"},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true,"example":"KeyName"},"value":{"type":"string","description":"Metadata value.","nullable":true,"example":"KeyValue"}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true,"example":"EUR"},"amount":{"type":"string","description":"The amount of the currency.","nullable":true,"example":"100.00"}},"additionalProperties":false,"description":"Money"},"NamedMoney":{"required":\["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge.","example":"ItemTaxes"},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Order":{"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"orderGuid":{"type":"string","description":"Order GUID.","format":"uuid","example":"b785ef18-046e-471c-8470-727c7db0ce6e"},"status":{"$ref":"#/components/schemas/OrderStatuses"},"brandOrderReference":{"type":"string","description":"The brand's order number.","nullable":true,"example":"78451296"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"3265987"},"eShopWorldOrderNumber":{"type":"string","description":"Order number in the eshopWorld system.","nullable":true,"example":"5001007400857"},"shopperCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","nullable":true,"example":"EUR"},"retailerCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","nullable":true,"example":"USD"},"deliveryCountryIso":{"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","nullable":true,"example":"IE"},"orderDate":{"type":"string","description":"The datetime when the order was created, in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"weight":{"$ref":"#/components/schemas/WeightInfo"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details.","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"Attributes that describe the items in the cart.","nullable":true},"orderCharges":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"<summary>A list of order level charges.</summary>","nullable":true},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOption"},"payment":{"$ref":"#/components/schemas/Payment"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"description":"Transactions","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs","nullable":true},"orderBalances":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of order balance charges","nullable":true}},"additionalProperties":false,"description":"Order"},"OrderActivityReasonCode":{"enum":\["ShopperCancel","RetailerCancel","Fraud"],"type":"string","description":"Order Activity Reason Code"},"OrderActivityRequest":{"required":\["actionedBy","activityStatus","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"reasonCode":{"$ref":"#/components/schemas/OrderActivityReasonCode"},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderActivityRequest"},"OrderAddressDto":{"type":"object","properties":{"nameAddressId":{"type":"integer","description":"Name Address Id","format":"int64"},"brandId":{"type":"integer","description":"Brand Id","format":"int32"},"firstName":{"type":"string","description":"First Name","nullable":true},"middleName":{"type":"string","description":"Middle Name","nullable":true},"lastName":{"type":"string","description":"Last Name","nullable":true},"name":{"type":"string","description":"First and Last names combined","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"telephone":{"type":"string","description":"Telephone","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City","nullable":true},"region":{"type":"string","description":"Region","nullable":true},"postalCode":{"type":"string","description":"Postal Code","nullable":true},"country":{"type":"string","description":"Country","nullable":true},"countryIso":{"type":"string","description":"Country ISO","nullable":true},"storeName":{"type":"string","description":"Store Name","nullable":true}},"additionalProperties":false,"description":"Package address information associated to an Order comming from Order Internal API"},"OrderAddressResponse":{"type":"object","properties":{"nameAddressId":{"type":"integer","description":"Name address identifier","format":"int64"},"brandId":{"type":"integer","description":"Brand identifier","format":"int32"},"firstName":{"type":"string","description":"First name of the contact","nullable":true},"middleName":{"type":"string","description":"Middle name of the contact","nullable":true},"lastName":{"type":"string","description":"Last name of the contact","nullable":true},"name":{"type":"string","description":"Name of the contact (contains first name and last name)","nullable":true},"email":{"type":"string","description":"Email address of the contact","nullable":true},"telephone":{"type":"string","description":"Telephone number of the contact","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City of the contact","nullable":true},"region":{"type":"string","description":"Region of the contact","nullable":true},"postalCode":{"type":"string","description":"Postal code of the contact","nullable":true},"country":{"type":"string","description":"Country of the contact","nullable":true},"countryIso":{"type":"string","description":"ISO code of the country","nullable":true},"storeName":{"type":"string","description":"Name of the store","nullable":true}},"additionalProperties":false,"description":"Order address response"},"OrderAllocationRequest":{"required":\["actionedBy","lineItems","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemAllocation"},"description":"The Line Items to allocate"},"allocationId":{"type":"string","description":"Allocation ID","nullable":true},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderAllocationRequest"},"OrderAppeasementRequest":{"required":\["actionedBy","reasonCode","transactionDateTime","transactionReference","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/AppeasementsType"},"reasonCode":{"$ref":"#/components/schemas/AppeasementsReasonCode"},"transaction":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set  for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":""},"OrderArticle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Article sequence within the line item","format":"int32","example":2},"status":{"$ref":"#/components/schemas/OrderArticleStatuses"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of item level charges.","nullable":true}},"additionalProperties":false,"description":"Order Article"},"OrderArticleRefund":{"type":"object","properties":{"useMerchandiseAmount":{"type":"boolean","description":"UseMerchandiseAmount"},"useDutyAmount":{"type":"boolean","description":"UseDutyAmount"},"useVatAmount":{"type":"boolean","description":"UseVatAmount"},"useSalesTaxAmount":{"type":"boolean","description":"UseSalesTaxAmount"},"useCustomsFeeAmount":{"type":"boolean","description":"UseCustomsFeeAmount"},"useShippingAmount":{"type":"boolean","description":"UseShippingAmount"},"dutyAndTax":{"type":"number","description":"DutyAndTax","format":"double"},"dutyAndTaxBase":{"type":"number","description":"DutyAndTaxBase","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"}},"additionalProperties":false,"description":"Order Article Refund"},"OrderArticleRefundDetail":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"Order Article identifier","format":"int64"},"articleRefundAmount":{"type":"number","description":"Article refund amount available","format":"double"},"articleShippingRefundAmount":{"type":"number","description":"Article shipping refund amount available","format":"double"},"refundAmountAvailable":{"type":"number","description":"Refund amount available for the article","format":"double"},"itemPendingCancel":{"type":"boolean","description":"Item pending cancel for the article"},"orderArticleStatusForRefund":{"type":"string","description":"Order article status for refund","nullable":true}},"additionalProperties":false,"description":"Order Article refund detail\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderArticleRefundDetailDto":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"Order Article identifier","format":"int64"},"articleRefundAmount":{"type":"number","description":"Article refund amount available","format":"double"},"articleShippingRefundAmount":{"type":"number","description":"Article shipping refund amount available","format":"double"},"refundAmountAvailable":{"type":"number","description":"Refund amount available for the article","format":"double"},"itemPendingCancel":{"type":"boolean","description":"Item pending cancel for the article"},"orderArticleStatusForRefund":{"type":"string","description":"Order article status for refund","nullable":true}},"additionalProperties":false,"description":"Order Article refund detail dto"},"OrderArticleRefundDto":{"type":"object","properties":{"useMerchandiseAmount":{"type":"boolean","description":"UseMerchandiseAmount"},"useDutyAmount":{"type":"boolean","description":"UseDutyAmount"},"useVatAmount":{"type":"boolean","description":"UseVatAmount"},"useSalesTaxAmount":{"type":"boolean","description":"UseSalesTaxAmount"},"useCustomsFeeAmount":{"type":"boolean","description":"UseCustomsFeeAmount"},"useShippingAmount":{"type":"boolean","description":"UseShippingAmount"},"dutyAndTax":{"type":"number","description":"DutyAndTax","format":"double"},"dutyAndTaxBase":{"type":"number","description":"DutyAndTaxBase","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"}},"additionalProperties":false,"description":"Order Article Refund"},"OrderArticleStatusSummary":{"type":"object","properties":{"standardStatus":{"type":"string","description":"StandardStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"replacedStatus":{"type":"string","description":"ReplacedStatus","nullable":true},"replacementStatus":{"type":"string","description":"ReplacementStatus","nullable":true}},"additionalProperties":false,"description":"Order Article Status Summary"},"OrderArticleStatusSummaryDto":{"type":"object","properties":{"standardStatus":{"type":"string","description":"StandardStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"replacedStatus":{"type":"string","description":"ReplacedStatus","nullable":true},"replacementStatus":{"type":"string","description":"ReplacementStatus","nullable":true}},"additionalProperties":false,"description":"Order Article Status Summary"},"OrderArticleStatuses":{"enum":\["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"},"OrderArticlesResponse":{"type":"object","properties":{"id":{"type":"string","description":"OrderArticleId","nullable":true},"lineItemId":{"type":"string","description":"Line Item Id","nullable":true},"status":{"type":"string","description":"OrderArticleStatus","nullable":true},"cancelStatus":{"type":"string","description":"CancelStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"refundStatus":{"type":"string","description":"RefundStatus","nullable":true},"returnListing":{"type":"string","description":"ReturnListingId","nullable":true},"returnReason":{"type":"string","description":"ReturnReason","nullable":true},"replacementOfArticle":{"type":"string","description":"ReplacementOfArticle","nullable":true},"replaced":{"type":"boolean","description":"Replaced","nullable":true},"shipped":{"type":"boolean","description":"Shipped"},"allocated":{"type":"boolean","description":"Allocated"},"isCancellable":{"type":"boolean","description":"IsCancellable"},"unitPrice":{"type":"number","description":"UnitPrice","format":"double"},"unitPriceBase":{"type":"number","description":"UnitPriceBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"actualPrice":{"type":"number","description":"ActualPrice","format":"double"},"actualPriceBase":{"type":"number","description":"ActualPriceBase","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double"},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"vat":{"type":"number","description":"Vat","format":"double"},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"salesTax":{"type":"number","description":"SalesTax","format":"double"},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsFee":{"type":"number","description":"CustomsFee","format":"double"},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double"},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double"},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"productDiscountedAmount":{"type":"number","description":"ProductDiscountedAmount","format":"double","nullable":true},"shippingDiscountedAmount":{"type":"number","description":"ShippingDiscountedAmount","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"orderProduct":{"$ref":"#/components/schemas/CustomerServiceOrderProduct"},"statusSummary":{"$ref":"#/components/schemas/OrderArticleStatusSummary"},"refund":{"$ref":"#/components/schemas/OrderArticleRefund"},"refundReturn":{"$ref":"#/components/schemas/OrderArticleRefund"},"proRataRefund":{"$ref":"#/components/schemas/OrderArticleRefundDetail"},"returnOrderNumber":{"type":"integer","description":"ReturnOrderNumber","format":"int64"}},"additionalProperties":false,"description":"Order articles response"},"OrderBalanceResponse":{"type":"object","properties":{"credits":{"type":"number","description":"Credits","format":"double","nullable":true},"debits":{"type":"number","description":"Debits","format":"double","nullable":true},"balance":{"type":"number","description":"Balance","format":"double","nullable":true},"nonRefundableBalance":{"type":"number","description":"Non-refundable balance","format":"double","nullable":true}},"additionalProperties":false,"description":"Order balance response"},"OrderChargeResponse":{"type":"object","properties":{"merchandise":{"type":"number","description":"Merchandise","format":"double","nullable":true},"merchandiseBase":{"type":"number","description":"MerchandiseBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"merchandiseLessDiscount":{"type":"number","description":"MerchandiseLessDiscount","format":"double","nullable":true},"merchandiseLessDiscountBase":{"type":"number","description":"MerchandiseLessDiscountBase","format":"double"},"vat":{"type":"number","description":"Vat","format":"double","nullable":true},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"customsFee":{"type":"number","description":"CustomsFee","format":"double","nullable":true},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"salesTax":{"type":"number","description":"SalesTax","format":"double","nullable":true},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double","nullable":true},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double","nullable":true},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"edduDutiesAndTaxes":{"type":"number","description":"EdduDutiesAndTaxes","format":"double"},"edduDutiesAndTaxesBase":{"type":"number","description":"EdduDutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double","nullable":true},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"total":{"type":"number","description":"Total","format":"double","nullable":true},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"brandJsonData":{"type":"string","description":"BrandJsonData","nullable":true},"displayModelId":{"type":"integer","description":"DisplayModelId","format":"int32","nullable":true},"brandCountryDisplayModelId":{"type":"integer","description":"BrandCountryDisplayModelId","format":"int32","nullable":true},"paymentMethodCharge":{"type":"number","description":"PaymentMethodCharge","format":"double","nullable":true},"paymentMethodChargeBase":{"type":"number","description":"PaymentMethodChargeBase","format":"double","nullable":true},"nonRefundableCharge":{"type":"number","description":"NonRefundableCharge","format":"double","nullable":true}},"additionalProperties":false,"description":"Order charge response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderCreate":{"required":\["actionedBy","brandOrderReference","contactDetails","deliveryCountryIso","deliveryOption","lineItems","orderType","retailerCurrencyIso","shopperCurrencyIso","shopperExperience","transactionDateTime","transactionReference"],"type":"object","properties":{"brandOrderReference":{"minLength":1,"type":"string","description":"The Brand's order number.","example":"12345"},"weight":{"$ref":"#/components/schemas/WeightInfo"},"orderType":{"$ref":"#/components/schemas/OrderType"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"P12345"},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true,"example":"987456"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","example":"EUR"},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","example":"USD"},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","example":"IE"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemToCreate"},"description":"Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required."},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOptionCreate"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"payment":{"$ref":"#/components/schemas/Payment"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true},"channelType":{"type":"string","description":"Channel Type","nullable":true}},"additionalProperties":false,"description":"Order create request"},"OrderCurrenciesResponse":{"type":"object","properties":{"shopper":{"$ref":"#/components/schemas/CurrencyDetails"},"retailer":{"$ref":"#/components/schemas/CurrencyDetails"}},"additionalProperties":false,"description":"Order currencies response"},"OrderEmailDetail":{"type":"object","properties":{"id":{"type":"string","description":"Email Identifier","nullable":true},"template":{"type":"string","description":"Template","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"lastUpdateTime":{"type":"string","description":"Last Update Time","format":"date-time"},"recipients":{"type":"array","items":{"type":"string"},"description":"Recipients","nullable":true},"label":{"$ref":"#/components/schemas/EmailLabel"}},"additionalProperties":false,"description":"Email information associated to an order"},"OrderEstimatedDeliveryResponse":{"type":"object","properties":{"minDays":{"type":"integer","description":"Minimum estimated delivery days for the order","format":"int32"},"maxDays":{"type":"integer","description":"Maximum estimated delivery days for the order","format":"int32"},"formatted":{"type":"string","description":"Formatted estimated delivery date range for the order","nullable":true}},"additionalProperties":false,"description":"Order estimated delivery response"},"OrderGroup":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the OrderGroup.","format":"uuid"},"orderGroupName":{"type":"string","description":"Name of the OrderGroup.","nullable":true},"orderNumbers":{"type":"array","items":{"type":"string"},"description":"IDs of orders included in this group.","nullable":true}},"additionalProperties":false,"description":"Entity for Order Group."},"OrderItem":{"required":\["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID.","example":"1"},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32","example":2},"estimatedDeliveryDateFromRetailer":{"type":"string","description":"Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"product":{"$ref":"#/components/schemas/Product"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticle"},"description":"List of articles with their statuses","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs","nullable":true}},"additionalProperties":false,"description":"Cart Items"},"OrderItemAllocation":{"required":\["articles","lineItemId","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item id","example":"1"},"quantity":{"type":"integer","description":"Quantity","format":"int32","example":1},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleAllocation"},"description":"Articles to allocate"}},"additionalProperties":false,"description":"Defines the model to be used when allocating a line item"},"OrderItemReplacement":{"required":\["quantity","replacementOrderDetails"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true,"example":"2"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32","example":2},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"OrderItemToCreate":{"required":\["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID.","example":"1"},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32","example":2},"estimatedDeliveryDateFromRetailer":{"type":"string","description":"Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"product":{"$ref":"#/components/schemas/ProductCreate"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true}},"additionalProperties":false,"description":"Cart Items"},"OrderPackage":{"type":"object","properties":{"packageId":{"type":"string","description":"Package Id","nullable":true},"packageStatus":{"type":"string","description":"Package Status","nullable":true},"brandPackageReference":{"type":"string","description":"Brand Package Reference","nullable":true},"eShopPackageReference":{"type":"string","description":"Eshop Package Reference","nullable":true},"carrier":{"type":"string","description":"Carrier","nullable":true},"serviceType":{"type":"string","description":"Service Type","nullable":true},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"weight":{"type":"number","description":"Weight","format":"float","nullable":true},"weightUnit":{"type":"string","description":"Weight Unit","nullable":true},"duty":{"type":"number","description":"Duty","format":"double"},"vat":{"type":"number","description":"VAT","format":"double"},"tax":{"type":"number","description":"Tax","format":"double"},"customsFee":{"type":"number","description":"Customs Fee","format":"double"},"shipping":{"type":"number","description":"Shipping","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"merch":{"type":"number","description":"Merch","format":"double"},"shippingAddress":{"$ref":"#/components/schemas/OrderPackageAddress"},"packageArticles":{"type":"array","items":{"$ref":"#/components/schemas/OrderPackageArticle"},"description":"Articles associated to the package","nullable":true}},"additionalProperties":false,"description":"Package information associated to an order"},"OrderPackageAddress":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name","nullable":true},"middleName":{"type":"string","description":"Middle Name","nullable":true},"lastName":{"type":"string","description":"Last Name","nullable":true},"name":{"type":"string","description":"First and Last names combined","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"telephone":{"type":"string","description":"Telephone","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City","nullable":true},"region":{"type":"string","description":"Region","nullable":true},"postalCode":{"type":"string","description":"Postal Code","nullable":true},"country":{"type":"string","description":"Country","nullable":true},"countryIso":{"type":"string","description":"Country ISO","nullable":true},"storeName":{"type":"string","description":"Store Name","nullable":true}},"additionalProperties":false,"description":"Address information for an order package"},"OrderPackageArticle":{"type":"object","properties":{"returnOrderNumber":{"type":"string","description":"Return Order Number","nullable":true},"sku":{"type":"string","description":"SKU","nullable":true},"description":{"type":"string","description":"Description","nullable":true}},"additionalProperties":false,"description":"Article associated to a package"},"OrderPaymentDetail":{"type":"object","properties":{"amount":{"type":"number","description":"Amount","format":"double"},"date":{"type":"string","description":"Date","format":"date-time"},"event":{"type":"string","description":"Event","nullable":true},"status":{"type":"string","description":"Statys","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"attemptRef":{"type":"string","description":"AttemptRef","format":"uuid"}},"additionalProperties":false,"description":"Order Payment Detail"},"OrderPaymentResponse":{"type":"object","properties":{"paymentId":{"type":"integer","description":"PaymentId","format":"int64","nullable":true},"paymentAttemptRef":{"type":"string","description":"PaymentAttemptRef","format":"uuid","nullable":true},"paymentProviderOrderId":{"type":"string","description":"PaymentProviderOrderId","nullable":true},"amount":{"type":"number","description":"Amount","format":"double"},"currencyCode":{"type":"string","description":"CurrencyCode","nullable":true},"statusId":{"type":"integer","description":"StatusId","format":"int32","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"methodId":{"type":"integer","description":"MethodId","format":"int32","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"legacyMethod":{"type":"string","description":"LegacyMethod","nullable":true},"adminFee":{"type":"number","description":"AdminFee","format":"double","nullable":true},"paymentTime":{"type":"string","description":"PaymentTime","format":"date-time","nullable":true},"expiryTime":{"type":"string","description":"ExpiryTime","format":"date-time","nullable":true},"edduToken":{"type":"string","description":"EdduToken","nullable":true},"provider":{"type":"string","description":"Provider","nullable":true},"paymentReference":{"type":"string","description":"PaymentReference","nullable":true},"preAuthorized":{"type":"boolean","description":"PreAuthorized","nullable":true},"settled":{"type":"boolean","description":"Settled","nullable":true},"isPreAuth":{"type":"boolean","description":"IsPreAuth"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServicePaymentActivity"},"description":"Activities","nullable":true},"last4Digits":{"type":"string","description":"Last4Digits","nullable":true},"masterPaymentIdentifier":{"type":"string","description":"MasterPaymentIdentifier","format":"uuid","nullable":true},"isSplitPayment":{"type":"boolean","description":"IsSplitPayment"},"isPaid":{"type":"boolean","description":"IsPaid"}},"additionalProperties":false,"description":"Order payment response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderProRataRefundResponse":{"type":"object","properties":{"orderId":{"type":"integer","description":"Order identifier","format":"int64"},"orderStatusForRefund":{"type":"string","nullable":true},"orderArticleRefundDetails":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticleRefundDetail"},"description":"Order Article refund details","nullable":true},"shippingAmountAvailable":{"type":"number","description":"Shipping amount available for refund","format":"double"},"fullOrderAmountAvailable":{"type":"number","description":"Full order amount available for refund","format":"double"}},"additionalProperties":false,"description":"Order Pro Rata Refund response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderRefundResponse":{"type":"object","properties":{"totalRefunded":{"type":"number","description":"Total refunded amount for the order","format":"double","nullable":true},"totalRefundedBase":{"type":"number","description":"Total refunded amount for the order in base currency","format":"double"},"totalRefundedEdduDutyAndTax":{"type":"number","description":"Total refunded EDDU duty and tax for the order","format":"double"},"totalRefundedEdduDutyAndTaxBase":{"type":"number","description":"Total refunded EDDU duty and tax for the order in base currency","format":"double"},"availableToRefund":{"type":"number","description":"Available amount to refund for the order","format":"double","nullable":true},"availableToRefundBase":{"type":"number","description":"Available amount to refund for the order in base currency","format":"double"},"availableToRefundEdduDutyAndTax":{"type":"number","description":"Available EDDU duty and tax amount to refund for the order","format":"double"},"availableToRefundEdduDutyAndTaxBase":{"type":"number","description":"Available EDDU duty and tax amount to refund for the order in base currency","format":"double"}},"additionalProperties":false,"description":"Order refund response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderReplacementReasonCode":{"enum":\["LostPackage","DamagedGoods","ShortShip","LostReturn","IncorrectSize","IncorrectProduct","ProductNotAsExpected","ShopperRemorse"],"type":"string","description":"Order Replacement Reason Code"},"OrderReplacementRequest":{"required":\["actionedBy","exchange","items","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemReplacement"},"description":"The Line Items to exchange"},"reasonCode":{"$ref":"#/components/schemas/OrderReplacementReasonCode"},"exchange":{"type":"boolean","description":"Indicates whether return of the items is required.","example":true},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderReplacementRequest"},"OrderReplacementsResponse":{"type":"object","properties":{"number":{"type":"integer","description":"Number","format":"int64"},"date":{"type":"string","description":"Date","format":"date-time"},"refund":{"type":"number","description":"Refund","format":"double"},"replacedOrRefundedArticles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServiceOrderArticleDto"},"description":"ReplacedOrRefundedArticles","nullable":true},"replacementArticles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServiceOrderArticleDto"},"description":"ReplacementArticles","nullable":true},"shippingAddress":{"$ref":"#/components/schemas/OrderAddressDto"}},"additionalProperties":false,"description":"Order replacements response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderSearch":{"type":"object","properties":{"limit":{"type":"integer","description":"Gets or sets the maximum number of orders to return.","format":"int32"},"offset":{"type":"integer","description":"Gets or sets the number of orders to skip before starting to return results.","format":"int32"},"orderSearchFilters":{"$ref":"#/components/schemas/OrderSearchFilters"}},"additionalProperties":false,"description":"Request to search for orders with specified filters, limit, and offset."},"OrderSearchFilters":{"type":"object","properties":{"orderNumbers":{"type":"array","items":{"type":"string"},"description":"Gets or sets the list of order numbers to filter by.","nullable":true},"email":{"type":"string","description":"Gets or sets the shopper email to filter by.","nullable":true},"name":{"type":"string","description":"Gets or sets the shopper full name to filter by. ex: John Doe","nullable":true},"fromDate":{"type":"string","description":"Gets or sets the start date-time (UTC) of the search window.","format":"date-time","nullable":true},"toDate":{"type":"string","description":"Gets or sets the end date-time (UTC) of the search window.","format":"date-time","nullable":true},"orderDeliveryType":{"type":"string","description":"Gets or sets the order delivery type to filter by.","nullable":true},"orderStatus":{"type":"string","description":"Gets or sets the order status to filter by.","nullable":true},"country":{"type":"string","description":"Gets or sets the ISO country code to filter by.","nullable":true}},"additionalProperties":false,"description":"Represents strongly-typed filters for searching orders."},"OrderSearchPaginatedResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderSearchResponse"},"description":"Gets or sets the collection of order search response data.","nullable":true}},"additionalProperties":false,"description":"Represents a paginated response for an order search, including pagination details and the result data."},"OrderSearchResponse":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Gets or sets the order number.","nullable":true},"name":{"type":"string","description":"Gets or sets the name associated with the order.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address associated with the order.","nullable":true},"total":{"type":"number","description":"Gets or sets the total amount for the order.","format":"double"},"orderedAt":{"type":"string","description":"Gets or sets the date and time when the order was created.","format":"date-time"}},"additionalProperties":false,"description":"Represents the response data for an order search."},"OrderStatuses":{"enum":\["Received","Cancelled"],"type":"string","description":"Order statuses."},"OrderTransactionApiResponse":{"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction.\r\nIf the retailer sends this data, eSW will honor it. If the retailer does not send this data, eSW will generate the GUID for the transaction.","format":"uuid","example":"46874510-DE4C-4748-A74C-97C54AFB4270"}},"additionalProperties":false,"description":"Response from Order API"},"OrderTransactionType":{"enum":\["OrderCancel","LineItemCancel","OrderAppeasementMerchandise","OrderAppeasementShipping","LineItemAppeasement","LineItemReplacement","Return","BlindReturn","Appeasement","ShippedMerchandise","OrderCreate","OrderRefund","OrderAddressUpdate","LineItemUpdate","LineItemAdd","OrderReplacement","CSPCancel","CSPRefund","OrderPaymentSettled","RefundPaymentProcessed","TransactionSettled","CSPLineItemCancel","ForcedRefund","PaymentDetailsCollected","RefundApprovedAndValidated","UnShippedMerchandise","HoldStatusUpdate","LineItemFulfil","PackageUpdate","OrderAllocated","OrderPartiallyAllocated","PaymentPreAuthReversed","OrderAppeasement"],"type":"string"},"OrderType":{"enum":\["Offline","Checkout","NonCheckoutEcommerce"],"type":"string","description":"OrderType"},"OriginDetails":{"required":\["address1","city","country","email","originType"],"type":"object","properties":{"originType":{"$ref":"#/components/schemas/OriginType"},"firstName":{"type":"string","description":"First name of the address.","nullable":true,"example":"John "},"lastName":{"type":"string","description":"Last name of the address.","nullable":true,"example":"Smith"},"telephone":{"type":"string","description":"Phone number.","nullable":true,"example":"+14211112222"},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true,"example":"NickName"},"addressId":{"type":"string","description":"Address Identifier","nullable":true,"example":"AD12345"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true,"example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address.","example":"US"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true,"example":""}},"additionalProperties":false,"description":"Origin Details"},"OriginType":{"enum":\["None","Store"],"type":"string","description":"Payment methods"},"Pagination":{"type":"object","properties":{"limit":{"type":"integer","description":"Gets or sets the maximum number of items to return.","format":"int32"},"offset":{"type":"integer","description":"Gets or sets the number of items to skip before starting to collect the result set.","format":"int32"},"count":{"type":"integer","description":"Gets or sets the total number of items available.","format":"int32"}},"additionalProperties":false,"description":"Represents pagination information for a collection of items."},"Payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method used","nullable":true,"example":"ApplePay"},"last4Digits":{"type":"string","description":"Last 4 digits of the payment card","nullable":true,"example":"1234"},"paymentAttemptRef":{"type":"string","description":"Payment attempt reference","format":"uuid","nullable":true,"example":"1CBA8F0C-F7EE-437C-A450-B63ADD08CA5A"},"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"deliveryPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"retailerPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"retailerDeliveryPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"paymentStatus":{"type":"string","description":"Payment Status","nullable":true},"merchantPaymentId":{"type":"string","description":"Merchant Payment Id","nullable":true},"paymentTime":{"type":"string","description":"The time when the payment was taken","format":"date-time"},"preAuthExpiryTime":{"type":"string","description":"The datetime when we can kick off the capture process for the payment","format":"date-time"},"authResult":{"type":"string","description":"Auth result of the payment","nullable":true}},"additionalProperties":false,"description":"Payment details"},"Price":{"required":\["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Amount to credit eSW or debit eSW","format":"double"},"currency":{"minLength":1,"type":"string","description":"ISO representation for currency of transaction amount.","example":"USD"}},"additionalProperties":false,"description":""},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"Product":{"required":\["description","productCode","title"],"type":"object","properties":{"title":{"minLength":1,"type":"string","description":"Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.","example":"Black dress"},"description":{"minLength":1,"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","example":"Long black dress"},"customsDescription":{"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","nullable":true,"example":"Long black dress"},"prohibitedItem":{"type":"boolean","description":"Indicates whether the item is prohibited"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product.","example":"123456"},"hsCode":{"type":"string","description":"HsCode.","nullable":true,"example":"123456"},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true,"example":"CN"},"imageUrl":{"type":"string","description":"Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.","nullable":true,"example":"<https://url.com/test.png"},"color":{"type":"string","description":"Color> of the item.","nullable":true,"example":"black"},"size":{"type":"string","description":"Size of the item.","nullable":true,"example":"38"},"isReturnProhibited":{"type":"boolean","description":"Indicates whether the item is returnable or not under the regular return policy. The values are True or False.","nullable":true,"example":false},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":20},"taxCode":{"type":"string","description":"Tax code","nullable":true,"example":"XY234"}},"additionalProperties":false,"description":"Product"},"ProductCreate":{"required":\["description","productCode","productUnitPriceInfo","title"],"type":"object","properties":{"title":{"minLength":1,"type":"string","description":"Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.","example":"Black dress"},"description":{"minLength":1,"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","example":"Long black dress"},"customsDescription":{"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","nullable":true,"example":"Long black dress"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product.","example":"123456"},"hsCode":{"type":"string","description":"HsCode.","nullable":true,"example":"123456"},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true,"example":"CN"},"imageUrl":{"type":"string","description":"Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.","nullable":true,"example":"<https://url.com/test.png"},"color":{"type":"string","description":"Color> of the item.","nullable":true,"example":"black"},"size":{"type":"string","description":"Size of the item.","nullable":true,"example":"38"},"productUnitPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"wholesalePriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"weightInfo":{"$ref":"#/components/schemas/WeightInfo"},"isReturnProhibited":{"type":"boolean","description":"Indicates whether the item is returnable or not under the regular return policy. The values are True or False.","nullable":true,"example":false},"isCustomized":{"type":"boolean","description":"Indicates whether the item is customized or not. The values are True or False.","example":false}},"additionalProperties":false,"description":"Product"},"RefundOrderGroupOrderDetail":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Order number","nullable":true}},"additionalProperties":false,"description":"OrderGroupRequest"},"RefundOrderGroupRequest":{"type":"object","properties":{"orderGroupName":{"type":"string","description":"OrderGroupName","nullable":true},"orderDetails":{"type":"array","items":{"$ref":"#/components/schemas/RefundOrderGroupOrderDetail"},"description":"Orders Details","nullable":true},"correlationId":{"type":"string","description":"CorrelationId","nullable":true},"refundReason":{"type":"string","description":"Refund Reason","nullable":true},"refundReasonId":{"type":"integer","description":"Refund Reason","format":"int32"},"refundReference":{"type":"string","description":"Refund Reference","nullable":true},"refundAmountInLocalCurrency":{"type":"number","description":"Refund Amount","format":"double"},"refundType":{"type":"string","description":"Refund Type","nullable":true},"createdBy":{"type":"string","description":"Created By","nullable":true},"entityType":{"type":"string","description":"Entity Type","nullable":true},"isFullRefund":{"type":"boolean","description":"Is Full Refund"}},"additionalProperties":false,"description":"OrderGroupRequest"},"ReplaceOrderItemsReasonCode":{"enum":\["LostPackage","DamagedGoods","ShortShip","LostReturn"],"type":"string","description":"Replace Order Reason Code"},"ReplacementOrderDetails":{"required":\["replacementBrandOrderReference","replacementLineItemId"],"type":"object","properties":{"replacementBrandOrderReference":{"minLength":1,"type":"string","description":"Retailer's unique reference number for the replacement order,","example":"653241"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’","example":"1"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true,"example":"277906"},"name":{"type":"string","description":"The name of the product.","nullable":true,"example":"PINK LOUNGE WOMENS KNIT"},"description":{"type":"string","description":"The description of the product.\r\n Example: ‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’","nullable":true,"example":"‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’"},"colour":{"type":"string","description":"The colour of the product","nullable":true,"example":"Red"},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true,"example":"S"}},"additionalProperties":false,"description":"Product"},"ResendEmailDto":{"type":"object","properties":{"orderId":{"type":"string","description":"OrderId","nullable":true},"emailId":{"type":"string","description":"Email Identifier","nullable":true}},"additionalProperties":false,"description":"Resend Email Dto"},"ResendEmailResponse":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Error Message","nullable":true},"statusCode":{"$ref":"#/components/schemas/HttpStatusCode"}},"additionalProperties":false,"description":"Resend Email Response"},"RetailerInvoice":{"type":"object","properties":{"number":{"type":"string","description":"RetailerInvoice number","nullable":true,"example":"784512"},"date":{"type":"string","description":"RetailerInvoice Date in the yyyy-MM-dd format","nullable":true,"example":"2020-05-11"}},"additionalProperties":false,"description":"RetailerInvoice details"},"ServiceLevel":{"enum":\["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."},"ShopperExperience":{"required":\["shopperCultureLanguageIso"],"type":"object","properties":{"shopperCultureLanguageIso":{"minLength":1,"type":"string","description":"Preferred language and culture experience for the shopper in the ISO 639-1 and ISO 3166 format.","example":"en-IE"},"registeredProfileId":{"type":"string","description":"Customer profile Id or number","nullable":true,"example":"44170"}},"additionalProperties":false,"description":"Shopper Experience"},"Transaction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"reasonCode":{"type":"string","description":"Reason","nullable":true,"example":"LostPackage"},"lastUpdateTime":{"type":"string","description":"LastUpdateTime","format":"date-time","nullable":true},"creationTime":{"type":"string","description":"CreationTime","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Transaction details"},"TransactionStatus":{"enum":\["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"},"UpdateContactDetail":{"required":\["address1","city","contactDetailsType","email","postalCode","telephone"],"type":"object","properties":{"contactDetailsType":{"$ref":"#/components/schemas/UpdateContactDetailsType"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"minLength":1,"type":"string","description":"Postal code or zip code of the address.","example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"telephone":{"minLength":1,"type":"string","description":"Phone number.","example":"+14211112222"}},"additionalProperties":false,"description":"Update Contact Details"},"UpdateContactDetailsType":{"enum":\["IsDelivery"],"type":"string","description":"ContactDetailsType"},"UpdateLineItemReasonCode":{"enum":\["ProductSubstituted","ProductDiscontinued","ProductNotAvailable"],"type":"string","description":"Update Line Item Reason Code"},"UpdateOrderContacts":{"required":\["actionedBy","contactDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"contactDetails":{"$ref":"#/components/schemas/UpdateContactDetail"}},"additionalProperties":false,"description":"Update Contact details like address info."},"WeightInfo":{"type":"object","properties":{"weightTotal":{"type":"number","description":"Total weight of the order.","format":"double"},"weightUnit":{"$ref":"#/components/schemas/WeightUnit"}},"additionalProperties":false,"description":"(Required) Attributes that describe the package weight data."},"WeightUnit":{"enum":\["KG","LB"],"type":"string","description":"Unit of measurement for the items in the package. 0 indicates KG and 1 indicates LB."}},"endpoints":\[{"method":"POST","path":"/v2/{tenantCode}/Order","summary":"Creates an order.","pathParams":\[{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderCreate"}},{"method":"PUT","path":"/v2/{tenantCode}/Order/{brandOrderReference}/ContactDetails","summary":"Update Order Contact details","pathParams":\[{"name":"brandOrderReference","required":true,"description":""},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/UpdateOrderContacts"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/OrderActivity","summary":"Cancels the entire order, that is, all line items in the ord","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order"},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderActivityRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItemActivity","summary":"Cancels or fulfils the line items fully or partially in an o","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemActivityRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItem","summary":"Creates a full or partial line item replacement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemRequest"}},{"method":"PATCH","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItem","summary":"Updates a Line Item within an order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemUpdateRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Appeasement","summary":"Adds an order level appeasement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderAppeasementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItemAppeasement","summary":"Adds an item level appeasement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemAppeasementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Replacement","summary":"Replaces Line Items within an Order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderReplacementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Allocation","summary":"Allocates an Order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderAllocationRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Comment","summary":"Add a comment to an order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":""},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/AddOrderCommentRequestDto"}}]}" specUrl="<https://order-transaction-api.sandbox.eshopworld.com/swagger/v2/swagger.json>" epIdx="0" method="POST" path="/v2/{tenantCode}/Order" title="Creates an order." %}

</details>

<pre class="language-json" data-expandable="true"><code class="lang-json"><strong>curl -X POST "https://&#x3C;your-host>/v2/TENANT_01/Order" \
</strong>  -H "Authorization: Bearer &#x3C;JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "brandOrderReference": "BR-10001",
    "orderType": "Checkout",
    "transactionReference": "C857B3CD-5EB7-426D-8741-812E5ED214C0",
    "transactionDateTime": "2026-03-14T15:00:00Z",
    "actionedBy": "Retailer",
    "shopperCurrencyIso": "EUR",
    "retailerCurrencyIso": "USD",
    "deliveryCountryIso": "IE",
    "shopperExperience": {
      "shopperCultureLanguageIso": "en-IE"
    },
    "contactDetails": [
      {
        "contactDetailsType": "IsDelivery",
        "firstName": "John",
        "lastName": "Smith",
        "address1": "123 Main Street",
        "city": "Dublin",
        "country": "IE",
        "email": "john@example.com",
        "telephone": "+35312345678"
      }
    ],
    "lineItems": [
      {
        "lineItemId": "1",
        "quantity": 1,
        "product": {
          "productCode": "SKU-10001"
        }
      }
    ],
    "deliveryOption": {
      "eshopDeliveryOptionCode": "Standard",
      "priceInfo": {
        "price": {
          "amount": 10.0,
          "currency": "EUR"
        }
      }
    }
  }'
</code></pre>

***

## Customer Service

Retrieve an order successfully with:

```http
GET /v2/{tenantCode}/Order/{brandOrderReference}
```

#### First successful request

```json
curl -X GET "https://<your-host>/v2/TENANT_01/Order/BR-10001" \
  -H "Authorization: Bearer <JWT>" \
  -H "Accept: application/json"
```

#### Why this is the right first request

This is the easiest support-facing proof that the order exists and can be inspected. The response includes order-level details such as delivery option, payment, retailer invoice, origin details, transactions, balances, and metadata.

{% code title="BASE URL" expandable="true" %}

```bash
https://order-transaction-api.sandbox.eshopworld.com
```

{% endcode %}

#### Path Parameters

| Name                  | Type     | Description                                                                                                              |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `brandOrderReference` | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Retailer's unique reference number for the order.</p> |
| `tenantCode`          | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Tenant code for the retailer integration.</p>         |

{% tabs %}
{% tab title="Try it" %}
{% @code-walkthrough/try-it specLoaded="" specEps="" method="GET" path="/v2/{tenantCode}/Order/{brandOrderReference}" baseUrl="<https://api.example.com>" title="Retrieves an order." defaults="{"path":{"brandOrderReference":"","tenantCode":""},"query":{},"headers":{"Content-Type":"application/json"}}" mode="closed" %}
{% endtab %}
{% endtabs %}

***

## Order Lifecycle / Fulfilment Operations Engineer

Perform the first successful full-order cancellation with:

```http
POST /v2/{tenantCode}/Order/{brandOrderReference}/OrderActivity
```

#### First successful request

{% code expandable="true" %}

```json
curl -X POST "https://<your-host>/v2/TENANT_01/Order/BR-10001/OrderActivity" \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "activityStatus": "Cancel",
    "reasonCode": "RetailerCancel",
    "transactionReference": "E857B3CD-5EB7-426D-8741-812E5ED214C2",
    "transactionDateTime": "2026-03-14T15:20:00Z",
    "actionedBy": "Retailer"
  }'
```

{% endcode %}

#### Why this is the right first request

`OrderActivityRequest` has a compact, explicit required set: `actionedBy`, `activityStatus`, `reasonCode`, `transactionDateTime`, and `transactionReference`. The order-level reason codes are `ShopperCancel`, `RetailerCancel`, and `Fraud`, while `ActivityStatus` supports `Cancel` and `Fulfil`.

{% code title="BASE URL" expandable="true" %}

```bash
https://order-transaction-api.sandbox.eshopworld.com
```

{% endcode %}

#### Path Parameters

| Name                  | Type     | Description                                                                                                              |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `brandOrderReference` | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Retailer's unique reference number for the order.</p> |
| `tenantCode`          | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Tenant code for the retailer integration.</p>         |

{% tabs %}
{% tab title="Try it" %}
{% @code-walkthrough/try-it specLoaded="" specEps="" method="POST" path="/v2/{tenantCode}/Order/{brandOrderReference}/OrderActivity" baseUrl="<https://api.example.com>" title="Cancels the entire order, that is, all line items in the ord" defaults="{"path":{"brandOrderReference":"","tenantCode":""},"query":{},"headers":{"Content-Type":"application/json"},"body":{"activityStatus":"Cancel","reasonCode":"ShopperCancel","settlementReference":"657100201","transactionReference":"C857B3CD-5EB7-426D-8741-812E5ED214C0","transactionDateTime":"2019-10-14T15:56:18.455Z","actionedBy":"Retailer","actionedByUser":"<johnsmith@test.com>"}}" mode="closed" %}
{% endtab %}
{% endtabs %}

<details>

<summary>Request Construction</summary>

{% @code-walkthrough/body-builder specIndex="{"defs":{"ActionedBy":{"enum":\["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"},"ActivityStatus":{"enum":\["Cancel","Fulfil"],"type":"string","description":"ActivityStatus"},"AddOrderCommentRequestDto":{"type":"object","properties":{"comment":{"type":"string","description":"Comment text","nullable":true},"user":{"type":"string","description":"User who added the comment (nullable, Nike won't use it)","nullable":true}},"additionalProperties":false,"description":"Request DTO for adding a comment to an order"},"AddOrderCommentResponse":{"type":"object","properties":{"user":{"type":"string","description":"User who added the comment","nullable":true},"time":{"type":"string","description":"Time when the comment was added","format":"date-time"}},"additionalProperties":false,"description":"Response after adding a comment to an order"},"AllocationActivityStatus":{"enum":\["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"},"AppeasementsReasonCode":{"enum":\["Appeasement","LostPackage","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"AppeasementsType":{"enum":\["Merchandise","Shipping","Order"],"type":"string","description":""},"ArticleAllocation":{"required":\["activityStatus","fulfilmentCountryIso"],"type":"object","properties":{"activityStatus":{"$ref":"#/components/schemas/AllocationActivityStatus"},"fulfilmentCountryIso":{"minLength":1,"type":"string","description":"Fulfilment country ISO"},"fulfilmentCentreId":{"type":"string","description":"Fulfilment centre Id","nullable":true},"reasonCode":{"$ref":"#/components/schemas/LineItemActivityReasonCode"}},"additionalProperties":false,"description":"Article allocation"},"ArticleAppeasementDetails":{"type":"object","properties":{"articleId":{"type":"string","description":"Article Id to be appeased","nullable":true},"reasonCode":{"$ref":"#/components/schemas/LineItemAppeasementReasonCode"},"amount":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false}},"additionalProperties":false,"description":"Article Appeasement Details"},"ArticleAppeasementRequest":{"required":\["actionedBy","transactionDateTime","transactionReference"],"type":"object","properties":{"articlesAppeasementDetails":{"type":"array","items":{"$ref":"#/components/schemas/ArticleAppeasementDetails"},"description":"The Ids of the articles to appease","nullable":true,"example":1},"referenceNumber":{"type":"string","description":"Reference Number","nullable":true},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Refund Line Item Dto"},"ContactDetail":{"required":\["address1","city","contactDetailsType","country","email","firstName","lastName","telephone"],"type":"object","properties":{"contactDetailsType":{"$ref":"#/components/schemas/ContactDetailsType"},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true,"example":"NickName"},"addressId":{"type":"string","description":"Address Identifier","nullable":true,"example":"AD12345"},"firstName":{"minLength":1,"type":"string","description":"First name of the address.","example":"John "},"lastName":{"minLength":1,"type":"string","description":"Last name of the address.","example":"Smith"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true,"example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address.","example":"US"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"telephone":{"minLength":1,"type":"string","description":"Phone number.","example":"+14211112222"},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true,"example":""}},"additionalProperties":false,"description":"Contact Details"},"ContactDetailsType":{"enum":\["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"},"CurrencyDetails":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Currency ISO code","nullable":true},"currencyExponent":{"type":"integer","description":"Currency exponent which indicates the number of decimal places used by the currency","format":"int32","nullable":true}},"additionalProperties":false,"description":"Currency details"},"CustomerServiceOrderArticleDto":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"OrderArticleId","format":"int64"},"itemSequence":{"type":"integer","description":"Item Sequence","format":"int32","nullable":true},"orderArticleStatus":{"type":"string","description":"OrderArticleStatus","nullable":true},"cancelStatusId":{"type":"integer","description":"CancelStatusId","format":"int32"},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"refundStatusId":{"type":"integer","description":"RefundStatus","format":"int32"},"returnListingId":{"type":"integer","description":"ReturnListingId","format":"int64","nullable":true},"returnReason":{"type":"string","description":"ReturnReason","nullable":true},"replacementOfArticleId":{"type":"integer","description":"ReplacementOfArticle","format":"int64","nullable":true},"replaced":{"type":"boolean","description":"Replaced","nullable":true},"shipped":{"type":"boolean","description":"Shipped"},"allocated":{"type":"boolean","description":"Allocated"},"isCancellable":{"type":"boolean","description":"IsCancellable"},"unitPrice":{"type":"number","description":"UnitPrice","format":"double"},"unitPriceBase":{"type":"number","description":"UnitPriceBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"actualPrice":{"type":"number","description":"ActualPrice","format":"double"},"actualPriceBase":{"type":"number","description":"ActualPriceBase","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double"},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"vat":{"type":"number","description":"Vat","format":"double"},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"salesTax":{"type":"number","description":"SalesTax","format":"double"},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsFee":{"type":"number","description":"CustomsFee","format":"double"},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double"},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double"},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"productDiscountedAmount":{"type":"number","description":"ProductDiscountedAmount","format":"double","nullable":true},"shippingDiscountedAmount":{"type":"number","description":"ShippingDiscountedAmount","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"productColourCode":{"type":"string","description":"ProductColourCode","nullable":true},"productSizeCode":{"type":"string","description":"ProductSizeCode","nullable":true},"productColourDesc":{"type":"string","description":"ProductColourDesc","nullable":true},"styleNumber":{"type":"string","description":"StyleNumber","nullable":true},"sku":{"type":"string","description":"Sku","nullable":true},"orderProduct":{"$ref":"#/components/schemas/CustomerServiceOrderProductDto"},"statusSummary":{"$ref":"#/components/schemas/OrderArticleStatusSummaryDto"},"refund":{"$ref":"#/components/schemas/OrderArticleRefundDto"},"refundReturn":{"$ref":"#/components/schemas/OrderArticleRefundDto"},"proRataRefund":{"$ref":"#/components/schemas/OrderArticleRefundDetailDto"},"returnListing":{"$ref":"#/components/schemas/CustomerServiceReturnListingDto"}},"additionalProperties":false,"description":"Customer Service Order Article Dto"},"CustomerServiceOrderProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"ProductCode","nullable":true},"shortDescription":{"type":"string","description":"ShortDescription","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"customsDescription":{"type":"string","description":"CustomsDescription","nullable":true},"category":{"type":"string","description":"Category","nullable":true},"productColourCode":{"type":"string","description":"ProductColourCode","nullable":true},"productSizeCode":{"type":"string","description":"ProductSizeCode","nullable":true},"productColourDesc":{"type":"string","description":"ProductColourDesc","nullable":true},"styleNumber":{"type":"string","description":"StyleNumber","nullable":true},"sku":{"type":"string","description":"Sku","nullable":true}},"additionalProperties":false,"description":"Customer Service Order Product"},"CustomerServiceOrderProductDto":{"type":"object","properties":{"productCode":{"type":"string","description":"ProductCode","nullable":true},"shortDescription":{"type":"string","description":"ShortDescription","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"customsDescription":{"type":"string","description":"CustomsDescription","nullable":true},"category":{"type":"string","description":"Category","nullable":true}},"additionalProperties":false,"description":"Customer Service Order Product"},"CustomerServicePaymentActivity":{"type":"object","properties":{"date":{"type":"string","description":"Date","format":"date-time"},"amount":{"type":"number","description":"Amount","format":"double"},"amountBase":{"type":"number","description":"AmountBase","format":"double"},"event":{"type":"string","description":"Event","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"attemptRef":{"type":"string","description":"AttemptRef","nullable":true}},"additionalProperties":false,"description":"Customer service payment activity"},"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"},"DeliveryOption":{"required":\["eshopDeliveryOptionCode"],"type":"object","properties":{"eshopDeliveryOptionCode":{"$ref":"#/components/schemas/ServiceLevel"},"estimatedDeliveryDateToShopper":{"type":"string","description":"Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":21}},"additionalProperties":false,"description":"Delivery Option"},"DeliveryOptionCreate":{"required":\["eshopDeliveryOptionCode","priceInfo"],"type":"object","properties":{"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"type":{"$ref":"#/components/schemas/DeliveryTypeOms"},"eshopDeliveryOptionCode":{"$ref":"#/components/schemas/ServiceLevel"},"estimatedDeliveryDateToShopper":{"type":"string","description":"Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":21}},"additionalProperties":false,"description":"Delivery Option"},"DeliveryTypeOms":{"enum":\["NA","Home","Store","PUDO","Digital"],"type":"string","description":"DeliveryTypeOms"},"EmailLabel":{"type":"object","properties":{"id":{"type":"string","description":"Label Identifier","format":"uuid"},"hasAttachment":{"type":"boolean","description":"HasAttachment"},"data":{"type":"string","description":"Data","nullable":true},"dataUrl":{"type":"string","description":"Data URL","nullable":true}},"additionalProperties":false,"description":"Label information associated to the email details"},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error Identifier code","format":"int32","example":1},"message":{"type":"string","description":"Error Message","nullable":true,"example":"Invalid BrandOrderReference"}},"additionalProperties":false,"description":"Error Response"},"ErrorStatus":{"enum":\["Retry","Processed","Failed","InProgress"],"type":"string","description":"Represents Order Migration/Integration event error status"},"ErrorType":{"enum":\["Migration","Integration","RecalculateAllocation","NonCheckOutOrderCreate","PaymentAttempt","NonCheckoutOrder","PaymentAggregate"],"type":"string","description":"Enumeration for error types to log the error for reprocessing"},"FailedEventRequest":{"type":"object","properties":{"tenantCode":{"type":"string","description":"TenantCode","nullable":true},"errorType":{"$ref":"#/components/schemas/ErrorType"},"batchSize":{"type":"integer","description":"BatchSize","format":"int32"},"retryCount":{"type":"integer","description":"RetryCount","format":"int32"},"errorStatus":{"$ref":"#/components/schemas/ErrorStatus"}},"additionalProperties":false,"description":"FailedEventRequest"},"FailedEventsHandlerResponse":{"type":"object","properties":{"httpStatusCode":{"$ref":"#/components/schemas/HttpStatusCode"},"failedCount":{"type":"integer","description":"","format":"int32"},"successCount":{"type":"integer","description":"","format":"int32"},"totalCount":{"type":"integer","description":"","format":"int32"},"failedIds":{"type":"array","items":{"type":"string"},"description":"","nullable":true}},"additionalProperties":false,"description":"FailedEventsHandlerResponse"},"FinTransDetails":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","nullable":true},"type":{"type":"string","description":"Type","nullable":true},"amount":{"type":"number","description":"Amount","format":"double"},"amountBase":{"type":"number","description":"Amount Base","format":"double"},"status":{"type":"string","description":"Status","nullable":true},"response":{"type":"string","description":"Response","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"transactionType":{"type":"string","description":"Transaction Type","nullable":true},"creationTime":{"type":"string","description":"Creation Time","format":"date-time","nullable":true},"reason":{"type":"string","description":"Reason","nullable":true},"paymentDetailCollectionStatus":{"type":"integer","description":"Payment Detail Collection Status","format":"int32"},"isOfflineRefundEnabled":{"type":"boolean","description":"Is Offline Refund Enabled"},"offlineRefundTooltip":{"type":"string","description":"Offline Refund Tooltip","nullable":true}},"additionalProperties":false,"description":"Financial Transactions Details"},"Gender":{"enum":\["None","Male","Female","Unisex"],"type":"string","description":"Gender"},"GetOrderDetailsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","nullable":true},"orderGuid":{"type":"string","description":"Order Guid","format":"uuid","nullable":true},"eShopOrderReference":{"type":"string","description":"E-Shop Order Reference","nullable":true},"brandOrderReference":{"type":"string","description":"Brand order reference","nullable":true},"brandId":{"type":"integer","description":"Brand identifier","format":"int32"},"brandCode":{"type":"string","description":"Brand code","nullable":true},"brandName":{"type":"string","description":"Brand name","nullable":true},"tenantCode":{"type":"string","description":"Tenant code","nullable":true},"creationTime":{"type":"string","description":"Creation time of the order","format":"date-time"},"orderStatus":{"type":"string","description":"Status of the order","nullable":true},"orderHoldStatus":{"type":"string","description":"Order hold status","nullable":true},"paymentId":{"type":"string","description":"Payment identifier","nullable":true},"orderType":{"type":"string","description":"Order type","nullable":true},"balance":{"$ref":"#/components/schemas/OrderBalanceResponse"},"isCancellable":{"type":"boolean","description":"Is the order cancellable"},"isLineItemCancellable":{"type":"boolean","description":"Is the line item cancellable"},"orderAllocated":{"type":"boolean","description":"Is the order allocated","nullable":true},"allocationMethod":{"type":"string","description":"Allocation method of the order","nullable":true},"serviceLevel":{"type":"string","description":"Service level of the order","nullable":true},"refund":{"$ref":"#/components/schemas/OrderRefundResponse"},"proRataRefund":{"$ref":"#/components/schemas/OrderProRataRefundResponse"},"estimatedDelivery":{"$ref":"#/components/schemas/OrderEstimatedDeliveryResponse"},"deliveryAddress":{"$ref":"#/components/schemas/OrderAddressResponse"},"paymentAddress":{"$ref":"#/components/schemas/OrderAddressResponse"},"orderCharge":{"$ref":"#/components/schemas/OrderChargeResponse"},"payment":{"$ref":"#/components/schemas/OrderPaymentResponse"},"currencies":{"$ref":"#/components/schemas/OrderCurrenciesResponse"},"orderArticles":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticlesResponse"},"description":"Order article details","nullable":true},"replacements":{"type":"array","items":{"$ref":"#/components/schemas/OrderReplacementsResponse"},"description":"Order replacements details","nullable":true},"isRefundProcessExternal":{"type":"boolean","description":"Is the refund process handled by external system"},"isRefundCreationExternal":{"type":"boolean","description":"Is the refund creation handled by external system"},"canAllowNonCheckOutRefund":{"type":"boolean","description":"Can allow non-checkout refund"},"deliveryType":{"type":"string","description":"Delivery type of the order","nullable":true}},"additionalProperties":false,"description":"Get Order details response"},"GetTransaction":{"type":"object","properties":{"refundAmounts":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of refund amounts.","nullable":true},"refundAmountsInRetailerCurrency":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of refund amounts.","nullable":true},"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"reasonCode":{"type":"string","description":"Reason","nullable":true,"example":"LostPackage"},"lastUpdateTime":{"type":"string","description":"LastUpdateTime","format":"date-time","nullable":true},"creationTime":{"type":"string","description":"CreationTime","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Get Full Transaction Details which includes refund amount"},"HttpStatusCode":{"enum":\["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","UseProxy","Unused","RedirectKeepVerb","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"LineItemActivityReasonCode":{"enum":\["OutOfStock","ShopperCancel","ItemFulfilled"],"type":"string","description":"Order Activity Reason Code"},"LineItemActivityRequest":{"required":\["actionedBy","activityStatus","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"The Id of the line item to cancel. Either lineItemId or product code is required.","nullable":true,"example":"1"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item. Either lineItemId or product code is required.","nullable":true,"example":"241563"},"quantity":{"type":"integer","description":"Quantity of products to cancel.","format":"int32","example":2},"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"reasonCode":{"$ref":"#/components/schemas/LineItemActivityReasonCode"},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"LineItemActivityRequest"},"LineItemAppeasementReasonCode":{"enum":\["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"LineItemAppeasementRequest":{"required":\["actionedBy","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"The Id of the line item to appease. Either lineItemId or product code is required.","nullable":true,"example":"1"},"productCode":{"type":"string","description":"Product code. Either lineItemId or productId is required.\r\n Example: ‘277906’","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to appease","format":"int32","example":2},"reasonCode":{"$ref":"#/components/schemas/LineItemAppeasementReasonCode"},"transaction":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"LineItemAppeasementRequest"},"LineItemRequest":{"required":\["actionedBy","quantity","reasonCode","replacementOrderDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true,"example":"2"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32","example":2},"reasonCode":{"$ref":"#/components/schemas/ReplaceOrderItemsReasonCode"},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"LineItemUpdateRequest":{"required":\["actionedBy","lineItemId","productCode","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item to be updated.","example":"2"},"quantity":{"type":"integer","description":"Quantity to be updated.","format":"int32","example":2},"productCode":{"minLength":1,"type":"string","description":"New product code or stock-keeping unit (SKU) number of the item.","example":"277906"},"reasonCode":{"$ref":"#/components/schemas/UpdateLineItemReasonCode"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Update line items request"},"LineItemsAddRequest":{"required":\["actionedBy","contactDetails","deliveryCountryIso","deliveryOption","lineItems","orderType","retailerCurrencyIso","shopperCurrencyIso","shopperExperience","transactionDateTime","transactionReference"],"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"P12345"},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true,"example":"987456"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","example":"EUR"},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","example":"USD"},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","example":"IE"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemToCreate"},"description":"Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required."},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOptionCreate"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"payment":{"$ref":"#/components/schemas/Payment"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true},"channelType":{"type":"string","description":"Channel Type","nullable":true}},"additionalProperties":false,"description":"Add line items request"},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true,"example":"KeyName"},"value":{"type":"string","description":"Metadata value.","nullable":true,"example":"KeyValue"}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true,"example":"EUR"},"amount":{"type":"string","description":"The amount of the currency.","nullable":true,"example":"100.00"}},"additionalProperties":false,"description":"Money"},"NamedMoney":{"required":\["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge.","example":"ItemTaxes"},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Order":{"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"orderGuid":{"type":"string","description":"Order GUID.","format":"uuid","example":"b785ef18-046e-471c-8470-727c7db0ce6e"},"status":{"$ref":"#/components/schemas/OrderStatuses"},"brandOrderReference":{"type":"string","description":"The brand's order number.","nullable":true,"example":"78451296"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"3265987"},"eShopWorldOrderNumber":{"type":"string","description":"Order number in the eshopWorld system.","nullable":true,"example":"5001007400857"},"shopperCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","nullable":true,"example":"EUR"},"retailerCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","nullable":true,"example":"USD"},"deliveryCountryIso":{"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","nullable":true,"example":"IE"},"orderDate":{"type":"string","description":"The datetime when the order was created, in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"weight":{"$ref":"#/components/schemas/WeightInfo"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details.","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"Attributes that describe the items in the cart.","nullable":true},"orderCharges":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"<summary>A list of order level charges.</summary>","nullable":true},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOption"},"payment":{"$ref":"#/components/schemas/Payment"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"description":"Transactions","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs","nullable":true},"orderBalances":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of order balance charges","nullable":true}},"additionalProperties":false,"description":"Order"},"OrderActivityReasonCode":{"enum":\["ShopperCancel","RetailerCancel","Fraud"],"type":"string","description":"Order Activity Reason Code"},"OrderActivityRequest":{"required":\["actionedBy","activityStatus","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"reasonCode":{"$ref":"#/components/schemas/OrderActivityReasonCode"},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderActivityRequest"},"OrderAddressDto":{"type":"object","properties":{"nameAddressId":{"type":"integer","description":"Name Address Id","format":"int64"},"brandId":{"type":"integer","description":"Brand Id","format":"int32"},"firstName":{"type":"string","description":"First Name","nullable":true},"middleName":{"type":"string","description":"Middle Name","nullable":true},"lastName":{"type":"string","description":"Last Name","nullable":true},"name":{"type":"string","description":"First and Last names combined","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"telephone":{"type":"string","description":"Telephone","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City","nullable":true},"region":{"type":"string","description":"Region","nullable":true},"postalCode":{"type":"string","description":"Postal Code","nullable":true},"country":{"type":"string","description":"Country","nullable":true},"countryIso":{"type":"string","description":"Country ISO","nullable":true},"storeName":{"type":"string","description":"Store Name","nullable":true}},"additionalProperties":false,"description":"Package address information associated to an Order comming from Order Internal API"},"OrderAddressResponse":{"type":"object","properties":{"nameAddressId":{"type":"integer","description":"Name address identifier","format":"int64"},"brandId":{"type":"integer","description":"Brand identifier","format":"int32"},"firstName":{"type":"string","description":"First name of the contact","nullable":true},"middleName":{"type":"string","description":"Middle name of the contact","nullable":true},"lastName":{"type":"string","description":"Last name of the contact","nullable":true},"name":{"type":"string","description":"Name of the contact (contains first name and last name)","nullable":true},"email":{"type":"string","description":"Email address of the contact","nullable":true},"telephone":{"type":"string","description":"Telephone number of the contact","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City of the contact","nullable":true},"region":{"type":"string","description":"Region of the contact","nullable":true},"postalCode":{"type":"string","description":"Postal code of the contact","nullable":true},"country":{"type":"string","description":"Country of the contact","nullable":true},"countryIso":{"type":"string","description":"ISO code of the country","nullable":true},"storeName":{"type":"string","description":"Name of the store","nullable":true}},"additionalProperties":false,"description":"Order address response"},"OrderAllocationRequest":{"required":\["actionedBy","lineItems","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemAllocation"},"description":"The Line Items to allocate"},"allocationId":{"type":"string","description":"Allocation ID","nullable":true},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderAllocationRequest"},"OrderAppeasementRequest":{"required":\["actionedBy","reasonCode","transactionDateTime","transactionReference","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/AppeasementsType"},"reasonCode":{"$ref":"#/components/schemas/AppeasementsReasonCode"},"transaction":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set  for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":""},"OrderArticle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Article sequence within the line item","format":"int32","example":2},"status":{"$ref":"#/components/schemas/OrderArticleStatuses"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of item level charges.","nullable":true}},"additionalProperties":false,"description":"Order Article"},"OrderArticleRefund":{"type":"object","properties":{"useMerchandiseAmount":{"type":"boolean","description":"UseMerchandiseAmount"},"useDutyAmount":{"type":"boolean","description":"UseDutyAmount"},"useVatAmount":{"type":"boolean","description":"UseVatAmount"},"useSalesTaxAmount":{"type":"boolean","description":"UseSalesTaxAmount"},"useCustomsFeeAmount":{"type":"boolean","description":"UseCustomsFeeAmount"},"useShippingAmount":{"type":"boolean","description":"UseShippingAmount"},"dutyAndTax":{"type":"number","description":"DutyAndTax","format":"double"},"dutyAndTaxBase":{"type":"number","description":"DutyAndTaxBase","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"}},"additionalProperties":false,"description":"Order Article Refund"},"OrderArticleRefundDetail":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"Order Article identifier","format":"int64"},"articleRefundAmount":{"type":"number","description":"Article refund amount available","format":"double"},"articleShippingRefundAmount":{"type":"number","description":"Article shipping refund amount available","format":"double"},"refundAmountAvailable":{"type":"number","description":"Refund amount available for the article","format":"double"},"itemPendingCancel":{"type":"boolean","description":"Item pending cancel for the article"},"orderArticleStatusForRefund":{"type":"string","description":"Order article status for refund","nullable":true}},"additionalProperties":false,"description":"Order Article refund detail\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderArticleRefundDetailDto":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"Order Article identifier","format":"int64"},"articleRefundAmount":{"type":"number","description":"Article refund amount available","format":"double"},"articleShippingRefundAmount":{"type":"number","description":"Article shipping refund amount available","format":"double"},"refundAmountAvailable":{"type":"number","description":"Refund amount available for the article","format":"double"},"itemPendingCancel":{"type":"boolean","description":"Item pending cancel for the article"},"orderArticleStatusForRefund":{"type":"string","description":"Order article status for refund","nullable":true}},"additionalProperties":false,"description":"Order Article refund detail dto"},"OrderArticleRefundDto":{"type":"object","properties":{"useMerchandiseAmount":{"type":"boolean","description":"UseMerchandiseAmount"},"useDutyAmount":{"type":"boolean","description":"UseDutyAmount"},"useVatAmount":{"type":"boolean","description":"UseVatAmount"},"useSalesTaxAmount":{"type":"boolean","description":"UseSalesTaxAmount"},"useCustomsFeeAmount":{"type":"boolean","description":"UseCustomsFeeAmount"},"useShippingAmount":{"type":"boolean","description":"UseShippingAmount"},"dutyAndTax":{"type":"number","description":"DutyAndTax","format":"double"},"dutyAndTaxBase":{"type":"number","description":"DutyAndTaxBase","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"}},"additionalProperties":false,"description":"Order Article Refund"},"OrderArticleStatusSummary":{"type":"object","properties":{"standardStatus":{"type":"string","description":"StandardStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"replacedStatus":{"type":"string","description":"ReplacedStatus","nullable":true},"replacementStatus":{"type":"string","description":"ReplacementStatus","nullable":true}},"additionalProperties":false,"description":"Order Article Status Summary"},"OrderArticleStatusSummaryDto":{"type":"object","properties":{"standardStatus":{"type":"string","description":"StandardStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"replacedStatus":{"type":"string","description":"ReplacedStatus","nullable":true},"replacementStatus":{"type":"string","description":"ReplacementStatus","nullable":true}},"additionalProperties":false,"description":"Order Article Status Summary"},"OrderArticleStatuses":{"enum":\["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"},"OrderArticlesResponse":{"type":"object","properties":{"id":{"type":"string","description":"OrderArticleId","nullable":true},"lineItemId":{"type":"string","description":"Line Item Id","nullable":true},"status":{"type":"string","description":"OrderArticleStatus","nullable":true},"cancelStatus":{"type":"string","description":"CancelStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"refundStatus":{"type":"string","description":"RefundStatus","nullable":true},"returnListing":{"type":"string","description":"ReturnListingId","nullable":true},"returnReason":{"type":"string","description":"ReturnReason","nullable":true},"replacementOfArticle":{"type":"string","description":"ReplacementOfArticle","nullable":true},"replaced":{"type":"boolean","description":"Replaced","nullable":true},"shipped":{"type":"boolean","description":"Shipped"},"allocated":{"type":"boolean","description":"Allocated"},"isCancellable":{"type":"boolean","description":"IsCancellable"},"unitPrice":{"type":"number","description":"UnitPrice","format":"double"},"unitPriceBase":{"type":"number","description":"UnitPriceBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"actualPrice":{"type":"number","description":"ActualPrice","format":"double"},"actualPriceBase":{"type":"number","description":"ActualPriceBase","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double"},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"vat":{"type":"number","description":"Vat","format":"double"},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"salesTax":{"type":"number","description":"SalesTax","format":"double"},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsFee":{"type":"number","description":"CustomsFee","format":"double"},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double"},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double"},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"productDiscountedAmount":{"type":"number","description":"ProductDiscountedAmount","format":"double","nullable":true},"shippingDiscountedAmount":{"type":"number","description":"ShippingDiscountedAmount","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"orderProduct":{"$ref":"#/components/schemas/CustomerServiceOrderProduct"},"statusSummary":{"$ref":"#/components/schemas/OrderArticleStatusSummary"},"refund":{"$ref":"#/components/schemas/OrderArticleRefund"},"refundReturn":{"$ref":"#/components/schemas/OrderArticleRefund"},"proRataRefund":{"$ref":"#/components/schemas/OrderArticleRefundDetail"},"returnOrderNumber":{"type":"integer","description":"ReturnOrderNumber","format":"int64"}},"additionalProperties":false,"description":"Order articles response"},"OrderBalanceResponse":{"type":"object","properties":{"credits":{"type":"number","description":"Credits","format":"double","nullable":true},"debits":{"type":"number","description":"Debits","format":"double","nullable":true},"balance":{"type":"number","description":"Balance","format":"double","nullable":true},"nonRefundableBalance":{"type":"number","description":"Non-refundable balance","format":"double","nullable":true}},"additionalProperties":false,"description":"Order balance response"},"OrderChargeResponse":{"type":"object","properties":{"merchandise":{"type":"number","description":"Merchandise","format":"double","nullable":true},"merchandiseBase":{"type":"number","description":"MerchandiseBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"merchandiseLessDiscount":{"type":"number","description":"MerchandiseLessDiscount","format":"double","nullable":true},"merchandiseLessDiscountBase":{"type":"number","description":"MerchandiseLessDiscountBase","format":"double"},"vat":{"type":"number","description":"Vat","format":"double","nullable":true},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"customsFee":{"type":"number","description":"CustomsFee","format":"double","nullable":true},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"salesTax":{"type":"number","description":"SalesTax","format":"double","nullable":true},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double","nullable":true},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double","nullable":true},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"edduDutiesAndTaxes":{"type":"number","description":"EdduDutiesAndTaxes","format":"double"},"edduDutiesAndTaxesBase":{"type":"number","description":"EdduDutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double","nullable":true},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"total":{"type":"number","description":"Total","format":"double","nullable":true},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"brandJsonData":{"type":"string","description":"BrandJsonData","nullable":true},"displayModelId":{"type":"integer","description":"DisplayModelId","format":"int32","nullable":true},"brandCountryDisplayModelId":{"type":"integer","description":"BrandCountryDisplayModelId","format":"int32","nullable":true},"paymentMethodCharge":{"type":"number","description":"PaymentMethodCharge","format":"double","nullable":true},"paymentMethodChargeBase":{"type":"number","description":"PaymentMethodChargeBase","format":"double","nullable":true},"nonRefundableCharge":{"type":"number","description":"NonRefundableCharge","format":"double","nullable":true}},"additionalProperties":false,"description":"Order charge response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderCreate":{"required":\["actionedBy","brandOrderReference","contactDetails","deliveryCountryIso","deliveryOption","lineItems","orderType","retailerCurrencyIso","shopperCurrencyIso","shopperExperience","transactionDateTime","transactionReference"],"type":"object","properties":{"brandOrderReference":{"minLength":1,"type":"string","description":"The Brand's order number.","example":"12345"},"weight":{"$ref":"#/components/schemas/WeightInfo"},"orderType":{"$ref":"#/components/schemas/OrderType"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"P12345"},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true,"example":"987456"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","example":"EUR"},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","example":"USD"},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","example":"IE"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemToCreate"},"description":"Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required."},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOptionCreate"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"payment":{"$ref":"#/components/schemas/Payment"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true},"channelType":{"type":"string","description":"Channel Type","nullable":true}},"additionalProperties":false,"description":"Order create request"},"OrderCurrenciesResponse":{"type":"object","properties":{"shopper":{"$ref":"#/components/schemas/CurrencyDetails"},"retailer":{"$ref":"#/components/schemas/CurrencyDetails"}},"additionalProperties":false,"description":"Order currencies response"},"OrderEmailDetail":{"type":"object","properties":{"id":{"type":"string","description":"Email Identifier","nullable":true},"template":{"type":"string","description":"Template","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"lastUpdateTime":{"type":"string","description":"Last Update Time","format":"date-time"},"recipients":{"type":"array","items":{"type":"string"},"description":"Recipients","nullable":true},"label":{"$ref":"#/components/schemas/EmailLabel"}},"additionalProperties":false,"description":"Email information associated to an order"},"OrderEstimatedDeliveryResponse":{"type":"object","properties":{"minDays":{"type":"integer","description":"Minimum estimated delivery days for the order","format":"int32"},"maxDays":{"type":"integer","description":"Maximum estimated delivery days for the order","format":"int32"},"formatted":{"type":"string","description":"Formatted estimated delivery date range for the order","nullable":true}},"additionalProperties":false,"description":"Order estimated delivery response"},"OrderGroup":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the OrderGroup.","format":"uuid"},"orderGroupName":{"type":"string","description":"Name of the OrderGroup.","nullable":true},"orderNumbers":{"type":"array","items":{"type":"string"},"description":"IDs of orders included in this group.","nullable":true}},"additionalProperties":false,"description":"Entity for Order Group."},"OrderItem":{"required":\["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID.","example":"1"},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32","example":2},"estimatedDeliveryDateFromRetailer":{"type":"string","description":"Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"product":{"$ref":"#/components/schemas/Product"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticle"},"description":"List of articles with their statuses","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs","nullable":true}},"additionalProperties":false,"description":"Cart Items"},"OrderItemAllocation":{"required":\["articles","lineItemId","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item id","example":"1"},"quantity":{"type":"integer","description":"Quantity","format":"int32","example":1},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleAllocation"},"description":"Articles to allocate"}},"additionalProperties":false,"description":"Defines the model to be used when allocating a line item"},"OrderItemReplacement":{"required":\["quantity","replacementOrderDetails"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true,"example":"2"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32","example":2},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"OrderItemToCreate":{"required":\["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID.","example":"1"},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32","example":2},"estimatedDeliveryDateFromRetailer":{"type":"string","description":"Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"product":{"$ref":"#/components/schemas/ProductCreate"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true}},"additionalProperties":false,"description":"Cart Items"},"OrderPackage":{"type":"object","properties":{"packageId":{"type":"string","description":"Package Id","nullable":true},"packageStatus":{"type":"string","description":"Package Status","nullable":true},"brandPackageReference":{"type":"string","description":"Brand Package Reference","nullable":true},"eShopPackageReference":{"type":"string","description":"Eshop Package Reference","nullable":true},"carrier":{"type":"string","description":"Carrier","nullable":true},"serviceType":{"type":"string","description":"Service Type","nullable":true},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"weight":{"type":"number","description":"Weight","format":"float","nullable":true},"weightUnit":{"type":"string","description":"Weight Unit","nullable":true},"duty":{"type":"number","description":"Duty","format":"double"},"vat":{"type":"number","description":"VAT","format":"double"},"tax":{"type":"number","description":"Tax","format":"double"},"customsFee":{"type":"number","description":"Customs Fee","format":"double"},"shipping":{"type":"number","description":"Shipping","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"merch":{"type":"number","description":"Merch","format":"double"},"shippingAddress":{"$ref":"#/components/schemas/OrderPackageAddress"},"packageArticles":{"type":"array","items":{"$ref":"#/components/schemas/OrderPackageArticle"},"description":"Articles associated to the package","nullable":true}},"additionalProperties":false,"description":"Package information associated to an order"},"OrderPackageAddress":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name","nullable":true},"middleName":{"type":"string","description":"Middle Name","nullable":true},"lastName":{"type":"string","description":"Last Name","nullable":true},"name":{"type":"string","description":"First and Last names combined","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"telephone":{"type":"string","description":"Telephone","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City","nullable":true},"region":{"type":"string","description":"Region","nullable":true},"postalCode":{"type":"string","description":"Postal Code","nullable":true},"country":{"type":"string","description":"Country","nullable":true},"countryIso":{"type":"string","description":"Country ISO","nullable":true},"storeName":{"type":"string","description":"Store Name","nullable":true}},"additionalProperties":false,"description":"Address information for an order package"},"OrderPackageArticle":{"type":"object","properties":{"returnOrderNumber":{"type":"string","description":"Return Order Number","nullable":true},"sku":{"type":"string","description":"SKU","nullable":true},"description":{"type":"string","description":"Description","nullable":true}},"additionalProperties":false,"description":"Article associated to a package"},"OrderPaymentDetail":{"type":"object","properties":{"amount":{"type":"number","description":"Amount","format":"double"},"date":{"type":"string","description":"Date","format":"date-time"},"event":{"type":"string","description":"Event","nullable":true},"status":{"type":"string","description":"Statys","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"attemptRef":{"type":"string","description":"AttemptRef","format":"uuid"}},"additionalProperties":false,"description":"Order Payment Detail"},"OrderPaymentResponse":{"type":"object","properties":{"paymentId":{"type":"integer","description":"PaymentId","format":"int64","nullable":true},"paymentAttemptRef":{"type":"string","description":"PaymentAttemptRef","format":"uuid","nullable":true},"paymentProviderOrderId":{"type":"string","description":"PaymentProviderOrderId","nullable":true},"amount":{"type":"number","description":"Amount","format":"double"},"currencyCode":{"type":"string","description":"CurrencyCode","nullable":true},"statusId":{"type":"integer","description":"StatusId","format":"int32","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"methodId":{"type":"integer","description":"MethodId","format":"int32","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"legacyMethod":{"type":"string","description":"LegacyMethod","nullable":true},"adminFee":{"type":"number","description":"AdminFee","format":"double","nullable":true},"paymentTime":{"type":"string","description":"PaymentTime","format":"date-time","nullable":true},"expiryTime":{"type":"string","description":"ExpiryTime","format":"date-time","nullable":true},"edduToken":{"type":"string","description":"EdduToken","nullable":true},"provider":{"type":"string","description":"Provider","nullable":true},"paymentReference":{"type":"string","description":"PaymentReference","nullable":true},"preAuthorized":{"type":"boolean","description":"PreAuthorized","nullable":true},"settled":{"type":"boolean","description":"Settled","nullable":true},"isPreAuth":{"type":"boolean","description":"IsPreAuth"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServicePaymentActivity"},"description":"Activities","nullable":true},"last4Digits":{"type":"string","description":"Last4Digits","nullable":true},"masterPaymentIdentifier":{"type":"string","description":"MasterPaymentIdentifier","format":"uuid","nullable":true},"isSplitPayment":{"type":"boolean","description":"IsSplitPayment"},"isPaid":{"type":"boolean","description":"IsPaid"}},"additionalProperties":false,"description":"Order payment response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderProRataRefundResponse":{"type":"object","properties":{"orderId":{"type":"integer","description":"Order identifier","format":"int64"},"orderStatusForRefund":{"type":"string","nullable":true},"orderArticleRefundDetails":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticleRefundDetail"},"description":"Order Article refund details","nullable":true},"shippingAmountAvailable":{"type":"number","description":"Shipping amount available for refund","format":"double"},"fullOrderAmountAvailable":{"type":"number","description":"Full order amount available for refund","format":"double"}},"additionalProperties":false,"description":"Order Pro Rata Refund response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderRefundResponse":{"type":"object","properties":{"totalRefunded":{"type":"number","description":"Total refunded amount for the order","format":"double","nullable":true},"totalRefundedBase":{"type":"number","description":"Total refunded amount for the order in base currency","format":"double"},"totalRefundedEdduDutyAndTax":{"type":"number","description":"Total refunded EDDU duty and tax for the order","format":"double"},"totalRefundedEdduDutyAndTaxBase":{"type":"number","description":"Total refunded EDDU duty and tax for the order in base currency","format":"double"},"availableToRefund":{"type":"number","description":"Available amount to refund for the order","format":"double","nullable":true},"availableToRefundBase":{"type":"number","description":"Available amount to refund for the order in base currency","format":"double"},"availableToRefundEdduDutyAndTax":{"type":"number","description":"Available EDDU duty and tax amount to refund for the order","format":"double"},"availableToRefundEdduDutyAndTaxBase":{"type":"number","description":"Available EDDU duty and tax amount to refund for the order in base currency","format":"double"}},"additionalProperties":false,"description":"Order refund response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderReplacementReasonCode":{"enum":\["LostPackage","DamagedGoods","ShortShip","LostReturn","IncorrectSize","IncorrectProduct","ProductNotAsExpected","ShopperRemorse"],"type":"string","description":"Order Replacement Reason Code"},"OrderReplacementRequest":{"required":\["actionedBy","exchange","items","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemReplacement"},"description":"The Line Items to exchange"},"reasonCode":{"$ref":"#/components/schemas/OrderReplacementReasonCode"},"exchange":{"type":"boolean","description":"Indicates whether return of the items is required.","example":true},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderReplacementRequest"},"OrderReplacementsResponse":{"type":"object","properties":{"number":{"type":"integer","description":"Number","format":"int64"},"date":{"type":"string","description":"Date","format":"date-time"},"refund":{"type":"number","description":"Refund","format":"double"},"replacedOrRefundedArticles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServiceOrderArticleDto"},"description":"ReplacedOrRefundedArticles","nullable":true},"replacementArticles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServiceOrderArticleDto"},"description":"ReplacementArticles","nullable":true},"shippingAddress":{"$ref":"#/components/schemas/OrderAddressDto"}},"additionalProperties":false,"description":"Order replacements response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderSearch":{"type":"object","properties":{"limit":{"type":"integer","description":"Gets or sets the maximum number of orders to return.","format":"int32"},"offset":{"type":"integer","description":"Gets or sets the number of orders to skip before starting to return results.","format":"int32"},"orderSearchFilters":{"$ref":"#/components/schemas/OrderSearchFilters"}},"additionalProperties":false,"description":"Request to search for orders with specified filters, limit, and offset."},"OrderSearchFilters":{"type":"object","properties":{"orderNumbers":{"type":"array","items":{"type":"string"},"description":"Gets or sets the list of order numbers to filter by.","nullable":true},"email":{"type":"string","description":"Gets or sets the shopper email to filter by.","nullable":true},"name":{"type":"string","description":"Gets or sets the shopper full name to filter by. ex: John Doe","nullable":true},"fromDate":{"type":"string","description":"Gets or sets the start date-time (UTC) of the search window.","format":"date-time","nullable":true},"toDate":{"type":"string","description":"Gets or sets the end date-time (UTC) of the search window.","format":"date-time","nullable":true},"orderDeliveryType":{"type":"string","description":"Gets or sets the order delivery type to filter by.","nullable":true},"orderStatus":{"type":"string","description":"Gets or sets the order status to filter by.","nullable":true},"country":{"type":"string","description":"Gets or sets the ISO country code to filter by.","nullable":true}},"additionalProperties":false,"description":"Represents strongly-typed filters for searching orders."},"OrderSearchPaginatedResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderSearchResponse"},"description":"Gets or sets the collection of order search response data.","nullable":true}},"additionalProperties":false,"description":"Represents a paginated response for an order search, including pagination details and the result data."},"OrderSearchResponse":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Gets or sets the order number.","nullable":true},"name":{"type":"string","description":"Gets or sets the name associated with the order.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address associated with the order.","nullable":true},"total":{"type":"number","description":"Gets or sets the total amount for the order.","format":"double"},"orderedAt":{"type":"string","description":"Gets or sets the date and time when the order was created.","format":"date-time"}},"additionalProperties":false,"description":"Represents the response data for an order search."},"OrderStatuses":{"enum":\["Received","Cancelled"],"type":"string","description":"Order statuses."},"OrderTransactionApiResponse":{"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction.\r\nIf the retailer sends this data, eSW will honor it. If the retailer does not send this data, eSW will generate the GUID for the transaction.","format":"uuid","example":"46874510-DE4C-4748-A74C-97C54AFB4270"}},"additionalProperties":false,"description":"Response from Order API"},"OrderTransactionType":{"enum":\["OrderCancel","LineItemCancel","OrderAppeasementMerchandise","OrderAppeasementShipping","LineItemAppeasement","LineItemReplacement","Return","BlindReturn","Appeasement","ShippedMerchandise","OrderCreate","OrderRefund","OrderAddressUpdate","LineItemUpdate","LineItemAdd","OrderReplacement","CSPCancel","CSPRefund","OrderPaymentSettled","RefundPaymentProcessed","TransactionSettled","CSPLineItemCancel","ForcedRefund","PaymentDetailsCollected","RefundApprovedAndValidated","UnShippedMerchandise","HoldStatusUpdate","LineItemFulfil","PackageUpdate","OrderAllocated","OrderPartiallyAllocated","PaymentPreAuthReversed","OrderAppeasement"],"type":"string"},"OrderType":{"enum":\["Offline","Checkout","NonCheckoutEcommerce"],"type":"string","description":"OrderType"},"OriginDetails":{"required":\["address1","city","country","email","originType"],"type":"object","properties":{"originType":{"$ref":"#/components/schemas/OriginType"},"firstName":{"type":"string","description":"First name of the address.","nullable":true,"example":"John "},"lastName":{"type":"string","description":"Last name of the address.","nullable":true,"example":"Smith"},"telephone":{"type":"string","description":"Phone number.","nullable":true,"example":"+14211112222"},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true,"example":"NickName"},"addressId":{"type":"string","description":"Address Identifier","nullable":true,"example":"AD12345"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true,"example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address.","example":"US"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true,"example":""}},"additionalProperties":false,"description":"Origin Details"},"OriginType":{"enum":\["None","Store"],"type":"string","description":"Payment methods"},"Pagination":{"type":"object","properties":{"limit":{"type":"integer","description":"Gets or sets the maximum number of items to return.","format":"int32"},"offset":{"type":"integer","description":"Gets or sets the number of items to skip before starting to collect the result set.","format":"int32"},"count":{"type":"integer","description":"Gets or sets the total number of items available.","format":"int32"}},"additionalProperties":false,"description":"Represents pagination information for a collection of items."},"Payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method used","nullable":true,"example":"ApplePay"},"last4Digits":{"type":"string","description":"Last 4 digits of the payment card","nullable":true,"example":"1234"},"paymentAttemptRef":{"type":"string","description":"Payment attempt reference","format":"uuid","nullable":true,"example":"1CBA8F0C-F7EE-437C-A450-B63ADD08CA5A"},"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"deliveryPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"retailerPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"retailerDeliveryPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"paymentStatus":{"type":"string","description":"Payment Status","nullable":true},"merchantPaymentId":{"type":"string","description":"Merchant Payment Id","nullable":true},"paymentTime":{"type":"string","description":"The time when the payment was taken","format":"date-time"},"preAuthExpiryTime":{"type":"string","description":"The datetime when we can kick off the capture process for the payment","format":"date-time"},"authResult":{"type":"string","description":"Auth result of the payment","nullable":true}},"additionalProperties":false,"description":"Payment details"},"Price":{"required":\["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Amount to credit eSW or debit eSW","format":"double"},"currency":{"minLength":1,"type":"string","description":"ISO representation for currency of transaction amount.","example":"USD"}},"additionalProperties":false,"description":""},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"Product":{"required":\["description","productCode","title"],"type":"object","properties":{"title":{"minLength":1,"type":"string","description":"Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.","example":"Black dress"},"description":{"minLength":1,"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","example":"Long black dress"},"customsDescription":{"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","nullable":true,"example":"Long black dress"},"prohibitedItem":{"type":"boolean","description":"Indicates whether the item is prohibited"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product.","example":"123456"},"hsCode":{"type":"string","description":"HsCode.","nullable":true,"example":"123456"},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true,"example":"CN"},"imageUrl":{"type":"string","description":"Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.","nullable":true,"example":"<https://url.com/test.png"},"color":{"type":"string","description":"Color> of the item.","nullable":true,"example":"black"},"size":{"type":"string","description":"Size of the item.","nullable":true,"example":"38"},"isReturnProhibited":{"type":"boolean","description":"Indicates whether the item is returnable or not under the regular return policy. The values are True or False.","nullable":true,"example":false},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":20},"taxCode":{"type":"string","description":"Tax code","nullable":true,"example":"XY234"}},"additionalProperties":false,"description":"Product"},"ProductCreate":{"required":\["description","productCode","productUnitPriceInfo","title"],"type":"object","properties":{"title":{"minLength":1,"type":"string","description":"Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.","example":"Black dress"},"description":{"minLength":1,"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","example":"Long black dress"},"customsDescription":{"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","nullable":true,"example":"Long black dress"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product.","example":"123456"},"hsCode":{"type":"string","description":"HsCode.","nullable":true,"example":"123456"},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true,"example":"CN"},"imageUrl":{"type":"string","description":"Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.","nullable":true,"example":"<https://url.com/test.png"},"color":{"type":"string","description":"Color> of the item.","nullable":true,"example":"black"},"size":{"type":"string","description":"Size of the item.","nullable":true,"example":"38"},"productUnitPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"wholesalePriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"weightInfo":{"$ref":"#/components/schemas/WeightInfo"},"isReturnProhibited":{"type":"boolean","description":"Indicates whether the item is returnable or not under the regular return policy. The values are True or False.","nullable":true,"example":false},"isCustomized":{"type":"boolean","description":"Indicates whether the item is customized or not. The values are True or False.","example":false}},"additionalProperties":false,"description":"Product"},"RefundOrderGroupOrderDetail":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Order number","nullable":true}},"additionalProperties":false,"description":"OrderGroupRequest"},"RefundOrderGroupRequest":{"type":"object","properties":{"orderGroupName":{"type":"string","description":"OrderGroupName","nullable":true},"orderDetails":{"type":"array","items":{"$ref":"#/components/schemas/RefundOrderGroupOrderDetail"},"description":"Orders Details","nullable":true},"correlationId":{"type":"string","description":"CorrelationId","nullable":true},"refundReason":{"type":"string","description":"Refund Reason","nullable":true},"refundReasonId":{"type":"integer","description":"Refund Reason","format":"int32"},"refundReference":{"type":"string","description":"Refund Reference","nullable":true},"refundAmountInLocalCurrency":{"type":"number","description":"Refund Amount","format":"double"},"refundType":{"type":"string","description":"Refund Type","nullable":true},"createdBy":{"type":"string","description":"Created By","nullable":true},"entityType":{"type":"string","description":"Entity Type","nullable":true},"isFullRefund":{"type":"boolean","description":"Is Full Refund"}},"additionalProperties":false,"description":"OrderGroupRequest"},"ReplaceOrderItemsReasonCode":{"enum":\["LostPackage","DamagedGoods","ShortShip","LostReturn"],"type":"string","description":"Replace Order Reason Code"},"ReplacementOrderDetails":{"required":\["replacementBrandOrderReference","replacementLineItemId"],"type":"object","properties":{"replacementBrandOrderReference":{"minLength":1,"type":"string","description":"Retailer's unique reference number for the replacement order,","example":"653241"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’","example":"1"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true,"example":"277906"},"name":{"type":"string","description":"The name of the product.","nullable":true,"example":"PINK LOUNGE WOMENS KNIT"},"description":{"type":"string","description":"The description of the product.\r\n Example: ‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’","nullable":true,"example":"‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’"},"colour":{"type":"string","description":"The colour of the product","nullable":true,"example":"Red"},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true,"example":"S"}},"additionalProperties":false,"description":"Product"},"ResendEmailDto":{"type":"object","properties":{"orderId":{"type":"string","description":"OrderId","nullable":true},"emailId":{"type":"string","description":"Email Identifier","nullable":true}},"additionalProperties":false,"description":"Resend Email Dto"},"ResendEmailResponse":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Error Message","nullable":true},"statusCode":{"$ref":"#/components/schemas/HttpStatusCode"}},"additionalProperties":false,"description":"Resend Email Response"},"RetailerInvoice":{"type":"object","properties":{"number":{"type":"string","description":"RetailerInvoice number","nullable":true,"example":"784512"},"date":{"type":"string","description":"RetailerInvoice Date in the yyyy-MM-dd format","nullable":true,"example":"2020-05-11"}},"additionalProperties":false,"description":"RetailerInvoice details"},"ServiceLevel":{"enum":\["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."},"ShopperExperience":{"required":\["shopperCultureLanguageIso"],"type":"object","properties":{"shopperCultureLanguageIso":{"minLength":1,"type":"string","description":"Preferred language and culture experience for the shopper in the ISO 639-1 and ISO 3166 format.","example":"en-IE"},"registeredProfileId":{"type":"string","description":"Customer profile Id or number","nullable":true,"example":"44170"}},"additionalProperties":false,"description":"Shopper Experience"},"Transaction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"reasonCode":{"type":"string","description":"Reason","nullable":true,"example":"LostPackage"},"lastUpdateTime":{"type":"string","description":"LastUpdateTime","format":"date-time","nullable":true},"creationTime":{"type":"string","description":"CreationTime","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Transaction details"},"TransactionStatus":{"enum":\["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"},"UpdateContactDetail":{"required":\["address1","city","contactDetailsType","email","postalCode","telephone"],"type":"object","properties":{"contactDetailsType":{"$ref":"#/components/schemas/UpdateContactDetailsType"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"minLength":1,"type":"string","description":"Postal code or zip code of the address.","example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"telephone":{"minLength":1,"type":"string","description":"Phone number.","example":"+14211112222"}},"additionalProperties":false,"description":"Update Contact Details"},"UpdateContactDetailsType":{"enum":\["IsDelivery"],"type":"string","description":"ContactDetailsType"},"UpdateLineItemReasonCode":{"enum":\["ProductSubstituted","ProductDiscontinued","ProductNotAvailable"],"type":"string","description":"Update Line Item Reason Code"},"UpdateOrderContacts":{"required":\["actionedBy","contactDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"contactDetails":{"$ref":"#/components/schemas/UpdateContactDetail"}},"additionalProperties":false,"description":"Update Contact details like address info."},"WeightInfo":{"type":"object","properties":{"weightTotal":{"type":"number","description":"Total weight of the order.","format":"double"},"weightUnit":{"$ref":"#/components/schemas/WeightUnit"}},"additionalProperties":false,"description":"(Required) Attributes that describe the package weight data."},"WeightUnit":{"enum":\["KG","LB"],"type":"string","description":"Unit of measurement for the items in the package. 0 indicates KG and 1 indicates LB."}},"endpoints":\[{"method":"POST","path":"/v2/{tenantCode}/Order","summary":"Creates an order.","pathParams":\[{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderCreate"}},{"method":"PUT","path":"/v2/{tenantCode}/Order/{brandOrderReference}/ContactDetails","summary":"Update Order Contact details","pathParams":\[{"name":"brandOrderReference","required":true,"description":""},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/UpdateOrderContacts"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/OrderActivity","summary":"Cancels the entire order, that is, all line items in the ord","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order"},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderActivityRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItemActivity","summary":"Cancels or fulfils the line items fully or partially in an o","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemActivityRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItem","summary":"Creates a full or partial line item replacement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemRequest"}},{"method":"PATCH","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItem","summary":"Updates a Line Item within an order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemUpdateRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Appeasement","summary":"Adds an order level appeasement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderAppeasementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItemAppeasement","summary":"Adds an item level appeasement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemAppeasementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Replacement","summary":"Replaces Line Items within an Order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderReplacementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Allocation","summary":"Allocates an Order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderAllocationRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Comment","summary":"Add a comment to an order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":""},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/AddOrderCommentRequestDto"}}]}" specUrl="<https://order-transaction-api.sandbox.eshopworld.com/swagger/v2/swagger.json>" epIdx="2" method="POST" path="/v2/{tenantCode}/Order/{brandOrderReference}/OrderActivity" title="Cancels the entire order, that is, all line items in the ord" %}

</details>

***

## Refund / Recovery / Appeasement Operations

Create the first successful order-level appeasement with:

```http
POST /v2/{tenantCode}/Order/{brandOrderReference}/Appeasement
```

#### First successful request

```json
curl -X POST "https://<your-host>/v2/TENANT_01/Order/BR-10001/Appeasement" \
  -H "Authorization: Bearer <JWT>" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "Order",
    "reasonCode": "Appeasement",
    "fullAppeasement": true,
    "transactionReference": "F857B3CD-5EB7-426D-8741-812E5ED214C3",
    "transactionDateTime": "2026-03-14T15:30:00Z",
    "actionedBy": "Retailer"
  }'
```

#### Why this is the right first request

`OrderAppeasementRequest` requires `actionedBy`, `reasonCode`, `transactionDateTime`, `transactionReference`, and `type`. The API declares appeasement reason codes `Appeasement`, `LostPackage`, `LateArrival`, and `PromoAppeasement`, and appeasement types `Merchandise`, `Shipping`, and `Order`.

{% code title="BASE URL" expandable="true" %}

```bash
https://order-transaction-api.sandbox.eshopworld.com
```

{% endcode %}

#### Path Parameters

| Name                  | Type     | Description                                                                                                              |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
| `brandOrderReference` | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Retailer's unique reference number for the order.</p> |
| `tenantCode`          | `string` | <p><mark style="color:$danger;"><code>Required</code></mark></p><p>Tenant code for the retailer integration.</p>         |

{% tabs %}
{% tab title="Try it" %}
{% @code-walkthrough/try-it specLoaded="" specEps="" method="POST" path="/v2/{tenantCode}/Order/{brandOrderReference}/Appeasement" baseUrl="<https://api.example.com>" title="Adds an order level appeasement." defaults="{"path":{"brandOrderReference":"","tenantCode":""},"query":{},"headers":{"Content-Type":"application/json"},"body":{"type":"Merchandise","reasonCode":"Appeasement","transaction":{"amount":0,"currency":"USD"},"fullAppeasement":false,"settlementReference":"657100201","transactionReference":"C857B3CD-5EB7-426D-8741-812E5ED214C0","transactionDateTime":"2019-10-14T15:56:18.455Z","actionedBy":"Retailer","actionedByUser":"<johnsmith@test.com>"}}" mode="closed" %}
{% endtab %}
{% endtabs %}

<details>

<summary>Request Construction</summary>

{% @code-walkthrough/body-builder specIndex="{"defs":{"ActionedBy":{"enum":\["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"},"ActivityStatus":{"enum":\["Cancel","Fulfil"],"type":"string","description":"ActivityStatus"},"AddOrderCommentRequestDto":{"type":"object","properties":{"comment":{"type":"string","description":"Comment text","nullable":true},"user":{"type":"string","description":"User who added the comment (nullable, Nike won't use it)","nullable":true}},"additionalProperties":false,"description":"Request DTO for adding a comment to an order"},"AddOrderCommentResponse":{"type":"object","properties":{"user":{"type":"string","description":"User who added the comment","nullable":true},"time":{"type":"string","description":"Time when the comment was added","format":"date-time"}},"additionalProperties":false,"description":"Response after adding a comment to an order"},"AllocationActivityStatus":{"enum":\["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"},"AppeasementsReasonCode":{"enum":\["Appeasement","LostPackage","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"AppeasementsType":{"enum":\["Merchandise","Shipping","Order"],"type":"string","description":""},"ArticleAllocation":{"required":\["activityStatus","fulfilmentCountryIso"],"type":"object","properties":{"activityStatus":{"$ref":"#/components/schemas/AllocationActivityStatus"},"fulfilmentCountryIso":{"minLength":1,"type":"string","description":"Fulfilment country ISO"},"fulfilmentCentreId":{"type":"string","description":"Fulfilment centre Id","nullable":true},"reasonCode":{"$ref":"#/components/schemas/LineItemActivityReasonCode"}},"additionalProperties":false,"description":"Article allocation"},"ArticleAppeasementDetails":{"type":"object","properties":{"articleId":{"type":"string","description":"Article Id to be appeased","nullable":true},"reasonCode":{"$ref":"#/components/schemas/LineItemAppeasementReasonCode"},"amount":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false}},"additionalProperties":false,"description":"Article Appeasement Details"},"ArticleAppeasementRequest":{"required":\["actionedBy","transactionDateTime","transactionReference"],"type":"object","properties":{"articlesAppeasementDetails":{"type":"array","items":{"$ref":"#/components/schemas/ArticleAppeasementDetails"},"description":"The Ids of the articles to appease","nullable":true,"example":1},"referenceNumber":{"type":"string","description":"Reference Number","nullable":true},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Refund Line Item Dto"},"ContactDetail":{"required":\["address1","city","contactDetailsType","country","email","firstName","lastName","telephone"],"type":"object","properties":{"contactDetailsType":{"$ref":"#/components/schemas/ContactDetailsType"},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true,"example":"NickName"},"addressId":{"type":"string","description":"Address Identifier","nullable":true,"example":"AD12345"},"firstName":{"minLength":1,"type":"string","description":"First name of the address.","example":"John "},"lastName":{"minLength":1,"type":"string","description":"Last name of the address.","example":"Smith"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true,"example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address.","example":"US"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"telephone":{"minLength":1,"type":"string","description":"Phone number.","example":"+14211112222"},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true,"example":""}},"additionalProperties":false,"description":"Contact Details"},"ContactDetailsType":{"enum":\["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"},"CurrencyDetails":{"type":"object","properties":{"currencyIso":{"type":"string","description":"Currency ISO code","nullable":true},"currencyExponent":{"type":"integer","description":"Currency exponent which indicates the number of decimal places used by the currency","format":"int32","nullable":true}},"additionalProperties":false,"description":"Currency details"},"CustomerServiceOrderArticleDto":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"OrderArticleId","format":"int64"},"itemSequence":{"type":"integer","description":"Item Sequence","format":"int32","nullable":true},"orderArticleStatus":{"type":"string","description":"OrderArticleStatus","nullable":true},"cancelStatusId":{"type":"integer","description":"CancelStatusId","format":"int32"},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"refundStatusId":{"type":"integer","description":"RefundStatus","format":"int32"},"returnListingId":{"type":"integer","description":"ReturnListingId","format":"int64","nullable":true},"returnReason":{"type":"string","description":"ReturnReason","nullable":true},"replacementOfArticleId":{"type":"integer","description":"ReplacementOfArticle","format":"int64","nullable":true},"replaced":{"type":"boolean","description":"Replaced","nullable":true},"shipped":{"type":"boolean","description":"Shipped"},"allocated":{"type":"boolean","description":"Allocated"},"isCancellable":{"type":"boolean","description":"IsCancellable"},"unitPrice":{"type":"number","description":"UnitPrice","format":"double"},"unitPriceBase":{"type":"number","description":"UnitPriceBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"actualPrice":{"type":"number","description":"ActualPrice","format":"double"},"actualPriceBase":{"type":"number","description":"ActualPriceBase","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double"},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"vat":{"type":"number","description":"Vat","format":"double"},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"salesTax":{"type":"number","description":"SalesTax","format":"double"},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsFee":{"type":"number","description":"CustomsFee","format":"double"},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double"},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double"},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"productDiscountedAmount":{"type":"number","description":"ProductDiscountedAmount","format":"double","nullable":true},"shippingDiscountedAmount":{"type":"number","description":"ShippingDiscountedAmount","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"productColourCode":{"type":"string","description":"ProductColourCode","nullable":true},"productSizeCode":{"type":"string","description":"ProductSizeCode","nullable":true},"productColourDesc":{"type":"string","description":"ProductColourDesc","nullable":true},"styleNumber":{"type":"string","description":"StyleNumber","nullable":true},"sku":{"type":"string","description":"Sku","nullable":true},"orderProduct":{"$ref":"#/components/schemas/CustomerServiceOrderProductDto"},"statusSummary":{"$ref":"#/components/schemas/OrderArticleStatusSummaryDto"},"refund":{"$ref":"#/components/schemas/OrderArticleRefundDto"},"refundReturn":{"$ref":"#/components/schemas/OrderArticleRefundDto"},"proRataRefund":{"$ref":"#/components/schemas/OrderArticleRefundDetailDto"},"returnListing":{"$ref":"#/components/schemas/CustomerServiceReturnListingDto"}},"additionalProperties":false,"description":"Customer Service Order Article Dto"},"CustomerServiceOrderProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"ProductCode","nullable":true},"shortDescription":{"type":"string","description":"ShortDescription","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"customsDescription":{"type":"string","description":"CustomsDescription","nullable":true},"category":{"type":"string","description":"Category","nullable":true},"productColourCode":{"type":"string","description":"ProductColourCode","nullable":true},"productSizeCode":{"type":"string","description":"ProductSizeCode","nullable":true},"productColourDesc":{"type":"string","description":"ProductColourDesc","nullable":true},"styleNumber":{"type":"string","description":"StyleNumber","nullable":true},"sku":{"type":"string","description":"Sku","nullable":true}},"additionalProperties":false,"description":"Customer Service Order Product"},"CustomerServiceOrderProductDto":{"type":"object","properties":{"productCode":{"type":"string","description":"ProductCode","nullable":true},"shortDescription":{"type":"string","description":"ShortDescription","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"customsDescription":{"type":"string","description":"CustomsDescription","nullable":true},"category":{"type":"string","description":"Category","nullable":true}},"additionalProperties":false,"description":"Customer Service Order Product"},"CustomerServicePaymentActivity":{"type":"object","properties":{"date":{"type":"string","description":"Date","format":"date-time"},"amount":{"type":"number","description":"Amount","format":"double"},"amountBase":{"type":"number","description":"AmountBase","format":"double"},"event":{"type":"string","description":"Event","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"attemptRef":{"type":"string","description":"AttemptRef","nullable":true}},"additionalProperties":false,"description":"Customer service payment activity"},"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"},"DeliveryOption":{"required":\["eshopDeliveryOptionCode"],"type":"object","properties":{"eshopDeliveryOptionCode":{"$ref":"#/components/schemas/ServiceLevel"},"estimatedDeliveryDateToShopper":{"type":"string","description":"Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":21}},"additionalProperties":false,"description":"Delivery Option"},"DeliveryOptionCreate":{"required":\["eshopDeliveryOptionCode","priceInfo"],"type":"object","properties":{"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"type":{"$ref":"#/components/schemas/DeliveryTypeOms"},"eshopDeliveryOptionCode":{"$ref":"#/components/schemas/ServiceLevel"},"estimatedDeliveryDateToShopper":{"type":"string","description":"Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":21}},"additionalProperties":false,"description":"Delivery Option"},"DeliveryTypeOms":{"enum":\["NA","Home","Store","PUDO","Digital"],"type":"string","description":"DeliveryTypeOms"},"EmailLabel":{"type":"object","properties":{"id":{"type":"string","description":"Label Identifier","format":"uuid"},"hasAttachment":{"type":"boolean","description":"HasAttachment"},"data":{"type":"string","description":"Data","nullable":true},"dataUrl":{"type":"string","description":"Data URL","nullable":true}},"additionalProperties":false,"description":"Label information associated to the email details"},"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error Identifier code","format":"int32","example":1},"message":{"type":"string","description":"Error Message","nullable":true,"example":"Invalid BrandOrderReference"}},"additionalProperties":false,"description":"Error Response"},"ErrorStatus":{"enum":\["Retry","Processed","Failed","InProgress"],"type":"string","description":"Represents Order Migration/Integration event error status"},"ErrorType":{"enum":\["Migration","Integration","RecalculateAllocation","NonCheckOutOrderCreate","PaymentAttempt","NonCheckoutOrder","PaymentAggregate"],"type":"string","description":"Enumeration for error types to log the error for reprocessing"},"FailedEventRequest":{"type":"object","properties":{"tenantCode":{"type":"string","description":"TenantCode","nullable":true},"errorType":{"$ref":"#/components/schemas/ErrorType"},"batchSize":{"type":"integer","description":"BatchSize","format":"int32"},"retryCount":{"type":"integer","description":"RetryCount","format":"int32"},"errorStatus":{"$ref":"#/components/schemas/ErrorStatus"}},"additionalProperties":false,"description":"FailedEventRequest"},"FailedEventsHandlerResponse":{"type":"object","properties":{"httpStatusCode":{"$ref":"#/components/schemas/HttpStatusCode"},"failedCount":{"type":"integer","description":"","format":"int32"},"successCount":{"type":"integer","description":"","format":"int32"},"totalCount":{"type":"integer","description":"","format":"int32"},"failedIds":{"type":"array","items":{"type":"string"},"description":"","nullable":true}},"additionalProperties":false,"description":"FailedEventsHandlerResponse"},"FinTransDetails":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","nullable":true},"type":{"type":"string","description":"Type","nullable":true},"amount":{"type":"number","description":"Amount","format":"double"},"amountBase":{"type":"number","description":"Amount Base","format":"double"},"status":{"type":"string","description":"Status","nullable":true},"response":{"type":"string","description":"Response","nullable":true},"description":{"type":"string","description":"Description","nullable":true},"transactionType":{"type":"string","description":"Transaction Type","nullable":true},"creationTime":{"type":"string","description":"Creation Time","format":"date-time","nullable":true},"reason":{"type":"string","description":"Reason","nullable":true},"paymentDetailCollectionStatus":{"type":"integer","description":"Payment Detail Collection Status","format":"int32"},"isOfflineRefundEnabled":{"type":"boolean","description":"Is Offline Refund Enabled"},"offlineRefundTooltip":{"type":"string","description":"Offline Refund Tooltip","nullable":true}},"additionalProperties":false,"description":"Financial Transactions Details"},"Gender":{"enum":\["None","Male","Female","Unisex"],"type":"string","description":"Gender"},"GetOrderDetailsResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier","nullable":true},"orderGuid":{"type":"string","description":"Order Guid","format":"uuid","nullable":true},"eShopOrderReference":{"type":"string","description":"E-Shop Order Reference","nullable":true},"brandOrderReference":{"type":"string","description":"Brand order reference","nullable":true},"brandId":{"type":"integer","description":"Brand identifier","format":"int32"},"brandCode":{"type":"string","description":"Brand code","nullable":true},"brandName":{"type":"string","description":"Brand name","nullable":true},"tenantCode":{"type":"string","description":"Tenant code","nullable":true},"creationTime":{"type":"string","description":"Creation time of the order","format":"date-time"},"orderStatus":{"type":"string","description":"Status of the order","nullable":true},"orderHoldStatus":{"type":"string","description":"Order hold status","nullable":true},"paymentId":{"type":"string","description":"Payment identifier","nullable":true},"orderType":{"type":"string","description":"Order type","nullable":true},"balance":{"$ref":"#/components/schemas/OrderBalanceResponse"},"isCancellable":{"type":"boolean","description":"Is the order cancellable"},"isLineItemCancellable":{"type":"boolean","description":"Is the line item cancellable"},"orderAllocated":{"type":"boolean","description":"Is the order allocated","nullable":true},"allocationMethod":{"type":"string","description":"Allocation method of the order","nullable":true},"serviceLevel":{"type":"string","description":"Service level of the order","nullable":true},"refund":{"$ref":"#/components/schemas/OrderRefundResponse"},"proRataRefund":{"$ref":"#/components/schemas/OrderProRataRefundResponse"},"estimatedDelivery":{"$ref":"#/components/schemas/OrderEstimatedDeliveryResponse"},"deliveryAddress":{"$ref":"#/components/schemas/OrderAddressResponse"},"paymentAddress":{"$ref":"#/components/schemas/OrderAddressResponse"},"orderCharge":{"$ref":"#/components/schemas/OrderChargeResponse"},"payment":{"$ref":"#/components/schemas/OrderPaymentResponse"},"currencies":{"$ref":"#/components/schemas/OrderCurrenciesResponse"},"orderArticles":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticlesResponse"},"description":"Order article details","nullable":true},"replacements":{"type":"array","items":{"$ref":"#/components/schemas/OrderReplacementsResponse"},"description":"Order replacements details","nullable":true},"isRefundProcessExternal":{"type":"boolean","description":"Is the refund process handled by external system"},"isRefundCreationExternal":{"type":"boolean","description":"Is the refund creation handled by external system"},"canAllowNonCheckOutRefund":{"type":"boolean","description":"Can allow non-checkout refund"},"deliveryType":{"type":"string","description":"Delivery type of the order","nullable":true}},"additionalProperties":false,"description":"Get Order details response"},"GetTransaction":{"type":"object","properties":{"refundAmounts":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of refund amounts.","nullable":true},"refundAmountsInRetailerCurrency":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of refund amounts.","nullable":true},"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"reasonCode":{"type":"string","description":"Reason","nullable":true,"example":"LostPackage"},"lastUpdateTime":{"type":"string","description":"LastUpdateTime","format":"date-time","nullable":true},"creationTime":{"type":"string","description":"CreationTime","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Get Full Transaction Details which includes refund amount"},"HttpStatusCode":{"enum":\["Continue","SwitchingProtocols","Processing","EarlyHints","OK","Created","Accepted","NonAuthoritativeInformation","NoContent","ResetContent","PartialContent","MultiStatus","AlreadyReported","IMUsed","MultipleChoices","MovedPermanently","Found","SeeOther","NotModified","UseProxy","Unused","RedirectKeepVerb","PermanentRedirect","BadRequest","Unauthorized","PaymentRequired","Forbidden","NotFound","MethodNotAllowed","NotAcceptable","ProxyAuthenticationRequired","RequestTimeout","Conflict","Gone","LengthRequired","PreconditionFailed","RequestEntityTooLarge","RequestUriTooLong","UnsupportedMediaType","RequestedRangeNotSatisfiable","ExpectationFailed","MisdirectedRequest","UnprocessableEntity","Locked","FailedDependency","UpgradeRequired","PreconditionRequired","TooManyRequests","RequestHeaderFieldsTooLarge","UnavailableForLegalReasons","InternalServerError","NotImplemented","BadGateway","ServiceUnavailable","GatewayTimeout","HttpVersionNotSupported","VariantAlsoNegotiates","InsufficientStorage","LoopDetected","NotExtended","NetworkAuthenticationRequired"],"type":"string"},"LineItemActivityReasonCode":{"enum":\["OutOfStock","ShopperCancel","ItemFulfilled"],"type":"string","description":"Order Activity Reason Code"},"LineItemActivityRequest":{"required":\["actionedBy","activityStatus","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"The Id of the line item to cancel. Either lineItemId or product code is required.","nullable":true,"example":"1"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item. Either lineItemId or product code is required.","nullable":true,"example":"241563"},"quantity":{"type":"integer","description":"Quantity of products to cancel.","format":"int32","example":2},"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"reasonCode":{"$ref":"#/components/schemas/LineItemActivityReasonCode"},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"LineItemActivityRequest"},"LineItemAppeasementReasonCode":{"enum":\["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"LineItemAppeasementRequest":{"required":\["actionedBy","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"The Id of the line item to appease. Either lineItemId or product code is required.","nullable":true,"example":"1"},"productCode":{"type":"string","description":"Product code. Either lineItemId or productId is required.\r\n Example: ‘277906’","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to appease","format":"int32","example":2},"reasonCode":{"$ref":"#/components/schemas/LineItemAppeasementReasonCode"},"transaction":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"LineItemAppeasementRequest"},"LineItemRequest":{"required":\["actionedBy","quantity","reasonCode","replacementOrderDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true,"example":"2"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32","example":2},"reasonCode":{"$ref":"#/components/schemas/ReplaceOrderItemsReasonCode"},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"LineItemUpdateRequest":{"required":\["actionedBy","lineItemId","productCode","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item to be updated.","example":"2"},"quantity":{"type":"integer","description":"Quantity to be updated.","format":"int32","example":2},"productCode":{"minLength":1,"type":"string","description":"New product code or stock-keeping unit (SKU) number of the item.","example":"277906"},"reasonCode":{"$ref":"#/components/schemas/UpdateLineItemReasonCode"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"Update line items request"},"LineItemsAddRequest":{"required":\["actionedBy","contactDetails","deliveryCountryIso","deliveryOption","lineItems","orderType","retailerCurrencyIso","shopperCurrencyIso","shopperExperience","transactionDateTime","transactionReference"],"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"P12345"},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true,"example":"987456"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","example":"EUR"},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","example":"USD"},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","example":"IE"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemToCreate"},"description":"Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required."},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOptionCreate"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"payment":{"$ref":"#/components/schemas/Payment"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true},"channelType":{"type":"string","description":"Channel Type","nullable":true}},"additionalProperties":false,"description":"Add line items request"},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true,"example":"KeyName"},"value":{"type":"string","description":"Metadata value.","nullable":true,"example":"KeyValue"}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true,"example":"EUR"},"amount":{"type":"string","description":"The amount of the currency.","nullable":true,"example":"100.00"}},"additionalProperties":false,"description":"Money"},"NamedMoney":{"required":\["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge.","example":"ItemTaxes"},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Order":{"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"orderGuid":{"type":"string","description":"Order GUID.","format":"uuid","example":"b785ef18-046e-471c-8470-727c7db0ce6e"},"status":{"$ref":"#/components/schemas/OrderStatuses"},"brandOrderReference":{"type":"string","description":"The brand's order number.","nullable":true,"example":"78451296"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"3265987"},"eShopWorldOrderNumber":{"type":"string","description":"Order number in the eshopWorld system.","nullable":true,"example":"5001007400857"},"shopperCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","nullable":true,"example":"EUR"},"retailerCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","nullable":true,"example":"USD"},"deliveryCountryIso":{"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","nullable":true,"example":"IE"},"orderDate":{"type":"string","description":"The datetime when the order was created, in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"weight":{"$ref":"#/components/schemas/WeightInfo"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details.","nullable":true},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"},"description":"Attributes that describe the items in the cart.","nullable":true},"orderCharges":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"<summary>A list of order level charges.</summary>","nullable":true},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOption"},"payment":{"$ref":"#/components/schemas/Payment"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"transactions":{"type":"array","items":{"$ref":"#/components/schemas/Transaction"},"description":"Transactions","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs","nullable":true},"orderBalances":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of order balance charges","nullable":true}},"additionalProperties":false,"description":"Order"},"OrderActivityReasonCode":{"enum":\["ShopperCancel","RetailerCancel","Fraud"],"type":"string","description":"Order Activity Reason Code"},"OrderActivityRequest":{"required":\["actionedBy","activityStatus","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"activityStatus":{"$ref":"#/components/schemas/ActivityStatus"},"reasonCode":{"$ref":"#/components/schemas/OrderActivityReasonCode"},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderActivityRequest"},"OrderAddressDto":{"type":"object","properties":{"nameAddressId":{"type":"integer","description":"Name Address Id","format":"int64"},"brandId":{"type":"integer","description":"Brand Id","format":"int32"},"firstName":{"type":"string","description":"First Name","nullable":true},"middleName":{"type":"string","description":"Middle Name","nullable":true},"lastName":{"type":"string","description":"Last Name","nullable":true},"name":{"type":"string","description":"First and Last names combined","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"telephone":{"type":"string","description":"Telephone","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City","nullable":true},"region":{"type":"string","description":"Region","nullable":true},"postalCode":{"type":"string","description":"Postal Code","nullable":true},"country":{"type":"string","description":"Country","nullable":true},"countryIso":{"type":"string","description":"Country ISO","nullable":true},"storeName":{"type":"string","description":"Store Name","nullable":true}},"additionalProperties":false,"description":"Package address information associated to an Order comming from Order Internal API"},"OrderAddressResponse":{"type":"object","properties":{"nameAddressId":{"type":"integer","description":"Name address identifier","format":"int64"},"brandId":{"type":"integer","description":"Brand identifier","format":"int32"},"firstName":{"type":"string","description":"First name of the contact","nullable":true},"middleName":{"type":"string","description":"Middle name of the contact","nullable":true},"lastName":{"type":"string","description":"Last name of the contact","nullable":true},"name":{"type":"string","description":"Name of the contact (contains first name and last name)","nullable":true},"email":{"type":"string","description":"Email address of the contact","nullable":true},"telephone":{"type":"string","description":"Telephone number of the contact","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City of the contact","nullable":true},"region":{"type":"string","description":"Region of the contact","nullable":true},"postalCode":{"type":"string","description":"Postal code of the contact","nullable":true},"country":{"type":"string","description":"Country of the contact","nullable":true},"countryIso":{"type":"string","description":"ISO code of the country","nullable":true},"storeName":{"type":"string","description":"Name of the store","nullable":true}},"additionalProperties":false,"description":"Order address response"},"OrderAllocationRequest":{"required":\["actionedBy","lineItems","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemAllocation"},"description":"The Line Items to allocate"},"allocationId":{"type":"string","description":"Allocation ID","nullable":true},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderAllocationRequest"},"OrderAppeasementRequest":{"required":\["actionedBy","reasonCode","transactionDateTime","transactionReference","type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/AppeasementsType"},"reasonCode":{"$ref":"#/components/schemas/AppeasementsReasonCode"},"transaction":{"$ref":"#/components/schemas/Price"},"fullAppeasement":{"type":"boolean","description":"Should be Set  for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.","example":false},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":""},"OrderArticle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Article sequence within the line item","format":"int32","example":2},"status":{"$ref":"#/components/schemas/OrderArticleStatuses"},"charges":{"type":"array","items":{"$ref":"#/components/schemas/NamedMoney"},"description":"A list of item level charges.","nullable":true}},"additionalProperties":false,"description":"Order Article"},"OrderArticleRefund":{"type":"object","properties":{"useMerchandiseAmount":{"type":"boolean","description":"UseMerchandiseAmount"},"useDutyAmount":{"type":"boolean","description":"UseDutyAmount"},"useVatAmount":{"type":"boolean","description":"UseVatAmount"},"useSalesTaxAmount":{"type":"boolean","description":"UseSalesTaxAmount"},"useCustomsFeeAmount":{"type":"boolean","description":"UseCustomsFeeAmount"},"useShippingAmount":{"type":"boolean","description":"UseShippingAmount"},"dutyAndTax":{"type":"number","description":"DutyAndTax","format":"double"},"dutyAndTaxBase":{"type":"number","description":"DutyAndTaxBase","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"}},"additionalProperties":false,"description":"Order Article Refund"},"OrderArticleRefundDetail":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"Order Article identifier","format":"int64"},"articleRefundAmount":{"type":"number","description":"Article refund amount available","format":"double"},"articleShippingRefundAmount":{"type":"number","description":"Article shipping refund amount available","format":"double"},"refundAmountAvailable":{"type":"number","description":"Refund amount available for the article","format":"double"},"itemPendingCancel":{"type":"boolean","description":"Item pending cancel for the article"},"orderArticleStatusForRefund":{"type":"string","description":"Order article status for refund","nullable":true}},"additionalProperties":false,"description":"Order Article refund detail\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderArticleRefundDetailDto":{"type":"object","properties":{"orderArticleId":{"type":"integer","description":"Order Article identifier","format":"int64"},"articleRefundAmount":{"type":"number","description":"Article refund amount available","format":"double"},"articleShippingRefundAmount":{"type":"number","description":"Article shipping refund amount available","format":"double"},"refundAmountAvailable":{"type":"number","description":"Refund amount available for the article","format":"double"},"itemPendingCancel":{"type":"boolean","description":"Item pending cancel for the article"},"orderArticleStatusForRefund":{"type":"string","description":"Order article status for refund","nullable":true}},"additionalProperties":false,"description":"Order Article refund detail dto"},"OrderArticleRefundDto":{"type":"object","properties":{"useMerchandiseAmount":{"type":"boolean","description":"UseMerchandiseAmount"},"useDutyAmount":{"type":"boolean","description":"UseDutyAmount"},"useVatAmount":{"type":"boolean","description":"UseVatAmount"},"useSalesTaxAmount":{"type":"boolean","description":"UseSalesTaxAmount"},"useCustomsFeeAmount":{"type":"boolean","description":"UseCustomsFeeAmount"},"useShippingAmount":{"type":"boolean","description":"UseShippingAmount"},"dutyAndTax":{"type":"number","description":"DutyAndTax","format":"double"},"dutyAndTaxBase":{"type":"number","description":"DutyAndTaxBase","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"}},"additionalProperties":false,"description":"Order Article Refund"},"OrderArticleStatusSummary":{"type":"object","properties":{"standardStatus":{"type":"string","description":"StandardStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"replacedStatus":{"type":"string","description":"ReplacedStatus","nullable":true},"replacementStatus":{"type":"string","description":"ReplacementStatus","nullable":true}},"additionalProperties":false,"description":"Order Article Status Summary"},"OrderArticleStatusSummaryDto":{"type":"object","properties":{"standardStatus":{"type":"string","description":"StandardStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"replacedStatus":{"type":"string","description":"ReplacedStatus","nullable":true},"replacementStatus":{"type":"string","description":"ReplacementStatus","nullable":true}},"additionalProperties":false,"description":"Order Article Status Summary"},"OrderArticleStatuses":{"enum":\["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"},"OrderArticlesResponse":{"type":"object","properties":{"id":{"type":"string","description":"OrderArticleId","nullable":true},"lineItemId":{"type":"string","description":"Line Item Id","nullable":true},"status":{"type":"string","description":"OrderArticleStatus","nullable":true},"cancelStatus":{"type":"string","description":"CancelStatus","nullable":true},"returnStatus":{"type":"string","description":"ReturnStatus","nullable":true},"refundStatus":{"type":"string","description":"RefundStatus","nullable":true},"returnListing":{"type":"string","description":"ReturnListingId","nullable":true},"returnReason":{"type":"string","description":"ReturnReason","nullable":true},"replacementOfArticle":{"type":"string","description":"ReplacementOfArticle","nullable":true},"replaced":{"type":"boolean","description":"Replaced","nullable":true},"shipped":{"type":"boolean","description":"Shipped"},"allocated":{"type":"boolean","description":"Allocated"},"isCancellable":{"type":"boolean","description":"IsCancellable"},"unitPrice":{"type":"number","description":"UnitPrice","format":"double"},"unitPriceBase":{"type":"number","description":"UnitPriceBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"actualPrice":{"type":"number","description":"ActualPrice","format":"double"},"actualPriceBase":{"type":"number","description":"ActualPriceBase","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double"},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"vat":{"type":"number","description":"Vat","format":"double"},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"salesTax":{"type":"number","description":"SalesTax","format":"double"},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsFee":{"type":"number","description":"CustomsFee","format":"double"},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double"},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double"},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"productDiscountedAmount":{"type":"number","description":"ProductDiscountedAmount","format":"double","nullable":true},"shippingDiscountedAmount":{"type":"number","description":"ShippingDiscountedAmount","format":"double","nullable":true},"total":{"type":"number","description":"Total","format":"double"},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"orderProduct":{"$ref":"#/components/schemas/CustomerServiceOrderProduct"},"statusSummary":{"$ref":"#/components/schemas/OrderArticleStatusSummary"},"refund":{"$ref":"#/components/schemas/OrderArticleRefund"},"refundReturn":{"$ref":"#/components/schemas/OrderArticleRefund"},"proRataRefund":{"$ref":"#/components/schemas/OrderArticleRefundDetail"},"returnOrderNumber":{"type":"integer","description":"ReturnOrderNumber","format":"int64"}},"additionalProperties":false,"description":"Order articles response"},"OrderBalanceResponse":{"type":"object","properties":{"credits":{"type":"number","description":"Credits","format":"double","nullable":true},"debits":{"type":"number","description":"Debits","format":"double","nullable":true},"balance":{"type":"number","description":"Balance","format":"double","nullable":true},"nonRefundableBalance":{"type":"number","description":"Non-refundable balance","format":"double","nullable":true}},"additionalProperties":false,"description":"Order balance response"},"OrderChargeResponse":{"type":"object","properties":{"merchandise":{"type":"number","description":"Merchandise","format":"double","nullable":true},"merchandiseBase":{"type":"number","description":"MerchandiseBase","format":"double"},"discount":{"type":"number","description":"Discount","format":"double"},"discountBase":{"type":"number","description":"DiscountBase","format":"double"},"merchandiseLessDiscount":{"type":"number","description":"MerchandiseLessDiscount","format":"double","nullable":true},"merchandiseLessDiscountBase":{"type":"number","description":"MerchandiseLessDiscountBase","format":"double"},"vat":{"type":"number","description":"Vat","format":"double","nullable":true},"vatBase":{"type":"number","description":"VatBase","format":"double"},"vatOnProduct":{"type":"number","description":"VatOnProduct","format":"double","nullable":true},"vatOnShipping":{"type":"number","description":"VatOnShipping","format":"double","nullable":true},"vatOnOtherTaxes":{"type":"number","description":"VatOnOtherTaxes","format":"double","nullable":true},"vatOnOtherFees":{"type":"number","description":"VatOnOtherFees","format":"double","nullable":true},"vatOnProductDuty":{"type":"number","description":"VatOnProductDuty","format":"double","nullable":true},"vatOnShippingDuty":{"type":"number","description":"VatOnShippingDuty","format":"double","nullable":true},"customsFee":{"type":"number","description":"CustomsFee","format":"double","nullable":true},"customsFeeBase":{"type":"number","description":"CustomsFeeBase","format":"double"},"salesTax":{"type":"number","description":"SalesTax","format":"double","nullable":true},"salesTaxBase":{"type":"number","description":"SalesTaxBase","format":"double"},"otherTaxes":{"type":"number","description":"OtherTaxes","format":"double"},"customsDuty":{"type":"number","description":"CustomsDuty","format":"double","nullable":true},"customsDutyBase":{"type":"number","description":"CustomsDutyBase","format":"double"},"dutyOnProduct":{"type":"number","description":"DutyOnProduct","format":"double","nullable":true},"dutyOnShipping":{"type":"number","description":"DutyOnShipping","format":"double","nullable":true},"dutiesAndTaxes":{"type":"number","description":"DutiesAndTaxes","format":"double","nullable":true},"dutiesAndTaxesBase":{"type":"number","description":"DutiesAndTaxesBase","format":"double"},"edduDutiesAndTaxes":{"type":"number","description":"EdduDutiesAndTaxes","format":"double"},"edduDutiesAndTaxesBase":{"type":"number","description":"EdduDutiesAndTaxesBase","format":"double"},"internationalServiceFee":{"type":"number","description":"InternationalServiceFee","format":"double","nullable":true},"shipping":{"type":"number","description":"Shipping","format":"double","nullable":true},"shippingBase":{"type":"number","description":"ShippingBase","format":"double"},"total":{"type":"number","description":"Total","format":"double","nullable":true},"totalBase":{"type":"number","description":"TotalBase","format":"double"},"brandJsonData":{"type":"string","description":"BrandJsonData","nullable":true},"displayModelId":{"type":"integer","description":"DisplayModelId","format":"int32","nullable":true},"brandCountryDisplayModelId":{"type":"integer","description":"BrandCountryDisplayModelId","format":"int32","nullable":true},"paymentMethodCharge":{"type":"number","description":"PaymentMethodCharge","format":"double","nullable":true},"paymentMethodChargeBase":{"type":"number","description":"PaymentMethodChargeBase","format":"double","nullable":true},"nonRefundableCharge":{"type":"number","description":"NonRefundableCharge","format":"double","nullable":true}},"additionalProperties":false,"description":"Order charge response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderCreate":{"required":\["actionedBy","brandOrderReference","contactDetails","deliveryCountryIso","deliveryOption","lineItems","orderType","retailerCurrencyIso","shopperCurrencyIso","shopperExperience","transactionDateTime","transactionReference"],"type":"object","properties":{"brandOrderReference":{"minLength":1,"type":"string","description":"The Brand's order number.","example":"12345"},"weight":{"$ref":"#/components/schemas/WeightInfo"},"orderType":{"$ref":"#/components/schemas/OrderType"},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true,"example":"P12345"},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true,"example":"987456"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","example":"EUR"},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","example":"USD"},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","example":"IE"},"shopperExperience":{"$ref":"#/components/schemas/ShopperExperience"},"contactDetails":{"type":"array","items":{"$ref":"#/components/schemas/ContactDetail"},"description":"Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last."},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemToCreate"},"description":"Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required."},"deliveryOption":{"$ref":"#/components/schemas/DeliveryOptionCreate"},"retailerInvoice":{"$ref":"#/components/schemas/RetailerInvoice"},"payment":{"$ref":"#/components/schemas/Payment"},"originDetails":{"$ref":"#/components/schemas/OriginDetails"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true},"channelType":{"type":"string","description":"Channel Type","nullable":true}},"additionalProperties":false,"description":"Order create request"},"OrderCurrenciesResponse":{"type":"object","properties":{"shopper":{"$ref":"#/components/schemas/CurrencyDetails"},"retailer":{"$ref":"#/components/schemas/CurrencyDetails"}},"additionalProperties":false,"description":"Order currencies response"},"OrderEmailDetail":{"type":"object","properties":{"id":{"type":"string","description":"Email Identifier","nullable":true},"template":{"type":"string","description":"Template","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"lastUpdateTime":{"type":"string","description":"Last Update Time","format":"date-time"},"recipients":{"type":"array","items":{"type":"string"},"description":"Recipients","nullable":true},"label":{"$ref":"#/components/schemas/EmailLabel"}},"additionalProperties":false,"description":"Email information associated to an order"},"OrderEstimatedDeliveryResponse":{"type":"object","properties":{"minDays":{"type":"integer","description":"Minimum estimated delivery days for the order","format":"int32"},"maxDays":{"type":"integer","description":"Maximum estimated delivery days for the order","format":"int32"},"formatted":{"type":"string","description":"Formatted estimated delivery date range for the order","nullable":true}},"additionalProperties":false,"description":"Order estimated delivery response"},"OrderGroup":{"type":"object","properties":{"id":{"type":"string","description":"Unique ID of the OrderGroup.","format":"uuid"},"orderGroupName":{"type":"string","description":"Name of the OrderGroup.","nullable":true},"orderNumbers":{"type":"array","items":{"type":"string"},"description":"IDs of orders included in this group.","nullable":true}},"additionalProperties":false,"description":"Entity for Order Group."},"OrderItem":{"required":\["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID.","example":"1"},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32","example":2},"estimatedDeliveryDateFromRetailer":{"type":"string","description":"Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"product":{"$ref":"#/components/schemas/Product"},"articles":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticle"},"description":"List of articles with their statuses","nullable":true},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs","nullable":true}},"additionalProperties":false,"description":"Cart Items"},"OrderItemAllocation":{"required":\["articles","lineItemId","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item id","example":"1"},"quantity":{"type":"integer","description":"Quantity","format":"int32","example":1},"articles":{"type":"array","items":{"$ref":"#/components/schemas/ArticleAllocation"},"description":"Articles to allocate"}},"additionalProperties":false,"description":"Defines the model to be used when allocating a line item"},"OrderItemReplacement":{"required":\["quantity","replacementOrderDetails"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true,"example":"2"},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true,"example":"277906"},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32","example":2},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"OrderItemToCreate":{"required":\["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID.","example":"1"},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32","example":2},"estimatedDeliveryDateFromRetailer":{"type":"string","description":"Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.","format":"date-time","nullable":true,"example":"2020-08-31T11:54:24.631Z"},"product":{"$ref":"#/components/schemas/ProductCreate"},"metadataItems":{"type":"array","items":{"$ref":"#/components/schemas/MetadataItem"},"description":"Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.","nullable":true}},"additionalProperties":false,"description":"Cart Items"},"OrderPackage":{"type":"object","properties":{"packageId":{"type":"string","description":"Package Id","nullable":true},"packageStatus":{"type":"string","description":"Package Status","nullable":true},"brandPackageReference":{"type":"string","description":"Brand Package Reference","nullable":true},"eShopPackageReference":{"type":"string","description":"Eshop Package Reference","nullable":true},"carrier":{"type":"string","description":"Carrier","nullable":true},"serviceType":{"type":"string","description":"Service Type","nullable":true},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"weight":{"type":"number","description":"Weight","format":"float","nullable":true},"weightUnit":{"type":"string","description":"Weight Unit","nullable":true},"duty":{"type":"number","description":"Duty","format":"double"},"vat":{"type":"number","description":"VAT","format":"double"},"tax":{"type":"number","description":"Tax","format":"double"},"customsFee":{"type":"number","description":"Customs Fee","format":"double"},"shipping":{"type":"number","description":"Shipping","format":"double"},"total":{"type":"number","description":"Total","format":"double"},"merch":{"type":"number","description":"Merch","format":"double"},"shippingAddress":{"$ref":"#/components/schemas/OrderPackageAddress"},"packageArticles":{"type":"array","items":{"$ref":"#/components/schemas/OrderPackageArticle"},"description":"Articles associated to the package","nullable":true}},"additionalProperties":false,"description":"Package information associated to an order"},"OrderPackageAddress":{"type":"object","properties":{"firstName":{"type":"string","description":"First Name","nullable":true},"middleName":{"type":"string","description":"Middle Name","nullable":true},"lastName":{"type":"string","description":"Last Name","nullable":true},"name":{"type":"string","description":"First and Last names combined","nullable":true},"email":{"type":"string","description":"Email","nullable":true},"telephone":{"type":"string","description":"Telephone","nullable":true},"address1":{"type":"string","description":"Address1","nullable":true},"address2":{"type":"string","description":"Address2","nullable":true},"address3":{"type":"string","description":"Address3","nullable":true},"city":{"type":"string","description":"City","nullable":true},"region":{"type":"string","description":"Region","nullable":true},"postalCode":{"type":"string","description":"Postal Code","nullable":true},"country":{"type":"string","description":"Country","nullable":true},"countryIso":{"type":"string","description":"Country ISO","nullable":true},"storeName":{"type":"string","description":"Store Name","nullable":true}},"additionalProperties":false,"description":"Address information for an order package"},"OrderPackageArticle":{"type":"object","properties":{"returnOrderNumber":{"type":"string","description":"Return Order Number","nullable":true},"sku":{"type":"string","description":"SKU","nullable":true},"description":{"type":"string","description":"Description","nullable":true}},"additionalProperties":false,"description":"Article associated to a package"},"OrderPaymentDetail":{"type":"object","properties":{"amount":{"type":"number","description":"Amount","format":"double"},"date":{"type":"string","description":"Date","format":"date-time"},"event":{"type":"string","description":"Event","nullable":true},"status":{"type":"string","description":"Statys","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"attemptRef":{"type":"string","description":"AttemptRef","format":"uuid"}},"additionalProperties":false,"description":"Order Payment Detail"},"OrderPaymentResponse":{"type":"object","properties":{"paymentId":{"type":"integer","description":"PaymentId","format":"int64","nullable":true},"paymentAttemptRef":{"type":"string","description":"PaymentAttemptRef","format":"uuid","nullable":true},"paymentProviderOrderId":{"type":"string","description":"PaymentProviderOrderId","nullable":true},"amount":{"type":"number","description":"Amount","format":"double"},"currencyCode":{"type":"string","description":"CurrencyCode","nullable":true},"statusId":{"type":"integer","description":"StatusId","format":"int32","nullable":true},"status":{"type":"string","description":"Status","nullable":true},"methodId":{"type":"integer","description":"MethodId","format":"int32","nullable":true},"method":{"type":"string","description":"Method","nullable":true},"legacyMethod":{"type":"string","description":"LegacyMethod","nullable":true},"adminFee":{"type":"number","description":"AdminFee","format":"double","nullable":true},"paymentTime":{"type":"string","description":"PaymentTime","format":"date-time","nullable":true},"expiryTime":{"type":"string","description":"ExpiryTime","format":"date-time","nullable":true},"edduToken":{"type":"string","description":"EdduToken","nullable":true},"provider":{"type":"string","description":"Provider","nullable":true},"paymentReference":{"type":"string","description":"PaymentReference","nullable":true},"preAuthorized":{"type":"boolean","description":"PreAuthorized","nullable":true},"settled":{"type":"boolean","description":"Settled","nullable":true},"isPreAuth":{"type":"boolean","description":"IsPreAuth"},"activities":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServicePaymentActivity"},"description":"Activities","nullable":true},"last4Digits":{"type":"string","description":"Last4Digits","nullable":true},"masterPaymentIdentifier":{"type":"string","description":"MasterPaymentIdentifier","format":"uuid","nullable":true},"isSplitPayment":{"type":"boolean","description":"IsSplitPayment"},"isPaid":{"type":"boolean","description":"IsPaid"}},"additionalProperties":false,"description":"Order payment response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderProRataRefundResponse":{"type":"object","properties":{"orderId":{"type":"integer","description":"Order identifier","format":"int64"},"orderStatusForRefund":{"type":"string","nullable":true},"orderArticleRefundDetails":{"type":"array","items":{"$ref":"#/components/schemas/OrderArticleRefundDetail"},"description":"Order Article refund details","nullable":true},"shippingAmountAvailable":{"type":"number","description":"Shipping amount available for refund","format":"double"},"fullOrderAmountAvailable":{"type":"number","description":"Full order amount available for refund","format":"double"}},"additionalProperties":false,"description":"Order Pro Rata Refund response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderRefundResponse":{"type":"object","properties":{"totalRefunded":{"type":"number","description":"Total refunded amount for the order","format":"double","nullable":true},"totalRefundedBase":{"type":"number","description":"Total refunded amount for the order in base currency","format":"double"},"totalRefundedEdduDutyAndTax":{"type":"number","description":"Total refunded EDDU duty and tax for the order","format":"double"},"totalRefundedEdduDutyAndTaxBase":{"type":"number","description":"Total refunded EDDU duty and tax for the order in base currency","format":"double"},"availableToRefund":{"type":"number","description":"Available amount to refund for the order","format":"double","nullable":true},"availableToRefundBase":{"type":"number","description":"Available amount to refund for the order in base currency","format":"double"},"availableToRefundEdduDutyAndTax":{"type":"number","description":"Available EDDU duty and tax amount to refund for the order","format":"double"},"availableToRefundEdduDutyAndTaxBase":{"type":"number","description":"Available EDDU duty and tax amount to refund for the order in base currency","format":"double"}},"additionalProperties":false,"description":"Order refund response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderReplacementReasonCode":{"enum":\["LostPackage","DamagedGoods","ShortShip","LostReturn","IncorrectSize","IncorrectProduct","ProductNotAsExpected","ShopperRemorse"],"type":"string","description":"Order Replacement Reason Code"},"OrderReplacementRequest":{"required":\["actionedBy","exchange","items","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemReplacement"},"description":"The Line Items to exchange"},"reasonCode":{"$ref":"#/components/schemas/OrderReplacementReasonCode"},"exchange":{"type":"boolean","description":"Indicates whether return of the items is required.","example":true},"settlementReference":{"type":"string","description":"Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.","nullable":true,"example":"657100201"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"}},"additionalProperties":false,"description":"OrderReplacementRequest"},"OrderReplacementsResponse":{"type":"object","properties":{"number":{"type":"integer","description":"Number","format":"int64"},"date":{"type":"string","description":"Date","format":"date-time"},"refund":{"type":"number","description":"Refund","format":"double"},"replacedOrRefundedArticles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServiceOrderArticleDto"},"description":"ReplacedOrRefundedArticles","nullable":true},"replacementArticles":{"type":"array","items":{"$ref":"#/components/schemas/CustomerServiceOrderArticleDto"},"description":"ReplacementArticles","nullable":true},"shippingAddress":{"$ref":"#/components/schemas/OrderAddressDto"}},"additionalProperties":false,"description":"Order replacements response\r\nToDo Fus2 - Temporary aligned with Mono. To be cleaned up later."},"OrderSearch":{"type":"object","properties":{"limit":{"type":"integer","description":"Gets or sets the maximum number of orders to return.","format":"int32"},"offset":{"type":"integer","description":"Gets or sets the number of orders to skip before starting to return results.","format":"int32"},"orderSearchFilters":{"$ref":"#/components/schemas/OrderSearchFilters"}},"additionalProperties":false,"description":"Request to search for orders with specified filters, limit, and offset."},"OrderSearchFilters":{"type":"object","properties":{"orderNumbers":{"type":"array","items":{"type":"string"},"description":"Gets or sets the list of order numbers to filter by.","nullable":true},"email":{"type":"string","description":"Gets or sets the shopper email to filter by.","nullable":true},"name":{"type":"string","description":"Gets or sets the shopper full name to filter by. ex: John Doe","nullable":true},"fromDate":{"type":"string","description":"Gets or sets the start date-time (UTC) of the search window.","format":"date-time","nullable":true},"toDate":{"type":"string","description":"Gets or sets the end date-time (UTC) of the search window.","format":"date-time","nullable":true},"orderDeliveryType":{"type":"string","description":"Gets or sets the order delivery type to filter by.","nullable":true},"orderStatus":{"type":"string","description":"Gets or sets the order status to filter by.","nullable":true},"country":{"type":"string","description":"Gets or sets the ISO country code to filter by.","nullable":true}},"additionalProperties":false,"description":"Represents strongly-typed filters for searching orders."},"OrderSearchPaginatedResponse":{"type":"object","properties":{"pagination":{"$ref":"#/components/schemas/Pagination"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderSearchResponse"},"description":"Gets or sets the collection of order search response data.","nullable":true}},"additionalProperties":false,"description":"Represents a paginated response for an order search, including pagination details and the result data."},"OrderSearchResponse":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Gets or sets the order number.","nullable":true},"name":{"type":"string","description":"Gets or sets the name associated with the order.","nullable":true},"email":{"type":"string","description":"Gets or sets the email address associated with the order.","nullable":true},"total":{"type":"number","description":"Gets or sets the total amount for the order.","format":"double"},"orderedAt":{"type":"string","description":"Gets or sets the date and time when the order was created.","format":"date-time"}},"additionalProperties":false,"description":"Represents the response data for an order search."},"OrderStatuses":{"enum":\["Received","Cancelled"],"type":"string","description":"Order statuses."},"OrderTransactionApiResponse":{"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction.\r\nIf the retailer sends this data, eSW will honor it. If the retailer does not send this data, eSW will generate the GUID for the transaction.","format":"uuid","example":"46874510-DE4C-4748-A74C-97C54AFB4270"}},"additionalProperties":false,"description":"Response from Order API"},"OrderTransactionType":{"enum":\["OrderCancel","LineItemCancel","OrderAppeasementMerchandise","OrderAppeasementShipping","LineItemAppeasement","LineItemReplacement","Return","BlindReturn","Appeasement","ShippedMerchandise","OrderCreate","OrderRefund","OrderAddressUpdate","LineItemUpdate","LineItemAdd","OrderReplacement","CSPCancel","CSPRefund","OrderPaymentSettled","RefundPaymentProcessed","TransactionSettled","CSPLineItemCancel","ForcedRefund","PaymentDetailsCollected","RefundApprovedAndValidated","UnShippedMerchandise","HoldStatusUpdate","LineItemFulfil","PackageUpdate","OrderAllocated","OrderPartiallyAllocated","PaymentPreAuthReversed","OrderAppeasement"],"type":"string"},"OrderType":{"enum":\["Offline","Checkout","NonCheckoutEcommerce"],"type":"string","description":"OrderType"},"OriginDetails":{"required":\["address1","city","country","email","originType"],"type":"object","properties":{"originType":{"$ref":"#/components/schemas/OriginType"},"firstName":{"type":"string","description":"First name of the address.","nullable":true,"example":"John "},"lastName":{"type":"string","description":"Last name of the address.","nullable":true,"example":"Smith"},"telephone":{"type":"string","description":"Phone number.","nullable":true,"example":"+14211112222"},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true,"example":"NickName"},"addressId":{"type":"string","description":"Address Identifier","nullable":true,"example":"AD12345"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true,"example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address.","example":"US"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true,"example":""}},"additionalProperties":false,"description":"Origin Details"},"OriginType":{"enum":\["None","Store"],"type":"string","description":"Payment methods"},"Pagination":{"type":"object","properties":{"limit":{"type":"integer","description":"Gets or sets the maximum number of items to return.","format":"int32"},"offset":{"type":"integer","description":"Gets or sets the number of items to skip before starting to collect the result set.","format":"int32"},"count":{"type":"integer","description":"Gets or sets the total number of items available.","format":"int32"}},"additionalProperties":false,"description":"Represents pagination information for a collection of items."},"Payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method used","nullable":true,"example":"ApplePay"},"last4Digits":{"type":"string","description":"Last 4 digits of the payment card","nullable":true,"example":"1234"},"paymentAttemptRef":{"type":"string","description":"Payment attempt reference","format":"uuid","nullable":true,"example":"1CBA8F0C-F7EE-437C-A450-B63ADD08CA5A"},"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"deliveryPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"retailerPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"retailerDeliveryPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"paymentStatus":{"type":"string","description":"Payment Status","nullable":true},"merchantPaymentId":{"type":"string","description":"Merchant Payment Id","nullable":true},"paymentTime":{"type":"string","description":"The time when the payment was taken","format":"date-time"},"preAuthExpiryTime":{"type":"string","description":"The datetime when we can kick off the capture process for the payment","format":"date-time"},"authResult":{"type":"string","description":"Auth result of the payment","nullable":true}},"additionalProperties":false,"description":"Payment details"},"Price":{"required":\["amount","currency"],"type":"object","properties":{"amount":{"type":"number","description":"Amount to credit eSW or debit eSW","format":"double"},"currency":{"minLength":1,"type":"string","description":"ISO representation for currency of transaction amount.","example":"USD"}},"additionalProperties":false,"description":""},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"ProblemDetails":{"type":"object","properties":{"type":{"type":"string","nullable":true},"title":{"type":"string","nullable":true},"status":{"type":"integer","format":"int32","nullable":true},"detail":{"type":"string","nullable":true},"instance":{"type":"string","nullable":true}},"additionalProperties":{}},"Product":{"required":\["description","productCode","title"],"type":"object","properties":{"title":{"minLength":1,"type":"string","description":"Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.","example":"Black dress"},"description":{"minLength":1,"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","example":"Long black dress"},"customsDescription":{"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","nullable":true,"example":"Long black dress"},"prohibitedItem":{"type":"boolean","description":"Indicates whether the item is prohibited"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product.","example":"123456"},"hsCode":{"type":"string","description":"HsCode.","nullable":true,"example":"123456"},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true,"example":"CN"},"imageUrl":{"type":"string","description":"Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.","nullable":true,"example":"<https://url.com/test.png"},"color":{"type":"string","description":"Color> of the item.","nullable":true,"example":"black"},"size":{"type":"string","description":"Size of the item.","nullable":true,"example":"38"},"isReturnProhibited":{"type":"boolean","description":"Indicates whether the item is returnable or not under the regular return policy. The values are True or False.","nullable":true,"example":false},"vatRate":{"type":"number","description":"Vat rate","format":"double","example":20},"taxCode":{"type":"string","description":"Tax code","nullable":true,"example":"XY234"}},"additionalProperties":false,"description":"Product"},"ProductCreate":{"required":\["description","productCode","productUnitPriceInfo","title"],"type":"object","properties":{"title":{"minLength":1,"type":"string","description":"Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.","example":"Black dress"},"description":{"minLength":1,"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","example":"Long black dress"},"customsDescription":{"type":"string","description":"Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.","nullable":true,"example":"Long black dress"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product.","example":"123456"},"hsCode":{"type":"string","description":"HsCode.","nullable":true,"example":"123456"},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true,"example":"CN"},"imageUrl":{"type":"string","description":"Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.","nullable":true,"example":"<https://url.com/test.png"},"color":{"type":"string","description":"Color> of the item.","nullable":true,"example":"black"},"size":{"type":"string","description":"Size of the item.","nullable":true,"example":"38"},"productUnitPriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"wholesalePriceInfo":{"$ref":"#/components/schemas/PriceInfo"},"weightInfo":{"$ref":"#/components/schemas/WeightInfo"},"isReturnProhibited":{"type":"boolean","description":"Indicates whether the item is returnable or not under the regular return policy. The values are True or False.","nullable":true,"example":false},"isCustomized":{"type":"boolean","description":"Indicates whether the item is customized or not. The values are True or False.","example":false}},"additionalProperties":false,"description":"Product"},"RefundOrderGroupOrderDetail":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Order number","nullable":true}},"additionalProperties":false,"description":"OrderGroupRequest"},"RefundOrderGroupRequest":{"type":"object","properties":{"orderGroupName":{"type":"string","description":"OrderGroupName","nullable":true},"orderDetails":{"type":"array","items":{"$ref":"#/components/schemas/RefundOrderGroupOrderDetail"},"description":"Orders Details","nullable":true},"correlationId":{"type":"string","description":"CorrelationId","nullable":true},"refundReason":{"type":"string","description":"Refund Reason","nullable":true},"refundReasonId":{"type":"integer","description":"Refund Reason","format":"int32"},"refundReference":{"type":"string","description":"Refund Reference","nullable":true},"refundAmountInLocalCurrency":{"type":"number","description":"Refund Amount","format":"double"},"refundType":{"type":"string","description":"Refund Type","nullable":true},"createdBy":{"type":"string","description":"Created By","nullable":true},"entityType":{"type":"string","description":"Entity Type","nullable":true},"isFullRefund":{"type":"boolean","description":"Is Full Refund"}},"additionalProperties":false,"description":"OrderGroupRequest"},"ReplaceOrderItemsReasonCode":{"enum":\["LostPackage","DamagedGoods","ShortShip","LostReturn"],"type":"string","description":"Replace Order Reason Code"},"ReplacementOrderDetails":{"required":\["replacementBrandOrderReference","replacementLineItemId"],"type":"object","properties":{"replacementBrandOrderReference":{"minLength":1,"type":"string","description":"Retailer's unique reference number for the replacement order,","example":"653241"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’","example":"1"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true,"example":"277906"},"name":{"type":"string","description":"The name of the product.","nullable":true,"example":"PINK LOUNGE WOMENS KNIT"},"description":{"type":"string","description":"The description of the product.\r\n Example: ‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’","nullable":true,"example":"‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’"},"colour":{"type":"string","description":"The colour of the product","nullable":true,"example":"Red"},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true,"example":"S"}},"additionalProperties":false,"description":"Product"},"ResendEmailDto":{"type":"object","properties":{"orderId":{"type":"string","description":"OrderId","nullable":true},"emailId":{"type":"string","description":"Email Identifier","nullable":true}},"additionalProperties":false,"description":"Resend Email Dto"},"ResendEmailResponse":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Error Message","nullable":true},"statusCode":{"$ref":"#/components/schemas/HttpStatusCode"}},"additionalProperties":false,"description":"Resend Email Response"},"RetailerInvoice":{"type":"object","properties":{"number":{"type":"string","description":"RetailerInvoice number","nullable":true,"example":"784512"},"date":{"type":"string","description":"RetailerInvoice Date in the yyyy-MM-dd format","nullable":true,"example":"2020-05-11"}},"additionalProperties":false,"description":"RetailerInvoice details"},"ServiceLevel":{"enum":\["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."},"ShopperExperience":{"required":\["shopperCultureLanguageIso"],"type":"object","properties":{"shopperCultureLanguageIso":{"minLength":1,"type":"string","description":"Preferred language and culture experience for the shopper in the ISO 639-1 and ISO 3166 format.","example":"en-IE"},"registeredProfileId":{"type":"string","description":"Customer profile Id or number","nullable":true,"example":"44170"}},"additionalProperties":false,"description":"Shopper Experience"},"Transaction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"status":{"$ref":"#/components/schemas/TransactionStatus"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"reasonCode":{"type":"string","description":"Reason","nullable":true,"example":"LostPackage"},"lastUpdateTime":{"type":"string","description":"LastUpdateTime","format":"date-time","nullable":true},"creationTime":{"type":"string","description":"CreationTime","format":"date-time","nullable":true}},"additionalProperties":false,"description":"Transaction details"},"TransactionStatus":{"enum":\["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"},"UpdateContactDetail":{"required":\["address1","city","contactDetailsType","email","postalCode","telephone"],"type":"object","properties":{"contactDetailsType":{"$ref":"#/components/schemas/UpdateContactDetailsType"},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address.","example":"1234 Line Ave S"},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true,"example":"Apt B1"},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true,"example":"New York state"},"city":{"minLength":1,"type":"string","description":"City of the address.","example":"New York city"},"postalCode":{"minLength":1,"type":"string","description":"Postal code or zip code of the address.","example":"10001"},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true,"example":"Region"},"email":{"minLength":1,"type":"string","description":"Email address.","example":"<email@test.com>"},"telephone":{"minLength":1,"type":"string","description":"Phone number.","example":"+14211112222"}},"additionalProperties":false,"description":"Update Contact Details"},"UpdateContactDetailsType":{"enum":\["IsDelivery"],"type":"string","description":"ContactDetailsType"},"UpdateLineItemReasonCode":{"enum":\["ProductSubstituted","ProductDiscontinued","ProductNotAvailable"],"type":"string","description":"Update Line Item Reason Code"},"UpdateOrderContacts":{"required":\["actionedBy","contactDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid","example":"C857B3CD-5EB7-426D-8741-812E5ED214C0"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time","example":"2019-10-14T15:56:18.455Z"},"actionedBy":{"$ref":"#/components/schemas/ActionedBy"},"actionedByUser":{"type":"string","description":"Identifier for the person who initiated the action, for example, John Smith or <johnsmith@test.com>.","nullable":true,"example":"<johnsmith@test.com>"},"contactDetails":{"$ref":"#/components/schemas/UpdateContactDetail"}},"additionalProperties":false,"description":"Update Contact details like address info."},"WeightInfo":{"type":"object","properties":{"weightTotal":{"type":"number","description":"Total weight of the order.","format":"double"},"weightUnit":{"$ref":"#/components/schemas/WeightUnit"}},"additionalProperties":false,"description":"(Required) Attributes that describe the package weight data."},"WeightUnit":{"enum":\["KG","LB"],"type":"string","description":"Unit of measurement for the items in the package. 0 indicates KG and 1 indicates LB."}},"endpoints":\[{"method":"POST","path":"/v2/{tenantCode}/Order","summary":"Creates an order.","pathParams":\[{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderCreate"}},{"method":"PUT","path":"/v2/{tenantCode}/Order/{brandOrderReference}/ContactDetails","summary":"Update Order Contact details","pathParams":\[{"name":"brandOrderReference","required":true,"description":""},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/UpdateOrderContacts"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/OrderActivity","summary":"Cancels the entire order, that is, all line items in the ord","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order"},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderActivityRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItemActivity","summary":"Cancels or fulfils the line items fully or partially in an o","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemActivityRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItem","summary":"Creates a full or partial line item replacement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemRequest"}},{"method":"PATCH","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItem","summary":"Updates a Line Item within an order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemUpdateRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Appeasement","summary":"Adds an order level appeasement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderAppeasementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/LineItemAppeasement","summary":"Adds an item level appeasement.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/LineItemAppeasementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Replacement","summary":"Replaces Line Items within an Order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderReplacementRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Allocation","summary":"Allocates an Order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":"Retailer's unique reference number for the order."},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/OrderAllocationRequest"}},{"method":"POST","path":"/v2/{tenantCode}/Order/{brandOrderReference}/Comment","summary":"Add a comment to an order.","pathParams":\[{"name":"brandOrderReference","required":true,"description":""},{"name":"tenantCode","required":true,"description":""}],"bodySchema":{"$ref":"#/components/schemas/AddOrderCommentRequestDto"}}]}" specUrl="<https://order-transaction-api.sandbox.eshopworld.com/swagger/v2/swagger.json>" epIdx="6" method="POST" path="/v2/{tenantCode}/Order/{brandOrderReference}/Appeasement" title="Adds an order level appeasement." %}

</details>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.esw.com/order-api/resources/first-successful-requests.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.