{ "openapi": "3.0.4", "info": { "title": "Order", "description": "Api in charge of managing order operations.", "version": "2.0" }, "paths": { "/api/v2/Order": { "post": { "tags": [ "Order" ], "summary": "Creates an order.", "operationId": "OrderCreate", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreate" } } } }, "responses": { "202": { "description": "The request is accepted, but not processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionApiResponse" } } } }, "400": { "description": "The request is invalid", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/LineItems": { "post": { "tags": [ "Order" ], "summary": "Adds items to an order. Creates order if it doesn't exist.", "operationId": "LineItems", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineItemsAddRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionApiResponse" } } } }, "400": { "description": "The request is invalid", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}": { "get": { "tags": [ "Order" ], "summary": "Retrieves an order.", "description": "Method to return order details by brand order reference", "operationId": "GetOrder", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Order Details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/Transaction/{transactionReference}": { "get": { "tags": [ "Order" ], "summary": "Retrieves an order transaction.", "description": "Method to return transaction details", "operationId": "GetOrderTransaction", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "transactionReference", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Order Details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransaction" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/ContactDetails": { "put": { "tags": [ "Order" ], "summary": "Update Order Contact details", "description": "Method to update Order Address info by using brand order reference", "operationId": "ContactDetails", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrderContacts" } } } }, "responses": { "202": { "description": "The request is accepted, but not processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionApiResponse" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/OrderActivity": { "post": { "tags": [ "Order" ], "summary": "Cancels the entire order, that is, all line items in the order are cancelled.", "description": "Method to cancel an order by brand order reference", "operationId": "OrderActivity", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order Activity Details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderActivityRequest" } } } }, "responses": { "202": { "description": "The request is accepted, but not processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionApiResponse" } } } }, "400": { "description": "The request is invalid", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/LineItemActivity": { "post": { "tags": [ "Order" ], "summary": "Cancels or fulfils the line items fully or partially in an order as per activityStatus.", "description": "Method to cancel or fulfil a line item", "operationId": "LineItemActivity", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Line item cancel/fulfil request details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineItemActivityRequest" } } } }, "responses": { "202": { "description": "The request is accepted, but not processed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderTransactionApiResponse" } } } }, "400": { "description": "The request is invalid", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } }, "404": { "description": "No order or line item found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/LineItem": { "post": { "tags": [ "Order" ], "summary": "Creates a full or partial line item replacement.", "description": "Method to replace a line item", "operationId": "LineItem", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order replacement details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineItemRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Line Item replacement successfully processed" }, "500": { "description": "Internal server error" } } }, "patch": { "tags": [ "Order" ], "summary": "Updates a Line Item within an order.", "description": "Method to update a line item.", "operationId": "UpdateLineItem", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Line Item update details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineItemUpdateRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Line Item replacement successfully processed" }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/Appeasement": { "post": { "tags": [ "Order" ], "summary": "Adds an order level appeasement.", "description": "Method to appease an order", "operationId": "Appeasement", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order Appeasements Details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAppeasementRequest" } } } }, "responses": { "202": { "description": "Accepted" }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Error" } } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Order Appeasements successfully processed" }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/LineItemAppeasement": { "post": { "tags": [ "Order" ], "summary": "Adds an item level appeasement.", "description": "Method to appease a line item", "operationId": "LineItemAppeasement", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order.Transaction.Domain.Model.DTO.v2.LineItemAppeasementRequestOrders Item Level Appeasements", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LineItemAppeasementRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request is invalid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Line Item Level Appeasements successfully processed" }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/Replacement": { "post": { "tags": [ "Order" ], "summary": "Replaces Line Items within an Order.", "description": "Method to replace multiple line items within an order.", "operationId": "OrderReplacement", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order Replacement details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderReplacementRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Line Items replacement successfully processed" }, "500": { "description": "Internal server error" } } } }, "/api/v2/Order/{brandOrderReference}/Allocation": { "post": { "tags": [ "Order" ], "summary": "Allocates an Order.", "description": "Method to allocate an order.", "operationId": "OrderAllocation", "parameters": [ { "name": "brandOrderReference", "in": "path", "description": "Retailer's unique reference number for the order.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Order Allocation details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderAllocationRequest" } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "string" } } } }, "400": { "description": "The request is not valid", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No order found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "The request is unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "The request is forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "default": { "description": "Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "200": { "description": "Order allocation successfully processed" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "ActionedBy": { "enum": [ "Retailer", "Shopper", "EShopWorld" ], "type": "string", "description": "To define Who initiated the request" }, "ActivityStatus": { "enum": [ "Cancel", "Fulfil" ], "type": "string", "description": "ActivityStatus" }, "AllocationActivityStatus": { "enum": [ "Cancel", "Allocate" ], "type": "string", "description": "AllocationActivityStatus" }, "AppeasementsReasonCode": { "enum": [ "Appeasement", "LostPackage", "LateArrival", "PromoAppeasement" ], "type": "string", "description": "Note: Please make sure it matches StandardDev Lookup.RefundReason Table" }, "AppeasementsType": { "enum": [ "Merchandise", "Shipping", "Order" ], "type": "string", "description": "" }, "ArticleAllocation": { "required": [ "activityStatus", "fulfilmentCountryIso" ], "type": "object", "properties": { "activityStatus": { "$ref": "#/components/schemas/AllocationActivityStatus" }, "fulfilmentCountryIso": { "minLength": 1, "type": "string", "description": "Fulfilment country ISO" }, "fulfilmentCentreId": { "type": "string", "description": "Fulfilment centre Id", "nullable": true }, "reasonCode": { "$ref": "#/components/schemas/LineItemActivityReasonCode" } }, "additionalProperties": false, "description": "Article allocation" }, "ContactDetail": { "required": [ "address1", "city", "contactDetailsType", "country", "email", "firstName", "lastName", "telephone" ], "type": "object", "properties": { "contactDetailsType": { "$ref": "#/components/schemas/ContactDetailsType" }, "nickName": { "type": "string", "description": "Nickname or identifier for the contact information.", "nullable": true, "example": "NickName" }, "addressId": { "type": "string", "description": "Address Identifier", "nullable": true, "example": "AD12345" }, "firstName": { "minLength": 1, "type": "string", "description": "First name of the address.", "example": "John " }, "lastName": { "minLength": 1, "type": "string", "description": "Last name of the address.", "example": "Smith" }, "address1": { "minLength": 1, "type": "string", "description": "Address line 1 of the address.", "example": "1234 Line Ave S" }, "address2": { "type": "string", "description": "Address line 2 of the address.", "nullable": true, "example": "Apt B1" }, "address3": { "type": "string", "description": "Address line 3 of the address.", "nullable": true, "example": "New York state" }, "city": { "minLength": 1, "type": "string", "description": "City of the address.", "example": "New York city" }, "postalCode": { "type": "string", "description": "Postal code or zip code of the address.", "nullable": true, "example": "10001" }, "region": { "type": "string", "description": "Region, province, state, or county of the address. ISO can be provided, if available.", "nullable": true, "example": "Region" }, "country": { "minLength": 1, "type": "string", "description": "ISO 3166 two-letter country code of the address.", "example": "US" }, "email": { "minLength": 1, "type": "string", "description": "Email address.", "example": "email@test.com" }, "telephone": { "minLength": 1, "type": "string", "description": "Phone number.", "example": "+14211112222" }, "gender": { "$ref": "#/components/schemas/Gender" }, "poBox": { "type": "string", "description": "Postal order box of the address.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Contact Details" }, "ContactDetailsType": { "enum": [ "IsDelivery", "IsPayment", "IsDeliveryAndPayment", "IsStoreDelivery" ], "type": "string", "description": "ContactDetailsType" }, "DeliveryOption": { "required": [ "eshopDeliveryOptionCode" ], "type": "object", "properties": { "eshopDeliveryOptionCode": { "$ref": "#/components/schemas/ServiceLevel" }, "estimatedDeliveryDateToShopper": { "type": "string", "description": "Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.", "format": "date-time", "nullable": true, "example": "\"2020-08-31T11:54:24.631Z\"" }, "vatRate": { "type": "number", "description": "Vat rate", "format": "double", "example": 21 } }, "additionalProperties": false, "description": "Delivery Option" }, "DeliveryOptionCreate": { "required": [ "eshopDeliveryOptionCode", "priceInfo" ], "type": "object", "properties": { "eshopDeliveryOptionCode": { "$ref": "#/components/schemas/ServiceLevel" }, "estimatedDeliveryDateToShopper": { "type": "string", "description": "Estimated delivery date of the items in the cart in the ISO 8601 format for the non-eShopWorld delivery option. This date is the expected final delivery date to the shopper.", "format": "date-time", "nullable": true, "example": "\"2020-08-31T11:54:24.631Z\"" }, "priceInfo": { "$ref": "#/components/schemas/PriceInfo" } }, "additionalProperties": false, "description": "Delivery Option" }, "Error": { "type": "object", "properties": { "code": { "type": "integer", "description": "Error Identifier code", "format": "int32", "example": 1 }, "message": { "type": "string", "description": "Error Message", "nullable": true, "example": "Invalid BrandOrderReference" } }, "additionalProperties": false, "description": "Error Response" }, "Gender": { "enum": [ "None", "Male", "Female", "Unisex" ], "type": "string", "description": "Gender" }, "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/TransactionType" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "status": { "$ref": "#/components/schemas/TransactionStatus" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" }, "reasonCode": { "type": "string", "description": "Reason", "nullable": true, "example": "LostPackage" }, "lastUpdateTime": { "type": "string", "description": "LastUpdateTime", "format": "date-time", "nullable": true }, "creationTime": { "type": "string", "description": "CreationTime", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Get Full Transaction Details which includes refund amount" }, "LineItemActivityReasonCode": { "enum": [ "OutOfStock", "ShopperCancel", "ItemFulfilled" ], "type": "string", "description": "Order Activity Reason Code" }, "LineItemActivityRequest": { "required": [ "actionedBy", "activityStatus", "quantity", "reasonCode", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "lineItemId": { "type": "string", "description": "The Id of the line item to cancel. Either lineItemId or product code is required.", "nullable": true, "example": "1" }, "productCode": { "type": "string", "description": "Product code or stock-keeping unit (SKU) number of the item. Either lineItemId or product code is required.", "nullable": true, "example": "241563" }, "quantity": { "type": "integer", "description": "Quantity of products to cancel.", "format": "int32", "example": 2 }, "activityStatus": { "$ref": "#/components/schemas/ActivityStatus" }, "reasonCode": { "$ref": "#/components/schemas/LineItemActivityReasonCode" }, "settlementReference": { "type": "string", "description": "Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.", "nullable": true, "example": "657100201" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "LineItemActivityRequest" }, "LineItemAppeasementReasonCode": { "enum": [ "Appeasement", "ShortShip", "LostPackage", "LostReturn", "LateArrival", "PromoAppeasement" ], "type": "string", "description": "Note: Please make sure it matches StandardDev Lookup.RefundReason Table" }, "LineItemAppeasementRequest": { "required": [ "actionedBy", "quantity", "reasonCode", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "lineItemId": { "type": "string", "description": "The Id of the line item to appease. Either lineItemId or product code is required.", "nullable": true, "example": "1" }, "productCode": { "type": "string", "description": "Product code. Either lineItemId or productId is required.\r\n Example: ‘277906’", "nullable": true, "example": "277906" }, "quantity": { "type": "integer", "description": "Quantity to appease", "format": "int32", "example": 2 }, "reasonCode": { "$ref": "#/components/schemas/LineItemAppeasementReasonCode" }, "transaction": { "$ref": "#/components/schemas/Price" }, "fullAppeasement": { "type": "boolean", "description": "Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.", "example": false }, "settlementReference": { "type": "string", "description": "Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.", "nullable": true, "example": "657100201" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "LineItemAppeasementRequest" }, "LineItemRequest": { "required": [ "actionedBy", "quantity", "reasonCode", "replacementOrderDetails", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Line item to be replaced", "nullable": true, "example": "2" }, "productCode": { "type": "string", "description": "Product code or stock-keeping unit (SKU) number of the item.", "nullable": true, "example": "277906" }, "quantity": { "type": "integer", "description": "Quantity to replace.", "format": "int32", "example": 2 }, "reasonCode": { "$ref": "#/components/schemas/ReplaceOrderItemsReasonCode" }, "replacementOrderDetails": { "$ref": "#/components/schemas/ReplacementOrderDetails" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "Defines the model to be used when replacing a line item" }, "LineItemUpdateRequest": { "required": [ "actionedBy", "lineItemId", "productCode", "quantity", "reasonCode", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "lineItemId": { "minLength": 1, "type": "string", "description": "Line item to be updated.", "example": "2" }, "quantity": { "type": "integer", "description": "Quantity to be updated.", "format": "int32", "example": 2 }, "productCode": { "minLength": 1, "type": "string", "description": "New product code or stock-keeping unit (SKU) number of the item.", "example": "277906" }, "reasonCode": { "$ref": "#/components/schemas/UpdateLineItemReasonCode" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "Update line items request" }, "LineItemsAddRequest": { "required": [ "actionedBy", "contactDetails", "deliveryCountryIso", "deliveryOption", "lineItems", "orderType", "retailerCurrencyIso", "shopperCurrencyIso", "shopperExperience", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "orderType": { "$ref": "#/components/schemas/OrderType" }, "parentBrandOrderReference": { "type": "string", "description": "The parent order number.", "nullable": true, "example": "P12345" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" }, "shopperCurrencyIso": { "minLength": 1, "type": "string", "description": "ISO 4217 format three-letter identifier for the shopper currency.", "example": "EUR" }, "retailerCurrencyIso": { "minLength": 1, "type": "string", "description": "ISO 4217 format three-letter identifier for the retailer's currency.", "example": "USD" }, "deliveryCountryIso": { "minLength": 1, "type": "string", "description": "ISO 3166 format two-letter country identifier for the delivery country.", "example": "IE" }, "shopperExperience": { "$ref": "#/components/schemas/ShopperExperience" }, "contactDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetail" }, "description": "Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last." }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemToCreate" }, "description": "Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required." }, "deliveryOption": { "$ref": "#/components/schemas/DeliveryOptionCreate" }, "retailerInvoice": { "$ref": "#/components/schemas/RetailerInvoice" }, "payment": { "$ref": "#/components/schemas/Payment" }, "originDetails": { "$ref": "#/components/schemas/OriginDetails" }, "metadataItems": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItem" }, "description": "Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.", "nullable": true } }, "additionalProperties": false, "description": "Add line items request" }, "MetadataItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Metadata name/key.", "nullable": true, "example": "KeyName" }, "value": { "type": "string", "description": "Metadata value.", "nullable": true, "example": "KeyValue" } }, "additionalProperties": false, "description": "Key and value pairs to pass metadata information." }, "Money": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency three-letter identifier (in the ISO 4217 format).", "nullable": true, "example": "EUR" }, "amount": { "type": "string", "description": "The amount of the currency.", "nullable": true, "example": "100.00" } }, "additionalProperties": false, "description": "Money" }, "NamedMoney": { "required": [ "name" ], "type": "object", "properties": { "name": { "minLength": 1, "type": "string", "description": "Name of the charge.", "example": "ItemTaxes" }, "value": { "$ref": "#/components/schemas/Money" } }, "additionalProperties": false, "description": "Money" }, "Order": { "type": "object", "properties": { "orderType": { "$ref": "#/components/schemas/OrderType" }, "orderGuid": { "type": "string", "description": "Order GUID.", "format": "uuid", "example": "b785ef18-046e-471c-8470-727c7db0ce6e" }, "status": { "$ref": "#/components/schemas/OrderStatuses" }, "brandOrderReference": { "type": "string", "description": "The brand's order number.", "nullable": true, "example": "78451296" }, "parentBrandOrderReference": { "type": "string", "description": "The parent order number.", "nullable": true, "example": "3265987" }, "eShopWorldOrderNumber": { "type": "string", "description": "Order number in the eshopWorld system.", "nullable": true, "example": "5001007400857" }, "shopperCurrencyIso": { "type": "string", "description": "ISO 4217 format three-letter identifier for the shopper currency.", "nullable": true, "example": "EUR" }, "retailerCurrencyIso": { "type": "string", "description": "ISO 4217 format three-letter identifier for the retailer's currency.", "nullable": true, "example": "USD" }, "deliveryCountryIso": { "type": "string", "description": "ISO 3166 format two-letter country identifier for the delivery country.", "nullable": true, "example": "IE" }, "orderDate": { "type": "string", "description": "The datetime when the order was created, in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "weight": { "$ref": "#/components/schemas/WeightInfo" }, "shopperExperience": { "$ref": "#/components/schemas/ShopperExperience" }, "contactDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetail" }, "description": "Shopper’s delivery or payment contact details.", "nullable": true }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItem" }, "description": "Attributes that describe the items in the cart.", "nullable": true }, "orderCharges": { "type": "array", "items": { "$ref": "#/components/schemas/NamedMoney" }, "description": "A list of order level charges.", "nullable": true }, "deliveryOption": { "$ref": "#/components/schemas/DeliveryOption" }, "payment": { "$ref": "#/components/schemas/Payment" }, "retailerInvoice": { "$ref": "#/components/schemas/RetailerInvoice" }, "originDetails": { "$ref": "#/components/schemas/OriginDetails" }, "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" }, "description": "Transactions", "nullable": true }, "metadataItems": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItem" }, "description": "Key-value pairs", "nullable": true }, "orderBalances": { "type": "array", "items": { "$ref": "#/components/schemas/NamedMoney" }, "description": "A list of order balance charges", "nullable": true } }, "additionalProperties": false, "description": "Order" }, "OrderActivityReasonCode": { "enum": [ "ShopperCancel", "RetailerCancel", "Fraud" ], "type": "string", "description": "Order Activity Reason Code" }, "OrderActivityRequest": { "required": [ "actionedBy", "activityStatus", "reasonCode", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "activityStatus": { "$ref": "#/components/schemas/ActivityStatus" }, "reasonCode": { "$ref": "#/components/schemas/OrderActivityReasonCode" }, "settlementReference": { "type": "string", "description": "Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.", "nullable": true, "example": "657100201" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "OrderActivityRequest" }, "OrderAllocationRequest": { "required": [ "actionedBy", "lineItems", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemAllocation" }, "description": "The Line Items to allocate" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "OrderAllocationRequest" }, "OrderAppeasementRequest": { "required": [ "actionedBy", "reasonCode", "transactionDateTime", "transactionReference", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/AppeasementsType" }, "reasonCode": { "$ref": "#/components/schemas/AppeasementsReasonCode" }, "transaction": { "$ref": "#/components/schemas/Price" }, "fullAppeasement": { "type": "boolean", "description": "Should be Set for full appeasement, as per the available refund value in eshopWorld's system. Other wise it should be set to false \r\nwhich will be the value in the price amount field.", "example": false }, "settlementReference": { "type": "string", "description": "Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.", "nullable": true, "example": "657100201" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "" }, "OrderArticle": { "type": "object", "properties": { "sequence": { "type": "integer", "description": "Article sequence within the line item", "format": "int32", "example": 2 }, "status": { "$ref": "#/components/schemas/OrderArticleStatuses" }, "charges": { "type": "array", "items": { "$ref": "#/components/schemas/NamedMoney" }, "description": "A list of item level charges.", "nullable": true } }, "additionalProperties": false, "description": "Order Article" }, "OrderArticleStatuses": { "enum": [ "Created", "Shipped", "Cancelled" ], "type": "string", "description": "Order article statuses" }, "OrderCreate": { "required": [ "actionedBy", "brandOrderReference", "contactDetails", "deliveryCountryIso", "deliveryOption", "lineItems", "orderType", "retailerCurrencyIso", "shopperCurrencyIso", "shopperExperience", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "brandOrderReference": { "minLength": 1, "type": "string", "description": "The Brand's order number.", "example": "12345" }, "weight": { "$ref": "#/components/schemas/WeightInfo" }, "orderType": { "$ref": "#/components/schemas/OrderType" }, "parentBrandOrderReference": { "type": "string", "description": "The parent order number.", "nullable": true, "example": "P12345" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" }, "shopperCurrencyIso": { "minLength": 1, "type": "string", "description": "ISO 4217 format three-letter identifier for the shopper currency.", "example": "EUR" }, "retailerCurrencyIso": { "minLength": 1, "type": "string", "description": "ISO 4217 format three-letter identifier for the retailer's currency.", "example": "USD" }, "deliveryCountryIso": { "minLength": 1, "type": "string", "description": "ISO 3166 format two-letter country identifier for the delivery country.", "example": "IE" }, "shopperExperience": { "$ref": "#/components/schemas/ShopperExperience" }, "contactDetails": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDetail" }, "description": "Shopper’s delivery or payment contact details. If multiple contactDetails are passed, they will be applied first-to-last." }, "lineItems": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemToCreate" }, "description": "Attributes that describe the items in the cart. There can be multiple cart items. A minimum of one cart item is required." }, "deliveryOption": { "$ref": "#/components/schemas/DeliveryOptionCreate" }, "retailerInvoice": { "$ref": "#/components/schemas/RetailerInvoice" }, "payment": { "$ref": "#/components/schemas/Payment" }, "originDetails": { "$ref": "#/components/schemas/OriginDetails" }, "metadataItems": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItem" }, "description": "Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.", "nullable": true } }, "additionalProperties": false, "description": "Order create request" }, "OrderItem": { "required": [ "lineItemId", "product", "quantity" ], "type": "object", "properties": { "lineItemId": { "minLength": 1, "type": "string", "description": "Item sequence or line item ID.", "example": "1" }, "quantity": { "type": "integer", "description": "Number of product pieces. Matches the length of the articles property", "format": "int32", "example": 2 }, "estimatedDeliveryDateFromRetailer": { "type": "string", "description": "Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.", "format": "date-time", "nullable": true, "example": "\"2020-08-31T11:54:24.631Z" }, "product": { "$ref": "#/components/schemas/Product" }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/OrderArticle" }, "description": "List of articles with their statuses", "nullable": true }, "metadataItems": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItem" }, "description": "Key-value pairs", "nullable": true } }, "additionalProperties": false, "description": "Cart Items" }, "OrderItemAllocation": { "required": [ "articles", "lineItemId", "quantity" ], "type": "object", "properties": { "lineItemId": { "minLength": 1, "type": "string", "description": "Line item id", "example": "1" }, "quantity": { "type": "integer", "description": "Quantity", "format": "int32", "example": 1 }, "articles": { "type": "array", "items": { "$ref": "#/components/schemas/ArticleAllocation" }, "description": "Articles to allocate" } }, "additionalProperties": false, "description": "Defines the model to be used when allocating a line item" }, "OrderItemReplacement": { "required": [ "quantity", "replacementOrderDetails" ], "type": "object", "properties": { "lineItemId": { "type": "string", "description": "Line item to be replaced", "nullable": true, "example": "2" }, "productCode": { "type": "string", "description": "Product code or stock-keeping unit (SKU) number of the item.", "nullable": true, "example": "277906" }, "quantity": { "type": "integer", "description": "Quantity to replace.", "format": "int32", "example": 2 }, "replacementOrderDetails": { "$ref": "#/components/schemas/ReplacementOrderDetails" } }, "additionalProperties": false, "description": "Defines the model to be used when replacing a line item" }, "OrderItemToCreate": { "required": [ "lineItemId", "product", "quantity" ], "type": "object", "properties": { "lineItemId": { "minLength": 1, "type": "string", "description": "Item sequence or line item ID.", "example": "1" }, "quantity": { "type": "integer", "description": "Number of product pieces. Matches the length of the articles property", "format": "int32", "example": 2 }, "estimatedDeliveryDateFromRetailer": { "type": "string", "description": "Estimated delivery date of the cart items in the ISO 8601 format. This date is for the first leg of the journey.", "format": "date-time", "nullable": true, "example": "\"2020-08-31T11:54:24.631Z" }, "product": { "$ref": "#/components/schemas/ProductCreate" }, "metadataItems": { "type": "array", "items": { "$ref": "#/components/schemas/MetadataItem" }, "description": "Key-value pairs used for passing additional details. Use of metadataItems must be agreed with eShopWorld. This applies to all metadataItems within this API.", "nullable": true } }, "additionalProperties": false, "description": "Cart Items" }, "OrderReplacementReasonCode": { "enum": [ "LostPackage", "DamagedGoods", "ShortShip", "LostReturn", "IncorrectSize", "IncorrectProduct", "ProductNotAsExpected", "ShopperRemorse" ], "type": "string", "description": "Order Replacement Reason Code" }, "OrderReplacementRequest": { "required": [ "actionedBy", "exchange", "items", "reasonCode", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/OrderItemReplacement" }, "description": "The Line Items to exchange" }, "reasonCode": { "$ref": "#/components/schemas/OrderReplacementReasonCode" }, "exchange": { "type": "boolean", "description": "Indicates whether return of the items is required.", "example": true }, "settlementReference": { "type": "string", "description": "Unique reference number of the settlement transaction. When the Retailer is using “self-billing” Settlement model, this field should be sent.", "nullable": true, "example": "657100201" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order transaction in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" } }, "additionalProperties": false, "description": "OrderReplacementRequest" }, "OrderStatuses": { "enum": [ "Received", "Cancelled" ], "type": "string", "description": "Order statuses." }, "OrderTransactionApiResponse": { "type": "object", "properties": { "transactionReference": { "type": "string", "description": "Unique reference number of the transaction.\r\nIf the retailer sends this data, eSW will honor it. If the retailer does not send this data, eSW will generate the GUID for the transaction.", "format": "uuid", "example": "46874510-DE4C-4748-A74C-97C54AFB4270" } }, "additionalProperties": false, "description": "Response from Order API" }, "OrderType": { "enum": [ "Offline", "Checkout", "NonCheckoutEcommerce" ], "type": "string", "description": "OrderType" }, "OriginDetails": { "required": [ "address1", "city", "country", "email", "originType" ], "type": "object", "properties": { "originType": { "$ref": "#/components/schemas/OriginType" }, "firstName": { "type": "string", "description": "First name of the address.", "nullable": true, "example": "John " }, "lastName": { "type": "string", "description": "Last name of the address.", "nullable": true, "example": "Smith" }, "telephone": { "type": "string", "description": "Phone number.", "nullable": true, "example": "+14211112222" }, "nickName": { "type": "string", "description": "Nickname or identifier for the contact information.", "nullable": true, "example": "NickName" }, "addressId": { "type": "string", "description": "Address Identifier", "nullable": true, "example": "AD12345" }, "address1": { "minLength": 1, "type": "string", "description": "Address line 1 of the address.", "example": "1234 Line Ave S" }, "address2": { "type": "string", "description": "Address line 2 of the address.", "nullable": true, "example": "Apt B1" }, "address3": { "type": "string", "description": "Address line 3 of the address.", "nullable": true, "example": "New York state" }, "city": { "minLength": 1, "type": "string", "description": "City of the address.", "example": "New York city" }, "postalCode": { "type": "string", "description": "Postal code or zip code of the address.", "nullable": true, "example": "10001" }, "region": { "type": "string", "description": "Region, province, state, or county of the address. ISO can be provided, if available.", "nullable": true, "example": "Region" }, "country": { "minLength": 1, "type": "string", "description": "ISO 3166 two-letter country code of the address.", "example": "US" }, "email": { "minLength": 1, "type": "string", "description": "Email address.", "example": "email@test.com" }, "gender": { "$ref": "#/components/schemas/Gender" }, "poBox": { "type": "string", "description": "Postal order box of the address.", "nullable": true, "example": "" } }, "additionalProperties": false, "description": "Origin Details" }, "OriginType": { "enum": [ "None", "Store" ], "type": "string", "description": "Payment methods" }, "Payment": { "type": "object", "properties": { "method": { "type": "string", "description": "Payment method used", "nullable": true, "example": "ApplePay" }, "last4Digits": { "type": "string", "description": "Last 4 digits of the payment card", "nullable": true, "example": "1234" }, "paymentAttemptRef": { "type": "string", "description": "Payment attempt reference", "format": "uuid", "nullable": true, "example": "1CBA8F0C-F7EE-437C-A450-B63ADD08CA5A" }, "priceInfo": { "$ref": "#/components/schemas/PriceInfo" }, "deliveryPriceInfo": { "$ref": "#/components/schemas/PriceInfo" }, "retailerPriceInfo": { "$ref": "#/components/schemas/PriceInfo" }, "retailerDeliveryPriceInfo": { "$ref": "#/components/schemas/PriceInfo" }, "paymentStatus": { "type": "string", "description": "Payment Status", "nullable": true }, "merchantPaymentId": { "type": "string", "description": "Merchant Payment Id", "nullable": true } }, "additionalProperties": false, "description": "Payment details" }, "Price": { "required": [ "amount", "currency" ], "type": "object", "properties": { "amount": { "type": "number", "description": "Amount to credit eSW or debit eSW", "format": "double" }, "currency": { "minLength": 1, "type": "string", "description": "ISO representation for currency of transaction amount.", "example": "USD" } }, "additionalProperties": false, "description": "" }, "PriceInfo": { "type": "object", "properties": { "price": { "$ref": "#/components/schemas/Money" } }, "additionalProperties": false, "description": "Price Info" }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "Product": { "required": [ "description", "productCode", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string", "description": "Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.", "example": "Black dress" }, "description": { "minLength": 1, "type": "string", "description": "Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.", "example": "Long black dress" }, "customsDescription": { "type": "string", "description": "Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.", "nullable": true, "example": "Long black dress" }, "prohibitedItem": { "type": "boolean", "description": "Indicates whether the item is prohibited" }, "productCode": { "minLength": 1, "type": "string", "description": "Unique identification code or SKU for the product.", "example": "123456" }, "hsCode": { "type": "string", "description": "HsCode.", "nullable": true, "example": "123456" }, "countryOfOriginIso": { "type": "string", "description": "CountryOfOrigin.", "nullable": true, "example": "CN" }, "imageUrl": { "type": "string", "description": "Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.", "nullable": true, "example": "https://url.com/test.png" }, "color": { "type": "string", "description": "Color of the item.", "nullable": true, "example": "black" }, "size": { "type": "string", "description": "Size of the item.", "nullable": true, "example": "38" }, "isReturnProhibited": { "type": "boolean", "description": "Indicates whether the item is returnable or not under the regular return policy. The values are True or False.", "nullable": true, "example": false }, "vatRate": { "type": "number", "description": "Vat rate", "format": "double", "example": 20 }, "taxCode": { "type": "string", "description": "Tax code", "nullable": true, "example": "XY234" } }, "additionalProperties": false, "description": "Product" }, "ProductCreate": { "required": [ "description", "productCode", "productUnitPriceInfo", "title" ], "type": "object", "properties": { "title": { "minLength": 1, "type": "string", "description": "Localized title of the product. If no title is provided, eShopWorld may use the description from the Product Catalog.", "example": "Black dress" }, "description": { "minLength": 1, "type": "string", "description": "Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.", "example": "Long black dress" }, "customsDescription": { "type": "string", "description": "Localized description of the product. If no description is provided, eShopWorld may use the description from the Product Catalog.", "nullable": true, "example": "Long black dress" }, "productCode": { "minLength": 1, "type": "string", "description": "Unique identification code or SKU for the product.", "example": "123456" }, "hsCode": { "type": "string", "description": "HsCode.", "nullable": true, "example": "123456" }, "countryOfOriginIso": { "type": "string", "description": "CountryOfOrigin.", "nullable": true, "example": "CN" }, "imageUrl": { "type": "string", "description": "Thumbnail image URL of the product. The image size must be less than or equal to 20 KB and the image must be retina-ready.", "nullable": true, "example": "https://url.com/test.png" }, "color": { "type": "string", "description": "Color of the item.", "nullable": true, "example": "black" }, "size": { "type": "string", "description": "Size of the item.", "nullable": true, "example": "38" }, "productUnitPriceInfo": { "$ref": "#/components/schemas/PriceInfo" }, "isReturnProhibited": { "type": "boolean", "description": "Indicates whether the item is returnable or not under the regular return policy. The values are True or False.", "nullable": true, "example": false } }, "additionalProperties": false, "description": "Product" }, "ReplaceOrderItemsReasonCode": { "enum": [ "LostPackage", "DamagedGoods", "ShortShip", "LostReturn" ], "type": "string", "description": "Replace Order Reason Code" }, "ReplacementOrderDetails": { "required": [ "replacementBrandOrderReference", "replacementLineItemId" ], "type": "object", "properties": { "replacementBrandOrderReference": { "minLength": 1, "type": "string", "description": "Retailer's unique reference number for the replacement order,", "example": "653241" }, "replacementLineItemId": { "minLength": 1, "type": "string", "description": "Line Item Id of the replacement articles Example: ‘1’", "example": "1" }, "replacementProduct": { "$ref": "#/components/schemas/ReplacementProduct" } }, "additionalProperties": false, "description": "ReplacementOrderDetails" }, "ReplacementProduct": { "type": "object", "properties": { "productCode": { "type": "string", "description": "Example: ‘277906’", "nullable": true, "example": "277906" }, "name": { "type": "string", "description": "The name of the product.", "nullable": true, "example": "PINK LOUNGE WOMENS KNIT" }, "description": { "type": "string", "description": "The description of the product.\r\n Example: ‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’", "nullable": true, "example": "‘PINK:PFCT FZ PINK LOUNGE WOMENS KNIT 60% COTTON 40% POLYESTER OUTERWEAR HO’" }, "colour": { "type": "string", "description": "The colour of the product", "nullable": true, "example": "Red" }, "size": { "type": "string", "description": "The size of the product. Example: ‘S’", "nullable": true, "example": "S" } }, "additionalProperties": false, "description": "Product" }, "RetailerInvoice": { "type": "object", "properties": { "number": { "type": "string", "description": "RetailerInvoice number", "nullable": true, "example": "784512" }, "date": { "type": "string", "description": "RetailerInvoice Date in the yyyy-MM-dd format", "nullable": true, "example": "2020-05-11" } }, "additionalProperties": false, "description": "RetailerInvoice details" }, "ServiceLevel": { "enum": [ "DEFAULT", "POST", "EXP1", "EXP2", "RussiaExpress", "Standard", "PUDO" ], "type": "string", "description": "Service Levels." }, "ShopperExperience": { "required": [ "shopperCultureLanguageIso" ], "type": "object", "properties": { "shopperCultureLanguageIso": { "minLength": 1, "type": "string", "description": "Preferred language and culture experience for the shopper in the ISO 639-1 and ISO 3166 format.", "example": "en-IE" }, "registeredProfileId": { "type": "string", "description": "Customer profile Id or number", "nullable": true, "example": "44170" } }, "additionalProperties": false, "description": "Shopper Experience" }, "Transaction": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TransactionType" }, "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "status": { "$ref": "#/components/schemas/TransactionStatus" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" }, "reasonCode": { "type": "string", "description": "Reason", "nullable": true, "example": "LostPackage" }, "lastUpdateTime": { "type": "string", "description": "LastUpdateTime", "format": "date-time", "nullable": true }, "creationTime": { "type": "string", "description": "CreationTime", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Transaction details" }, "TransactionStatus": { "enum": [ "Unprocessed", "InProgress", "Processed", "Failed" ], "type": "string", "description": "Transaction Status" }, "TransactionType": { "enum": [ "OrderCancel", "LineItemCancel", "OrderAppeasementMerchandise", "OrderAppeasementShipping", "LineItemAppeasement", "LineItemReplacement", "Return", "BlindReturn", "ShippedMerchandise", "OrderCreate", "OrderRefund", "OrderUpdate", "LineItemUpdate", "LineItemAdd", "OrderReplacement" ], "type": "string", "description": "Transaction" }, "UpdateContactDetail": { "required": [ "address1", "city", "contactDetailsType", "email", "postalCode", "telephone" ], "type": "object", "properties": { "contactDetailsType": { "$ref": "#/components/schemas/UpdateContactDetailsType" }, "address1": { "minLength": 1, "type": "string", "description": "Address line 1 of the address.", "example": "1234 Line Ave S" }, "address2": { "type": "string", "description": "Address line 2 of the address.", "nullable": true, "example": "Apt B1" }, "address3": { "type": "string", "description": "Address line 3 of the address.", "nullable": true, "example": "New York state" }, "city": { "minLength": 1, "type": "string", "description": "City of the address.", "example": "New York city" }, "postalCode": { "minLength": 1, "type": "string", "description": "Postal code or zip code of the address.", "example": "10001" }, "region": { "type": "string", "description": "Region, province, state, or county of the address. ISO can be provided, if available.", "nullable": true, "example": "Region" }, "email": { "minLength": 1, "type": "string", "description": "Email address.", "example": "email@test.com" }, "telephone": { "minLength": 1, "type": "string", "description": "Phone number.", "example": "+14211112222" } }, "additionalProperties": false, "description": "Update Contact Details" }, "UpdateContactDetailsType": { "enum": [ "IsDelivery" ], "type": "string", "description": "ContactDetailsType" }, "UpdateLineItemReasonCode": { "enum": [ "ProductSubstituted", "ProductDiscontinued", "ProductNotAvailable" ], "type": "string", "description": "Update Line Item Reason Code" }, "UpdateOrderContacts": { "required": [ "actionedBy", "contactDetails", "transactionDateTime", "transactionReference" ], "type": "object", "properties": { "transactionReference": { "type": "string", "description": "Unique reference number of the transaction", "format": "uuid", "example": "C857B3CD-5EB7-426D-8741-812E5ED214C0" }, "transactionDateTime": { "type": "string", "description": "The date/time logged by the retailer for the creation of the order in UTC.", "format": "date-time", "example": "2019-10-14T15:56:18.455Z" }, "actionedBy": { "$ref": "#/components/schemas/ActionedBy" }, "actionedByUser": { "type": "string", "description": "Identifier for the person who initiated the action, for example, John Smith or johnsmith@test.com.", "nullable": true, "example": "johnsmith@test.com" }, "contactDetails": { "$ref": "#/components/schemas/UpdateContactDetail" } }, "additionalProperties": false, "description": "Update Contact details like address info." }, "WeightInfo": { "type": "object", "properties": { "weightTotal": { "type": "number", "description": "Total weight of the order.", "format": "double" }, "weightUnit": { "$ref": "#/components/schemas/WeightUnit" } }, "additionalProperties": false, "description": "(Required) Attributes that describe the package weight data." }, "WeightUnit": { "enum": [ "KG", "LB" ], "type": "string", "description": "Unit of measurement for the items in the package. 0 indicates KG and 1 indicates LB." } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } }, "security": [ { "Bearer": [ ] } ] }