> 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/api-reference/order-api/models.md).

# Models

## The ActionedBy object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The ActivityStatus object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ActivityStatus":{"enum":["Cancel","Fulfil"],"type":"string","description":"ActivityStatus"}}}}
```

## The AddOrderCommentRequestDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The AddOrderCommentResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The AllocationActivityStatus object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"AllocationActivityStatus":{"enum":["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"}}}}
```

## The AppeasementsReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"AppeasementsReasonCode":{"enum":["Appeasement","LostPackage","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"}}}}
```

## The AppeasementsType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"AppeasementsType":{"enum":["Merchandise","Shipping","Order"],"type":"string","description":""}}}}
```

## The ArticleAllocation object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"AllocationActivityStatus":{"enum":["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"},"LineItemActivityReasonCode":{"enum":["OutOfStock","ShopperCancel","ItemFulfilled","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"}}}}
```

## The ArticleAppeasementDetails object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}},"additionalProperties":false,"description":"Article Appeasement Details"},"LineItemAppeasementReasonCode":{"enum":["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"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."}},"additionalProperties":false,"description":""}}}}
```

## The ArticleAppeasementRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"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},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"Refund Line Item Dto"},"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."}},"additionalProperties":false,"description":"Article Appeasement Details"},"LineItemAppeasementReasonCode":{"enum":["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"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."}},"additionalProperties":false,"description":""},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The ContactDetail object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"addressId":{"type":"string","description":"Address Identifier","nullable":true},"firstName":{"minLength":1,"type":"string","description":"First name of the address."},"lastName":{"minLength":1,"type":"string","description":"Last name of the address."},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address."},"email":{"minLength":1,"type":"string","description":"Email address."},"telephone":{"minLength":1,"type":"string","description":"Phone number."},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true}},"additionalProperties":false,"description":"Contact Details"},"ContactDetailsType":{"enum":["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"},"Gender":{"enum":["None","Male","Female","Unisex"],"type":"string","description":"Gender"}}}}
```

## The ContactDetailsType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ContactDetailsType":{"enum":["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"}}}}
```

## The CurrencyDetails object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The CustomerServiceOrderArticleDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"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"},"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"},"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"},"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"},"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"}}}}
```

## The CustomerServiceOrderProduct object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The CustomerServiceOrderProductDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The CustomerServicePaymentActivity object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The CustomerServiceReturnListingDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"}}}}
```

## The DeliveryOption object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"}},"additionalProperties":false,"description":"Delivery Option"},"ServiceLevel":{"enum":["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."}}}}
```

## The DeliveryOptionCreate object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"DeliveryOptionCreate":{"required":["eshopDeliveryOptionCode","priceInfo"],"type":"object","properties":{"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"}},"additionalProperties":false,"description":"Delivery Option"},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"ServiceLevel":{"enum":["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."}}}}
```

## The EmailLabel object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The Error object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"Error":{"type":"object","properties":{"code":{"type":"integer","description":"Error Identifier code","format":"int32"},"message":{"type":"string","description":"Error Message","nullable":true}},"additionalProperties":false,"description":"Error Response"}}}}
```

## The ErrorStatus object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ErrorStatus":{"enum":["Retry","Processed","Failed","InProgress"],"type":"string","description":"Represents Order Migration/Integration event error status"}}}}
```

## The ErrorType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ErrorType":{"enum":["Migration","Integration","RecalculateAllocation","PaymentAttempt","NonCheckoutOrder","PaymentAggregate"],"type":"string","description":"Enumeration for error types to log the error for reprocessing"}}}}
```

## The FailedEventRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"ErrorType":{"enum":["Migration","Integration","RecalculateAllocation","PaymentAttempt","NonCheckoutOrder","PaymentAggregate"],"type":"string","description":"Enumeration for error types to log the error for reprocessing"},"ErrorStatus":{"enum":["Retry","Processed","Failed","InProgress"],"type":"string","description":"Represents Order Migration/Integration event error status"}}}}
```

## The FailedEventsHandlerResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"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"}}}}
```

## The FinTransDetails object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The Gender object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"Gender":{"enum":["None","Male","Female","Unisex"],"type":"string","description":"Gender"}}}}
```

## The GetOrderDetailsResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"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"},"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."},"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."},"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."},"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"},"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"},"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."},"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."},"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"},"OrderCurrenciesResponse":{"type":"object","properties":{"shopper":{"$ref":"#/components/schemas/CurrencyDetails"},"retailer":{"$ref":"#/components/schemas/CurrencyDetails"}},"additionalProperties":false,"description":"Order currencies response"},"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"},"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"},"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"},"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"},"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"},"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."},"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"},"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"},"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"},"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"},"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"},"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"},"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"}}}}
```

## The GetTransaction object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"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"},"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},"reasonCode":{"type":"string","description":"Reason","nullable":true},"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"},"NamedMoney":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge."},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"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"},"TransactionStatus":{"enum":["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The HttpStatusCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The LineItemActivityReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"LineItemActivityReasonCode":{"enum":["OutOfStock","ShopperCancel","ItemFulfilled","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"}}}}
```

## The LineItemActivityRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item. Either lineItemId or product code is required.","nullable":true},"quantity":{"type":"integer","description":"Quantity of products to cancel.","format":"int32"},"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},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"LineItemActivityRequest"},"ActivityStatus":{"enum":["Cancel","Fulfil"],"type":"string","description":"ActivityStatus"},"LineItemActivityReasonCode":{"enum":["OutOfStock","ShopperCancel","ItemFulfilled","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The LineItemAppeasementReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"LineItemAppeasementReasonCode":{"enum":["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"}}}}
```

## The LineItemAppeasementRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"productCode":{"type":"string","description":"Product code. Either lineItemId or productId is required.\r\n Example: ‘277906’","nullable":true},"quantity":{"type":"integer","description":"Quantity to appease","format":"int32"},"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."},"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},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"LineItemAppeasementRequest"},"LineItemAppeasementReasonCode":{"enum":["Appeasement","ShortShip","LostPackage","LostReturn","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"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."}},"additionalProperties":false,"description":""},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The LineItemRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"LineItemRequest":{"required":["actionedBy","quantity","reasonCode","replacementOrderDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32"},"reasonCode":{"$ref":"#/components/schemas/ReplaceOrderItemsReasonCode"},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"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,"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true},"name":{"type":"string","description":"The name of the product.","nullable":true},"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},"colour":{"type":"string","description":"The colour of the product","nullable":true},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true}},"additionalProperties":false,"description":"Product"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The LineItemUpdateRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"LineItemUpdateRequest":{"required":["actionedBy","lineItemId","productCode","quantity","reasonCode","transactionDateTime","transactionReference"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item to be updated."},"quantity":{"type":"integer","description":"Quantity to be updated.","format":"int32"},"productCode":{"minLength":1,"type":"string","description":"New product code or stock-keeping unit (SKU) number of the item."},"reasonCode":{"$ref":"#/components/schemas/UpdateLineItemReasonCode"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"Update line items request"},"UpdateLineItemReasonCode":{"enum":["ProductSubstituted","ProductDiscontinued","ProductNotAvailable"],"type":"string","description":"Update Line Item Reason Code"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The LineItemsAddRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"externalOrderId":{"type":"string","description":"ExternalOrderId.","nullable":true},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time"},"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},"shopperCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency."},"retailerCurrencyIso":{"minLength":1,"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency."},"deliveryCountryIso":{"minLength":1,"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country."},"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"},"OrderType":{"enum":["ShippingOnly","Checkout","NonCheckoutEcommerce"],"type":"string","description":"OrderType"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"},"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."},"registeredProfileId":{"type":"string","description":"Customer profile Id or number","nullable":true}},"additionalProperties":false,"description":"Shopper Experience"},"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},"addressId":{"type":"string","description":"Address Identifier","nullable":true},"firstName":{"minLength":1,"type":"string","description":"First name of the address."},"lastName":{"minLength":1,"type":"string","description":"Last name of the address."},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address."},"email":{"minLength":1,"type":"string","description":"Email address."},"telephone":{"minLength":1,"type":"string","description":"Phone number."},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true}},"additionalProperties":false,"description":"Contact Details"},"ContactDetailsType":{"enum":["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"},"Gender":{"enum":["None","Male","Female","Unisex"],"type":"string","description":"Gender"},"OrderItemToCreate":{"required":["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID."},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32"},"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},"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"},"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."},"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."},"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},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product."},"hsCode":{"type":"string","description":"HsCode.","nullable":true},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true},"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},"color":{"type":"string","description":"Color of the item.","nullable":true},"size":{"type":"string","description":"Size of the item.","nullable":true},"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},"isCustomized":{"type":"boolean","description":"Indicates whether the item is customized or not. The values are True or False."}},"additionalProperties":false,"description":"Product"},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"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."},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true},"value":{"type":"string","description":"Metadata value.","nullable":true}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."},"DeliveryOptionCreate":{"required":["eshopDeliveryOptionCode","priceInfo"],"type":"object","properties":{"priceInfo":{"$ref":"#/components/schemas/PriceInfo"},"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"}},"additionalProperties":false,"description":"Delivery Option"},"ServiceLevel":{"enum":["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."},"RetailerInvoice":{"type":"object","properties":{"number":{"type":"string","description":"RetailerInvoice number","nullable":true},"date":{"type":"string","description":"RetailerInvoice Date in the yyyy-MM-dd format","nullable":true}},"additionalProperties":false,"description":"RetailerInvoice details"},"Payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method used","nullable":true},"last4Digits":{"type":"string","description":"Last 4 digits of the payment card","nullable":true},"paymentAttemptRef":{"type":"string","description":"Payment attempt reference","format":"uuid","nullable":true},"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"},"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},"lastName":{"type":"string","description":"Last name of the address.","nullable":true},"telephone":{"type":"string","description":"Phone number.","nullable":true},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true},"addressId":{"type":"string","description":"Address Identifier","nullable":true},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address."},"email":{"minLength":1,"type":"string","description":"Email address."},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true}},"additionalProperties":false,"description":"Origin Details"},"OriginType":{"enum":["None","Store"],"type":"string","description":"Payment methods"}}}}
```

## The MetadataItem object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true},"value":{"type":"string","description":"Metadata value.","nullable":true}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."}}}}
```

## The Money object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"}}}}
```

## The NamedMoney object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"NamedMoney":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge."},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"}}}}
```

## The Order object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"Order":{"type":"object","properties":{"orderType":{"$ref":"#/components/schemas/OrderType"},"orderGuid":{"type":"string","description":"Order GUID.","format":"uuid"},"status":{"$ref":"#/components/schemas/OrderStatuses"},"brandOrderReference":{"type":"string","description":"The brand's order number.","nullable":true},"parentBrandOrderReference":{"type":"string","description":"The parent order number.","nullable":true},"eShopWorldOrderNumber":{"type":"string","description":"Order number in the eshopWorld system.","nullable":true},"shopperCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the shopper currency.","nullable":true},"retailerCurrencyIso":{"type":"string","description":"ISO 4217 format three-letter identifier for the retailer's currency.","nullable":true},"deliveryCountryIso":{"type":"string","description":"ISO 3166 format two-letter country identifier for the delivery country.","nullable":true},"orderDate":{"type":"string","description":"The datetime when the order was created, in UTC.","format":"date-time"},"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"},"OrderType":{"enum":["ShippingOnly","Checkout","NonCheckoutEcommerce"],"type":"string","description":"OrderType"},"OrderStatuses":{"enum":["Received","Cancelled"],"type":"string","description":"Order statuses."},"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."},"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."},"registeredProfileId":{"type":"string","description":"Customer profile Id or number","nullable":true}},"additionalProperties":false,"description":"Shopper Experience"},"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},"addressId":{"type":"string","description":"Address Identifier","nullable":true},"firstName":{"minLength":1,"type":"string","description":"First name of the address."},"lastName":{"minLength":1,"type":"string","description":"Last name of the address."},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address."},"email":{"minLength":1,"type":"string","description":"Email address."},"telephone":{"minLength":1,"type":"string","description":"Phone number."},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true}},"additionalProperties":false,"description":"Contact Details"},"ContactDetailsType":{"enum":["IsDelivery","IsPayment","IsDeliveryAndPayment","IsStoreDelivery"],"type":"string","description":"ContactDetailsType"},"Gender":{"enum":["None","Male","Female","Unisex"],"type":"string","description":"Gender"},"OrderItem":{"required":["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID."},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32"},"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},"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"},"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."},"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."},"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},"prohibitedItem":{"type":"boolean","description":"Indicates whether the item is prohibited"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product."},"hsCode":{"type":"string","description":"HsCode.","nullable":true},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true},"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},"color":{"type":"string","description":"Color of the item.","nullable":true},"size":{"type":"string","description":"Size of the item.","nullable":true},"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"},"taxCode":{"type":"string","description":"Tax code","nullable":true}},"additionalProperties":false,"description":"Product"},"OrderArticle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Article sequence within the line item","format":"int32"},"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"},"OrderArticleStatuses":{"enum":["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"},"NamedMoney":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge."},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true},"value":{"type":"string","description":"Metadata value.","nullable":true}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."},"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"}},"additionalProperties":false,"description":"Delivery Option"},"ServiceLevel":{"enum":["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."},"Payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method used","nullable":true},"last4Digits":{"type":"string","description":"Last 4 digits of the payment card","nullable":true},"paymentAttemptRef":{"type":"string","description":"Payment attempt reference","format":"uuid","nullable":true},"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"},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"RetailerInvoice":{"type":"object","properties":{"number":{"type":"string","description":"RetailerInvoice number","nullable":true},"date":{"type":"string","description":"RetailerInvoice Date in the yyyy-MM-dd format","nullable":true}},"additionalProperties":false,"description":"RetailerInvoice details"},"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},"lastName":{"type":"string","description":"Last name of the address.","nullable":true},"telephone":{"type":"string","description":"Phone number.","nullable":true},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true},"addressId":{"type":"string","description":"Address Identifier","nullable":true},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address."},"email":{"minLength":1,"type":"string","description":"Email address."},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true}},"additionalProperties":false,"description":"Origin Details"},"OriginType":{"enum":["None","Store"],"type":"string","description":"Payment methods"},"Transaction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"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"},"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},"reasonCode":{"type":"string","description":"Reason","nullable":true},"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"},"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"},"TransactionStatus":{"enum":["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The OrderActivityReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderActivityReasonCode":{"enum":["ShopperCancel","RetailerCancel","Fraud","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"}}}}
```

## The OrderActivityRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"OrderActivityRequest"},"ActivityStatus":{"enum":["Cancel","Fulfil"],"type":"string","description":"ActivityStatus"},"OrderActivityReasonCode":{"enum":["ShopperCancel","RetailerCancel","Fraud","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The OrderAddressDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderAddressResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderAllocationRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"OrderAllocationRequest"},"OrderItemAllocation":{"required":["articles","lineItemId","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item id"},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"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"},"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"},"AllocationActivityStatus":{"enum":["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"},"LineItemActivityReasonCode":{"enum":["OutOfStock","ShopperCancel","ItemFulfilled","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The OrderAppeasementRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":""},"AppeasementsType":{"enum":["Merchandise","Shipping","Order"],"type":"string","description":""},"AppeasementsReasonCode":{"enum":["Appeasement","LostPackage","LateArrival","PromoAppeasement"],"type":"string","description":"Note: Please make sure it matches StandardDev Lookup.RefundReason Table"},"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."}},"additionalProperties":false,"description":""},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The OrderArticle object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderArticle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Article sequence within the line item","format":"int32"},"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"},"OrderArticleStatuses":{"enum":["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"},"NamedMoney":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge."},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"}}}}
```

## The OrderArticleRefund object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderArticleRefundDetail object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}}}}
```

## The OrderArticleRefundDetailDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderArticleRefundDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderArticleStatusSummary object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderArticleStatusSummaryDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderArticleStatuses object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderArticleStatuses":{"enum":["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"}}}}
```

## The OrderArticlesResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"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"},"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"},"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."}}}}
```

## The OrderBalanceResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderChargeResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}}}}
```

## The OrderCurrenciesResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderCurrenciesResponse":{"type":"object","properties":{"shopper":{"$ref":"#/components/schemas/CurrencyDetails"},"retailer":{"$ref":"#/components/schemas/CurrencyDetails"}},"additionalProperties":false,"description":"Order currencies response"},"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"}}}}
```

## The OrderEmailDetail object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"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"}}}}
```

## The OrderEstimatedDeliveryResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderGroup object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}}}}
```

## The OrderItem object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderItem":{"required":["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID."},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32"},"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},"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"},"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."},"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."},"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},"prohibitedItem":{"type":"boolean","description":"Indicates whether the item is prohibited"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product."},"hsCode":{"type":"string","description":"HsCode.","nullable":true},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true},"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},"color":{"type":"string","description":"Color of the item.","nullable":true},"size":{"type":"string","description":"Size of the item.","nullable":true},"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"},"taxCode":{"type":"string","description":"Tax code","nullable":true}},"additionalProperties":false,"description":"Product"},"OrderArticle":{"type":"object","properties":{"sequence":{"type":"integer","description":"Article sequence within the line item","format":"int32"},"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"},"OrderArticleStatuses":{"enum":["Created","Shipped","Cancelled"],"type":"string","description":"Order article statuses"},"NamedMoney":{"required":["name"],"type":"object","properties":{"name":{"minLength":1,"type":"string","description":"Name of the charge."},"value":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Money"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true},"value":{"type":"string","description":"Metadata value.","nullable":true}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."}}}}
```

## The OrderItemAllocation object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderItemAllocation":{"required":["articles","lineItemId","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Line item id"},"quantity":{"type":"integer","description":"Quantity","format":"int32"},"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"},"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"},"AllocationActivityStatus":{"enum":["Cancel","Allocate"],"type":"string","description":"AllocationActivityStatus"},"LineItemActivityReasonCode":{"enum":["OutOfStock","ShopperCancel","ItemFulfilled","UnableToFulfil"],"type":"string","description":"Order Activity Reason Code"}}}}
```

## The OrderItemReplacement object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderItemReplacement":{"required":["quantity","replacementOrderDetails"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32"},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"ReplacementOrderDetails":{"required":["replacementBrandOrderReference","replacementLineItemId"],"type":"object","properties":{"replacementBrandOrderReference":{"minLength":1,"type":"string","description":"Retailer's unique reference number for the replacement order,"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true},"name":{"type":"string","description":"The name of the product.","nullable":true},"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},"colour":{"type":"string","description":"The colour of the product","nullable":true},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true}},"additionalProperties":false,"description":"Product"}}}}
```

## The OrderItemToCreate object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderItemToCreate":{"required":["lineItemId","product","quantity"],"type":"object","properties":{"lineItemId":{"minLength":1,"type":"string","description":"Item sequence or line item ID."},"quantity":{"type":"integer","description":"Number of product pieces. Matches the length of the articles property","format":"int32"},"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},"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"},"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."},"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."},"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},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product."},"hsCode":{"type":"string","description":"HsCode.","nullable":true},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true},"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},"color":{"type":"string","description":"Color of the item.","nullable":true},"size":{"type":"string","description":"Size of the item.","nullable":true},"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},"isCustomized":{"type":"boolean","description":"Indicates whether the item is customized or not. The values are True or False."}},"additionalProperties":false,"description":"Product"},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"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."},"MetadataItem":{"type":"object","properties":{"name":{"type":"string","description":"Metadata name/key.","nullable":true},"value":{"type":"string","description":"Metadata value.","nullable":true}},"additionalProperties":false,"description":"Key and value pairs to pass metadata information."}}}}
```

## The OrderPackage object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderPackageAddress object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderPackageArticle object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderPaymentDetail object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderPaymentResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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"}}}}
```

## The OrderProRataRefundResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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."}}}}
```

## The OrderRefundResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}}}}
```

## The OrderReplacementReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderReplacementReasonCode":{"enum":["LostPackage","DamagedGoods","ShortShip","LostReturn","IncorrectSize","IncorrectProduct","ProductNotAsExpected","ShopperRemorse"],"type":"string","description":"Order Replacement Reason Code"}}}}
```

## The OrderReplacementRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order transaction in UTC.","format":"date-time"},"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}},"additionalProperties":false,"description":"OrderReplacementRequest"},"OrderItemReplacement":{"required":["quantity","replacementOrderDetails"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Line item to be replaced","nullable":true},"productCode":{"type":"string","description":"Product code or stock-keeping unit (SKU) number of the item.","nullable":true},"quantity":{"type":"integer","description":"Quantity to replace.","format":"int32"},"replacementOrderDetails":{"$ref":"#/components/schemas/ReplacementOrderDetails"}},"additionalProperties":false,"description":"Defines the model to be used when replacing a line item"},"ReplacementOrderDetails":{"required":["replacementBrandOrderReference","replacementLineItemId"],"type":"object","properties":{"replacementBrandOrderReference":{"minLength":1,"type":"string","description":"Retailer's unique reference number for the replacement order,"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true},"name":{"type":"string","description":"The name of the product.","nullable":true},"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},"colour":{"type":"string","description":"The colour of the product","nullable":true},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true}},"additionalProperties":false,"description":"Product"},"OrderReplacementReasonCode":{"enum":["LostPackage","DamagedGoods","ShortShip","LostReturn","IncorrectSize","IncorrectProduct","ProductNotAsExpected","ShopperRemorse"],"type":"string","description":"Order Replacement Reason Code"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The OrderReplacementsResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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"},"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"},"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"},"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"},"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"},"CustomerServiceReturnListingDto":{"type":"object","properties":{"returnOrderNumber":{"type":"integer","description":"Return Order Number","format":"int64"}},"additionalProperties":false,"description":"CustomerServiceReturnListingDto"},"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"}}}}
```

## The OrderStatuses object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderStatuses":{"enum":["Received","Cancelled"],"type":"string","description":"Order statuses."}}}}
```

## The OrderTransactionApiResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}},"additionalProperties":false,"description":"Response from Order API"}}}}
```

## The OrderTransactionType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The OrderType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OrderType":{"enum":["ShippingOnly","Checkout","NonCheckoutEcommerce"],"type":"string","description":"OrderType"}}}}
```

## The OriginDetails object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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},"lastName":{"type":"string","description":"Last name of the address.","nullable":true},"telephone":{"type":"string","description":"Phone number.","nullable":true},"nickName":{"type":"string","description":"Nickname or identifier for the contact information.","nullable":true},"addressId":{"type":"string","description":"Address Identifier","nullable":true},"address1":{"minLength":1,"type":"string","description":"Address line 1 of the address."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"type":"string","description":"Postal code or zip code of the address.","nullable":true},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"country":{"minLength":1,"type":"string","description":"ISO 3166 two-letter country code of the address."},"email":{"minLength":1,"type":"string","description":"Email address."},"gender":{"$ref":"#/components/schemas/Gender"},"poBox":{"type":"string","description":"Postal order box of the address.","nullable":true}},"additionalProperties":false,"description":"Origin Details"},"OriginType":{"enum":["None","Store"],"type":"string","description":"Payment methods"},"Gender":{"enum":["None","Male","Female","Unisex"],"type":"string","description":"Gender"}}}}
```

## The OriginType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"OriginType":{"enum":["None","Store"],"type":"string","description":"Payment methods"}}}}
```

## The Payment object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"Payment":{"type":"object","properties":{"method":{"type":"string","description":"Payment method used","nullable":true},"last4Digits":{"type":"string","description":"Last 4 digits of the payment card","nullable":true},"paymentAttemptRef":{"type":"string","description":"Payment attempt reference","format":"uuid","nullable":true},"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"},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"}}}}
```

## The Price object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}},"additionalProperties":false,"description":""}}}}
```

## The PriceInfo object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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":{}}}}}
```

## The Product object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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."},"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},"prohibitedItem":{"type":"boolean","description":"Indicates whether the item is prohibited"},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product."},"hsCode":{"type":"string","description":"HsCode.","nullable":true},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true},"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},"color":{"type":"string","description":"Color of the item.","nullable":true},"size":{"type":"string","description":"Size of the item.","nullable":true},"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},"vatRate":{"type":"number","description":"Vat rate","format":"double"},"taxCode":{"type":"string","description":"Tax code","nullable":true}},"additionalProperties":false,"description":"Product"}}}}
```

## The ProductCreate object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"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."},"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},"productCode":{"minLength":1,"type":"string","description":"Unique identification code or SKU for the product."},"hsCode":{"type":"string","description":"HsCode.","nullable":true},"countryOfOriginIso":{"type":"string","description":"CountryOfOrigin.","nullable":true},"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},"color":{"type":"string","description":"Color of the item.","nullable":true},"size":{"type":"string","description":"Size of the item.","nullable":true},"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},"isCustomized":{"type":"boolean","description":"Indicates whether the item is customized or not. The values are True or False."}},"additionalProperties":false,"description":"Product"},"PriceInfo":{"type":"object","properties":{"price":{"$ref":"#/components/schemas/Money"}},"additionalProperties":false,"description":"Price Info"},"Money":{"type":"object","properties":{"currency":{"type":"string","description":"Currency three-letter identifier (in the ISO 4217 format).","nullable":true},"amount":{"type":"string","description":"The amount of the currency.","nullable":true}},"additionalProperties":false,"description":"Money"},"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."}}}}
```

## The RefundOrderGroupOrderDetail object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"RefundOrderGroupOrderDetail":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Order number","nullable":true}},"additionalProperties":false,"description":"OrderGroupRequest"}}}}
```

## The RefundOrderGroupRequest object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"},"RefundOrderGroupOrderDetail":{"type":"object","properties":{"orderNumber":{"type":"string","description":"Order number","nullable":true}},"additionalProperties":false,"description":"OrderGroupRequest"}}}}
```

## The ReplaceOrderItemsReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ReplaceOrderItemsReasonCode":{"enum":["LostPackage","DamagedGoods","ShortShip","LostReturn"],"type":"string","description":"Replace Order Reason Code"}}}}
```

## The ReplacementOrderDetails object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ReplacementOrderDetails":{"required":["replacementBrandOrderReference","replacementLineItemId"],"type":"object","properties":{"replacementBrandOrderReference":{"minLength":1,"type":"string","description":"Retailer's unique reference number for the replacement order,"},"replacementLineItemId":{"minLength":1,"type":"string","description":"Line Item Id of the replacement articles Example: ‘1’"},"replacementProduct":{"$ref":"#/components/schemas/ReplacementProduct"}},"additionalProperties":false,"description":"ReplacementOrderDetails"},"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true},"name":{"type":"string","description":"The name of the product.","nullable":true},"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},"colour":{"type":"string","description":"The colour of the product","nullable":true},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true}},"additionalProperties":false,"description":"Product"}}}}
```

## The ReplacementProduct object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ReplacementProduct":{"type":"object","properties":{"productCode":{"type":"string","description":"Example: ‘277906’","nullable":true},"name":{"type":"string","description":"The name of the product.","nullable":true},"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},"colour":{"type":"string","description":"The colour of the product","nullable":true},"size":{"type":"string","description":"The size of the product. Example: ‘S’","nullable":true}},"additionalProperties":false,"description":"Product"}}}}
```

## The ResendEmailDto object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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"}}}}
```

## The ResendEmailResponse object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ResendEmailResponse":{"type":"object","properties":{"errorMessage":{"type":"string","description":"Error Message","nullable":true},"statusCode":{"$ref":"#/components/schemas/HttpStatusCode"}},"additionalProperties":false,"description":"Resend Email Response"},"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"}}}}
```

## The RetailerInvoice object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"RetailerInvoice":{"type":"object","properties":{"number":{"type":"string","description":"RetailerInvoice number","nullable":true},"date":{"type":"string","description":"RetailerInvoice Date in the yyyy-MM-dd format","nullable":true}},"additionalProperties":false,"description":"RetailerInvoice details"}}}}
```

## The ServiceLevel object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"ServiceLevel":{"enum":["DEFAULT","POST","EXP1","EXP2","RussiaExpress","Standard","PUDO"],"type":"string","description":"Service Levels."}}}}
```

## The ShopperExperience object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"registeredProfileId":{"type":"string","description":"Customer profile Id or number","nullable":true}},"additionalProperties":false,"description":"Shopper Experience"}}}}
```

## The Transaction object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"Transaction":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/OrderTransactionType"},"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"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"},"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},"reasonCode":{"type":"string","description":"Reason","nullable":true},"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"},"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"},"TransactionStatus":{"enum":["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"}}}}
```

## The TransactionStatus object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"TransactionStatus":{"enum":["Unprocessed","InProgress","Processed","Failed"],"type":"string","description":"Transaction Status"}}}}
```

## The UpdateContactDetail object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"minLength":1,"type":"string","description":"Postal code or zip code of the address."},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"email":{"minLength":1,"type":"string","description":"Email address."},"telephone":{"minLength":1,"type":"string","description":"Phone number."}},"additionalProperties":false,"description":"Update Contact Details"},"UpdateContactDetailsType":{"enum":["IsDelivery"],"type":"string","description":"ContactDetailsType"}}}}
```

## The UpdateContactDetailsType object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"UpdateContactDetailsType":{"enum":["IsDelivery"],"type":"string","description":"ContactDetailsType"}}}}
```

## The UpdateLineItemReasonCode object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"UpdateLineItemReasonCode":{"enum":["ProductSubstituted","ProductDiscontinued","ProductNotAvailable"],"type":"string","description":"Update Line Item Reason Code"}}}}
```

## The UpdateOrderContacts object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"UpdateOrderContacts":{"required":["actionedBy","contactDetails","transactionDateTime","transactionReference"],"type":"object","properties":{"transactionReference":{"type":"string","description":"Unique reference number of the transaction","format":"uuid"},"transactionDateTime":{"type":"string","description":"The date/time logged by the retailer for the creation of the order in UTC.","format":"date-time"},"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},"contactDetails":{"$ref":"#/components/schemas/UpdateContactDetail"}},"additionalProperties":false,"description":"Update Contact details like address info."},"ActionedBy":{"enum":["Retailer","Shopper","EShopWorld","ThirdParty"],"type":"string","description":"To define Who initiated the request"},"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."},"address2":{"type":"string","description":"Address line 2 of the address.","nullable":true},"address3":{"type":"string","description":"Address line 3 of the address.","nullable":true},"city":{"minLength":1,"type":"string","description":"City of the address."},"postalCode":{"minLength":1,"type":"string","description":"Postal code or zip code of the address."},"region":{"type":"string","description":"Region, province, state, or county of the address. ISO can be provided, if available.","nullable":true},"email":{"minLength":1,"type":"string","description":"Email address."},"telephone":{"minLength":1,"type":"string","description":"Phone number."}},"additionalProperties":false,"description":"Update Contact Details"},"UpdateContactDetailsType":{"enum":["IsDelivery"],"type":"string","description":"ContactDetailsType"}}}}
```

## The WeightInfo object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"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."}}}}
```

## The WeightUnit object

```json
{"openapi":"3.0.1","info":{"title":"Order Transaction API","version":"v2"},"components":{"schemas":{"WeightUnit":{"enum":["KG","LB"],"type":"string","description":"Unit of measurement for the items in the package. 0 indicates KG and 1 indicates LB."}}}}
```


---

# 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/api-reference/order-api/models.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.