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

# Models

## The Microsoft.AspNetCore.Mvc.ProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Microsoft.AspNetCore.Mvc.ProblemDetails":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"format":"int32","type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"additionalProperties":{}}}}}
```

## The Microsoft.AspNetCore.Mvc.ValidationProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Microsoft.AspNetCore.Mvc.ValidationProblemDetails":{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"type":{"type":"string"},"title":{"type":"string"},"status":{"format":"int32","type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}},"additionalProperties":{}}}}}
```

## The Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebRequest":{"description":"Web Request for creating an outbound order","type":"object","properties":{"orderReference":{"description":"Order Reference","type":"string"},"contactInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto"},"orderItems":{"description":"Product items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebRequestDto"}},"customFields":{"description":"Custom fields","type":"object","additionalProperties":{"additionalProperties":{"type":"string"}}},"canOverwrite":{"description":"Can Overwrite","type":"boolean"},"retailerIdentifier":{"description":"Retailer Identifier","type":"string"},"externalBrandIdentifier":{"description":"External Brand Identifier","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto":{"description":"Contact information Request DTO","type":"object","properties":{"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"unit":{"description":"Unit","type":"string"},"poBox":{"description":"Post Office Box","type":"string"},"address1":{"description":"Address 1","type":"string"},"address2":{"description":"Address 2","type":"string"},"address3":{"description":"Address 3","type":"string"},"city":{"description":"City","type":"string"},"region":{"description":"Region","type":"string"},"postalCode":{"description":"Postal Code","type":"string"},"countryIso":{"description":"Country Iso","type":"string"},"email":{"description":"Email address","type":"string"},"telephone":{"description":"Telephone number","type":"string"},"cultureLanguageIso":{"description":"Culture language iso","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebRequestDto":{"description":"Order item Request DTO","type":"object","properties":{"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Material composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto":{"description":"Shipping information web request DTO","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebResponse":{"description":"Web Response for successful Outbound Order Create","type":"object","properties":{"id":{"description":"Outbound order identifier","type":"string"},"orderItems":{"description":"Order items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebResponse"}}},"additionalProperties":false},"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebResponse":{"description":"Order item Web Request","type":"object","properties":{"id":{"description":"Order item identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"productDescription":{"description":"Product description","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebRequestDto":{"description":"Order item Request DTO","type":"object","properties":{"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Material composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto":{"description":"Shipping information web request DTO","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebResponse":{"description":"Order item Web Request","type":"object","properties":{"id":{"description":"Order item identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"productDescription":{"description":"Product description","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto":{"description":"Contact information Request DTO","type":"object","properties":{"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"unit":{"description":"Unit","type":"string"},"poBox":{"description":"Post Office Box","type":"string"},"address1":{"description":"Address 1","type":"string"},"address2":{"description":"Address 2","type":"string"},"address3":{"description":"Address 3","type":"string"},"city":{"description":"City","type":"string"},"region":{"description":"Region","type":"string"},"postalCode":{"description":"Postal Code","type":"string"},"countryIso":{"description":"Country Iso","type":"string"},"email":{"description":"Email address","type":"string"},"telephone":{"description":"Telephone number","type":"string"},"cultureLanguageIso":{"description":"Culture language iso","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto":{"description":"Shipping information web request DTO","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.WeightRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Ingestion.Domain.Enums.ShippingStatus object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"}}}}
```

## The Returns.Ingestion.Domain.Enums.WeightUnit object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebRequest":{"description":"Web Request for updating an outbound order","type":"object","properties":{"contactInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.UpdateOutboundOrder.ContactInformationUpdateRequestDto"},"orderItems":{"description":"Product items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebRequestDto"}},"customFields":{"description":"Custom fields","type":"object","additionalProperties":{"additionalProperties":{"type":"string"}}},"retailerIdentifier":{"description":"Retailer Identifier","type":"string"},"externalBrandIdentifier":{"description":"External Brand Identifier","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.UpdateOutboundOrder.ContactInformationUpdateRequestDto":{"description":"Contact information Request DTO","type":"object","properties":{"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"unit":{"description":"Unit","type":"string"},"poBox":{"description":"Post Office Box","type":"string"},"address1":{"description":"Address 1","type":"string"},"address2":{"description":"Address 2","type":"string"},"address3":{"description":"Address 3","type":"string"},"city":{"description":"City","type":"string"},"region":{"description":"Region","type":"string"},"postalCode":{"description":"Postal Code","type":"string"},"email":{"description":"Email address","type":"string"},"telephone":{"description":"Telephone number","type":"string"},"cultureLanguageIso":{"description":"Culture language iso","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Api.UseCases.CreateOutboundOrder.OrderItemWebRequestDto":{"description":"Order item Request DTO","type":"object","properties":{"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Material composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingInformationWebRequestDto":{"description":"Shipping information web request DTO","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebResponse":{"description":"Web Response for updating an outbound order","type":"object","properties":{"contactInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto"},"orderItems":{"description":"Product items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.OrderItemRequestDto"}},"customFields":{"description":"Custom fields","type":"object","additionalProperties":{"additionalProperties":{"type":"string"}}}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto":{"description":"Contact information Request DTO","type":"object","properties":{"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"unit":{"description":"Unit","type":"string"},"poBox":{"description":"Post Office Box","type":"string"},"address1":{"description":"Address 1","type":"string"},"address2":{"description":"Address 2","type":"string"},"address3":{"description":"Address 3","type":"string"},"city":{"description":"City","type":"string"},"region":{"description":"Region","type":"string"},"postalCode":{"description":"Postal Code","type":"string"},"countryIso":{"description":"Country Iso","type":"string"},"email":{"description":"Email address","type":"string"},"telephone":{"description":"Telephone number","type":"string"},"cultureLanguageIso":{"description":"Culture language iso","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.OrderItemRequestDto":{"description":"Order item Request DTO","type":"object","properties":{"id":{"description":"Identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"monolithId":{"format":"int64","description":"Monolith identifier","type":"integer"},"parentProductCode":{"description":"Parent Product Code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"retailerLineItemId":{"description":"Retailer Line Item Id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Product composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"hsCodeRegion":{"description":"HS Code Region","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"unitCharges":{"description":"Unit charges","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitChargeDto"}},"refundCharges":{"description":"Refund charges","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitChargeDto"}},"shippingInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto"},"deliveryEstimates":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"colorNumber":{"description":"Color Number","type":"string"},"styleNumber":{"description":"Style Number","type":"string"},"categoryDescription":{"description":"Category Description","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"source":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.OrderItemSource"},"material":{"description":"Material","type":"string"},"gender":{"description":"Gender","type":"string"},"ageGroup":{"description":"Age Group","type":"string"},"productUrl":{"description":"The Product’s landing page","type":"string"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"articlePaymentReceived":{"description":"Article Payment Received - This is a flag to indicate if the payment for the article has been received","type":"boolean"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"},"promotions":{"description":"Promotions","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.PromotionDto"}}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.UnitChargeDto":{"description":"Unit charge Dto","type":"object","properties":{"name":{"description":"Name","type":"string"},"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto":{"description":"Shipping information Request Dto","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"shippingReferenceLastMile":{"description":"Last Mile Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"carrierReference":{"description":"Carrier reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto":{"description":"Order item Request DTO","type":"object","properties":{"eddMinDate":{"format":"date-time","description":"Edd min date","type":"string"},"eddMaxDate":{"format":"date-time","description":"Edd max date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.OrderItemSource":{"format":"int32","enum":[0,1],"type":"integer"},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.PromotionDto":{"description":"Promotion DTO","type":"object","properties":{"id":{"description":"Promotion identifier, code","type":"string"},"discountType":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.DiscountType"},"discountValue":{"format":"double","description":"Discount value","type":"number"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.DiscountType":{"enum":["Discount","FeeDiscount","SalePrice"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.OrderItemRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.OrderItemRequestDto":{"description":"Order item Request DTO","type":"object","properties":{"id":{"description":"Identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"monolithId":{"format":"int64","description":"Monolith identifier","type":"integer"},"parentProductCode":{"description":"Parent Product Code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"retailerLineItemId":{"description":"Retailer Line Item Id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Product composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"hsCodeRegion":{"description":"HS Code Region","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"unitCharges":{"description":"Unit charges","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitChargeDto"}},"refundCharges":{"description":"Refund charges","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitChargeDto"}},"shippingInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto"},"deliveryEstimates":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"colorNumber":{"description":"Color Number","type":"string"},"styleNumber":{"description":"Style Number","type":"string"},"categoryDescription":{"description":"Category Description","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"source":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.OrderItemSource"},"material":{"description":"Material","type":"string"},"gender":{"description":"Gender","type":"string"},"ageGroup":{"description":"Age Group","type":"string"},"productUrl":{"description":"The Product’s landing page","type":"string"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"articlePaymentReceived":{"description":"Article Payment Received - This is a flag to indicate if the payment for the article has been received","type":"boolean"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"},"promotions":{"description":"Promotions","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.PromotionDto"}}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.UnitChargeDto":{"description":"Unit charge Dto","type":"object","properties":{"name":{"description":"Name","type":"string"},"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto":{"description":"Shipping information Request Dto","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"shippingReferenceLastMile":{"description":"Last Mile Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"carrierReference":{"description":"Carrier reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto":{"description":"Order item Request DTO","type":"object","properties":{"eddMinDate":{"format":"date-time","description":"Edd min date","type":"string"},"eddMaxDate":{"format":"date-time","description":"Edd max date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.OrderItemSource":{"format":"int32","enum":[0,1],"type":"integer"},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.PromotionDto":{"description":"Promotion DTO","type":"object","properties":{"id":{"description":"Promotion identifier, code","type":"string"},"discountType":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.DiscountType"},"discountValue":{"format":"double","description":"Discount value","type":"number"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.DiscountType":{"enum":["Discount","FeeDiscount","SalePrice"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.UpdateOutboundOrder.ContactInformationUpdateRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.UpdateOutboundOrder.ContactInformationUpdateRequestDto":{"description":"Contact information Request DTO","type":"object","properties":{"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"unit":{"description":"Unit","type":"string"},"poBox":{"description":"Post Office Box","type":"string"},"address1":{"description":"Address 1","type":"string"},"address2":{"description":"Address 2","type":"string"},"address3":{"description":"Address 3","type":"string"},"city":{"description":"City","type":"string"},"region":{"description":"Region","type":"string"},"postalCode":{"description":"Postal Code","type":"string"},"email":{"description":"Email address","type":"string"},"telephone":{"description":"Telephone number","type":"string"},"cultureLanguageIso":{"description":"Culture language iso","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto":{"description":"Order item Request DTO","type":"object","properties":{"eddMinDate":{"format":"date-time","description":"Edd min date","type":"string"},"eddMaxDate":{"format":"date-time","description":"Edd max date","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.PromotionDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.PromotionDto":{"description":"Promotion DTO","type":"object","properties":{"id":{"description":"Promotion identifier, code","type":"string"},"discountType":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.DiscountType"},"discountValue":{"format":"double","description":"Discount value","type":"number"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.DiscountType":{"enum":["Discount","FeeDiscount","SalePrice"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto":{"description":"Shipping information Request Dto","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"shippingReferenceLastMile":{"description":"Last Mile Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"carrierReference":{"description":"Carrier reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.UnitChargeDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.UnitChargeDto":{"description":"Unit charge Dto","type":"object","properties":{"name":{"description":"Name","type":"string"},"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Domain.Enums.OrderItemSource object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Domain.Enums.OrderItemSource":{"format":"int32","enum":[0,1],"type":"integer"}}}}
```

## The Returns.Ingestion.Domain.Enums.DiscountType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Domain.Enums.DiscountType":{"enum":["Discount","FeeDiscount","SalePrice"],"type":"string"}}}}
```

## The Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebRequest":{"description":"Submit Outbound Shipment Web Request Object","type":"object","properties":{"orderReference":{"description":"Order Reference","type":"string"},"shippingReference":{"description":"Shipping Reference","type":"string"},"barcodeReference":{"description":"Barcode Reference","type":"string"},"shippingDate":{"format":"date-time","description":"Shipping Date","type":"string"},"contactInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto"},"shippingItems":{"description":"Shipping Items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShippingItemRequestDto"}},"shippingWeight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingWeightDto"},"shippingDimensions":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingDimensionsDto"},"customFields":{"description":"Custom Fields","type":"object","additionalProperties":{"additionalProperties":{"type":"string"}}},"retailerIdentifier":{"description":"Retailer Identifier","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ContactInformationRequestDto":{"description":"Contact information Request DTO","type":"object","properties":{"firstName":{"description":"First name","type":"string"},"lastName":{"description":"Last name","type":"string"},"unit":{"description":"Unit","type":"string"},"poBox":{"description":"Post Office Box","type":"string"},"address1":{"description":"Address 1","type":"string"},"address2":{"description":"Address 2","type":"string"},"address3":{"description":"Address 3","type":"string"},"city":{"description":"City","type":"string"},"region":{"description":"Region","type":"string"},"postalCode":{"description":"Postal Code","type":"string"},"countryIso":{"description":"Country Iso","type":"string"},"email":{"description":"Email address","type":"string"},"telephone":{"description":"Telephone number","type":"string"},"cultureLanguageIso":{"description":"Culture language iso","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShippingItemRequestDto":{"description":"Shipping Item Request Object","type":"object","properties":{"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Material composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShipmentReplacementInformationDto"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShipmentReplacementInformationDto":{"description":"Outbound shipment replacement information","type":"object","properties":{"replacedProductCode":{"description":"SKU10","type":"string"},"replacedLineItemId":{"description":"1","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingWeightDto":{"description":"Shipping Weight Dto","type":"object","properties":{"totalWeight":{"format":"double","description":"Actual Parcel Weight","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingDimensionsDto":{"description":"Shipping Dimensions Dto","type":"object","properties":{"length":{"format":"double","description":"Parcel length","type":"number"},"width":{"format":"double","description":"Parcel width","type":"number"},"height":{"format":"double","description":"Parcel height.","type":"number"},"unit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.DimensionsUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.DimensionsUnit":{"enum":["Cm","In"],"type":"string"}}}}
```

## The Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebResponse":{"description":"Web Response for successful Submit Outbound Shipment","type":"object","properties":{"id":{"description":"Outbound order identifier","type":"string"},"shippingItems":{"description":"Shipping items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.ShippingItemWebResponse"}}},"additionalProperties":false},"Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.ShippingItemWebResponse":{"description":"Shipping item Web Response","type":"object","properties":{"id":{"description":"Shipping item identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"productDescription":{"description":"Product description","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.ShippingItemWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.ShippingItemWebResponse":{"description":"Shipping item Web Response","type":"object","properties":{"id":{"description":"Shipping item identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"productDescription":{"description":"Product description","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.ShippingDimensionsDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.ShippingDimensionsDto":{"description":"Shipping Dimensions Dto","type":"object","properties":{"length":{"format":"double","description":"Parcel length","type":"number"},"width":{"format":"double","description":"Parcel width","type":"number"},"height":{"format":"double","description":"Parcel height.","type":"number"},"unit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.DimensionsUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.DimensionsUnit":{"enum":["Cm","In"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.Common.ShippingWeightDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.Common.ShippingWeightDto":{"description":"Shipping Weight Dto","type":"object","properties":{"totalWeight":{"format":"double","description":"Actual Parcel Weight","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShippingItemRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShippingItemRequestDto":{"description":"Shipping Item Request Object","type":"object","properties":{"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Material composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShipmentReplacementInformationDto"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShipmentReplacementInformationDto":{"description":"Outbound shipment replacement information","type":"object","properties":{"replacedProductCode":{"description":"SKU10","type":"string"},"replacedLineItemId":{"description":"1","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShipmentReplacementInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Application.UseCases.SubmitOutboundShipment.ShipmentReplacementInformationDto":{"description":"Outbound shipment replacement information","type":"object","properties":{"replacedProductCode":{"description":"SKU10","type":"string"},"replacedLineItemId":{"description":"1","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Domain.Enums.DimensionsUnit object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Domain.Enums.DimensionsUnit":{"enum":["Cm","In"],"type":"string"}}}}
```

## The Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderLastMileReferenceWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderLastMileReferenceWebRequest":{"description":"Web Request for updating an outbound order's last mile reference","type":"object","properties":{"carrierReference":{"description":"Carrier Reference","type":"string"},"shippingReferenceLastMile":{"description":"Last Mile Reference","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderLastMileReferenceWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderLastMileReferenceWebResponse":{"description":"Web Response for updating an outbound order's last mile reference","type":"object","properties":{"orderItems":{"description":"Product items","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.OrderItemRequestDto"}}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.OrderItemRequestDto":{"description":"Order item Request DTO","type":"object","properties":{"id":{"description":"Identifier","type":"string"},"productCode":{"description":"Product code","type":"string"},"monolithId":{"format":"int64","description":"Monolith identifier","type":"integer"},"parentProductCode":{"description":"Parent Product Code","type":"string"},"lineItemId":{"description":"Line item id","type":"string"},"retailerLineItemId":{"description":"Retailer Line Item Id","type":"string"},"quantity":{"format":"int32","description":"Quantity","type":"integer"},"productDescription":{"description":"Product description","type":"string"},"productCustomsDescription":{"description":"Product customs description","type":"string"},"composition":{"description":"Product composition","type":"string"},"countryOfOriginIso":{"description":"Country of origin iso","type":"string"},"hsCode":{"description":"Hs code","type":"string"},"hsCodeRegion":{"description":"HS Code Region","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.WeightRequestDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto"},"unitCharges":{"description":"Unit charges","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitChargeDto"}},"refundCharges":{"description":"Refund charges","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.UnitChargeDto"}},"shippingInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto"},"deliveryEstimates":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto"},"productImageUrl":{"description":"Product image url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"colorNumber":{"description":"Color Number","type":"string"},"styleNumber":{"description":"Style Number","type":"string"},"categoryDescription":{"description":"Category Description","type":"string"},"personalized":{"description":"Is Personalized","type":"boolean"},"isDigital":{"description":"Is digital","type":"boolean"},"dangerousGoods":{"description":"Is dangerous goods","type":"boolean"},"unitedNationsNumber":{"description":"United Nations Number used for dangerous goods","type":"string"},"packingInstructions":{"description":"PI packing instructions","type":"string"},"prohibitedForReturns":{"description":"Is prohibited for returns","type":"boolean"},"source":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.OrderItemSource"},"material":{"description":"Material","type":"string"},"gender":{"description":"Gender","type":"string"},"ageGroup":{"description":"Age Group","type":"string"},"productUrl":{"description":"The Product’s landing page","type":"string"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto"},"articlePaymentReceived":{"description":"Article Payment Received - This is a flag to indicate if the payment for the article has been received","type":"boolean"},"mid":{"description":"MID","type":"string"},"midZipCode":{"description":"MIDZipCode","type":"string"},"promotions":{"description":"Promotions","type":"array","items":{"$ref":"#/components/schemas/Returns.Ingestion.Application.UseCases.Common.PromotionDto"}}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.WeightRequestDto":{"description":"Weight Request DTO","type":"object","properties":{"weightTotal":{"format":"double","description":"Weight total","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.UnitPriceRequestDto":{"description":"Unit price Request DTO","type":"object","properties":{"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.UnitChargeDto":{"description":"Unit charge Dto","type":"object","properties":{"name":{"description":"Name","type":"string"},"amount":{"format":"double","description":"Amount","type":"number"},"currency":{"description":"Currency","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.ShippingInformationRequestDto":{"description":"Shipping information Request Dto","type":"object","properties":{"shippingReference":{"description":"Shipping reference","type":"string"},"shippingReferenceLastMile":{"description":"Last Mile Shipping reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"carrierReference":{"description":"Carrier reference","type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","description":"Status date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Ingestion.Application.UseCases.Common.DeliveryEstimatesDto":{"description":"Order item Request DTO","type":"object","properties":{"eddMinDate":{"format":"date-time","description":"Edd min date","type":"string"},"eddMaxDate":{"format":"date-time","description":"Edd max date","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.OrderItemSource":{"format":"int32","enum":[0,1],"type":"integer"},"Returns.Ingestion.Application.UseCases.Common.FulfilmentInformationDto":{"description":"Fulfilment Information","type":"object","properties":{"centreId":{"description":"Fulfilment Centre Id","type":"string"},"countryIso":{"description":"Fulfilment Centre Country ISO","type":"string"}},"additionalProperties":false},"Returns.Ingestion.Application.UseCases.Common.PromotionDto":{"description":"Promotion DTO","type":"object","properties":{"id":{"description":"Promotion identifier, code","type":"string"},"discountType":{"$ref":"#/components/schemas/Returns.Ingestion.Domain.Enums.DiscountType"},"discountValue":{"format":"double","description":"Discount value","type":"number"}},"additionalProperties":false},"Returns.Ingestion.Domain.Enums.DiscountType":{"enum":["Discount","FeeDiscount","SalePrice"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.Common.OrderWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.Common.OrderWebResponse":{"description":"Order Web Response Object","type":"object","properties":{"countryIso":{"description":"CountryIso from the saved order's contact information","type":"string"},"orderDate":{"format":"date-time","description":"Date the order was placed","type":"string"},"noOfArticlesAvailableForReturn":{"format":"int32","description":"Number of items available for return","type":"integer"},"noOfArticlesUnavailableForReturn":{"format":"int32","description":"Number of items unavailable for return","type":"integer"},"returnPeriodExpired":{"description":"Indicates whether the return period has expired","type":"boolean"},"orderQualifiesForCancel":{"description":"Order qualifies for cancel","type":"boolean"},"waiveReturnFee":{"description":"When true, the return fee is waived for this order","type":"boolean"},"items":{"description":"Article Items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OrderResponse.OrderItemDto"}},"returnOrders":{"description":"Return Orders","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnOrderDto"}},"fxRates":{"description":"Fx rates","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.FxRateDto"}},"shopperDetails":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OrderResponse.ExtendedOrderShopperDetailsDto"},"payment":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.PaymentDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.OrderResponse.OrderItemDto":{"type":"object","properties":{"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"monolithId":{"format":"int64","type":"integer"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"unitCharges":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitChargeDto"}},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShippingInformationDto"},"deliveryEstimates":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.DeliveryEstimatesDto"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReplacementInformationDto"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"isDigital":{"type":"boolean"},"prohibitedForReturns":{"type":"boolean"},"availableForReturns":{"type":"boolean"},"overrideProhibitedForReturns":{"type":"boolean"},"unlimitedPeriodForReturns":{"type":"boolean"},"returnWindow":{"format":"int32","type":"integer"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto"},"articlePaymentReceived":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.UnitChargeDto":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShippingInformationDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"shippingReferenceLastMile":{"type":"string"},"carrierReference":{"type":"string"},"barcodeReference":{"type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.DeliveryEstimatesDto":{"type":"object","properties":{"eddMinDate":{"format":"date-time","type":"string"},"eddMaxDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReplacementType"},"reason":{"type":"string"},"isReplacementFor":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReplacementType":{"enum":["Replacement","Replaced","ExchangeReplacement","Exchanged","NativeExchangeReplacement"],"type":"string"},"Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto":{"type":"object","properties":{"centreId":{"type":"string"},"countryIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnOrderDto":{"type":"object","properties":{"returnOrderNumber":{"type":"string"},"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"paidBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.PaidBy"},"customerReturnStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderStatus"},"returnProcessedOn":{"format":"date-time","type":"string"},"returnAdminCentreCode":{"type":"string"},"createdOn":{"format":"date-time","type":"string"},"returnItems":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnItemDto"}},"carrierServiceRouteId":{"type":"string"},"waivedShippingCost":{"type":"boolean"},"paymentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.PaymentInformationDto"},"rejectedReturnPackage":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Domain.Enums.PaidBy":{"enum":["Unpaid","Retailer","Shopper"],"type":"string"},"Returns.Oms.Domain.Enums.ReturnOrderStatus":{"enum":["Pending","Created","Received","OnHold","Released","Processed","AddedToManifest","SentToRetailer","ReceivedByRetailer","RemovedFromManifest","Cancelled","Refunded"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnItemDto":{"type":"object","properties":{"id":{"type":"string"},"returnItemReasonCode":{"type":"string"},"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnItemStatus"},"rejectionReason":{"type":"string"},"rejectionReasonDescription":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"dispositionId":{"type":"string"},"productDescription":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"colorNumber":{"type":"string"},"size":{"type":"string"},"styleNumber":{"type":"string"},"returnItemReasonComment":{"type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReplacementInformationDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.PaymentInformationDto":{"type":"object","properties":{"checkoutReference":{"type":"string"},"method":{"type":"string"},"price":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto":{"type":"object","properties":{"packageNumber":{"format":"int64","type":"integer"},"carrierTrackingReference":{"type":"string"},"carrierTrackingUrl":{"type":"string"},"rejectedItemsIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.FxRateDto":{"type":"object","properties":{"name":{"type":"string"},"fromCurrency":{"type":"string"},"toCurrency":{"type":"string"},"rawRate":{"format":"double","type":"number"},"margin":{"format":"double","type":"number"},"marginRate":{"format":"double","type":"number"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.OrderResponse.ExtendedOrderShopperDetailsDto":{"type":"object","properties":{"phoneNumber":{"type":"string"},"locale":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"address":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShopperAddressDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShopperAddressDto":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"regionName":{"type":"string"},"countryName":{"type":"string"},"postalCode":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.PaymentDto":{"type":"object","properties":{"method":{"type":"string"},"settled":{"type":"boolean"},"paymentBrand":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.FxRateDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.FxRateDto":{"type":"object","properties":{"name":{"type":"string"},"fromCurrency":{"type":"string"},"toCurrency":{"type":"string"},"rawRate":{"format":"double","type":"number"},"margin":{"format":"double","type":"number"},"marginRate":{"format":"double","type":"number"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.OrderResponse.ExtendedOrderShopperDetailsDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.OrderResponse.ExtendedOrderShopperDetailsDto":{"type":"object","properties":{"phoneNumber":{"type":"string"},"locale":{"type":"string"},"firstName":{"type":"string"},"lastName":{"type":"string"},"email":{"type":"string"},"address":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShopperAddressDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShopperAddressDto":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"regionName":{"type":"string"},"countryName":{"type":"string"},"postalCode":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.OrderResponse.OrderItemDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.OrderResponse.OrderItemDto":{"type":"object","properties":{"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"monolithId":{"format":"int64","type":"integer"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"unitCharges":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitChargeDto"}},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShippingInformationDto"},"deliveryEstimates":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.DeliveryEstimatesDto"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReplacementInformationDto"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"isDigital":{"type":"boolean"},"prohibitedForReturns":{"type":"boolean"},"availableForReturns":{"type":"boolean"},"overrideProhibitedForReturns":{"type":"boolean"},"unlimitedPeriodForReturns":{"type":"boolean"},"returnWindow":{"format":"int32","type":"integer"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto"},"articlePaymentReceived":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.UnitChargeDto":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShippingInformationDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"shippingReferenceLastMile":{"type":"string"},"carrierReference":{"type":"string"},"barcodeReference":{"type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.DeliveryEstimatesDto":{"type":"object","properties":{"eddMinDate":{"format":"date-time","type":"string"},"eddMaxDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReplacementType"},"reason":{"type":"string"},"isReplacementFor":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReplacementType":{"enum":["Replacement","Replaced","ExchangeReplacement","Exchanged","NativeExchangeReplacement"],"type":"string"},"Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto":{"type":"object","properties":{"centreId":{"type":"string"},"countryIso":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnOrderDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnOrderDto":{"type":"object","properties":{"returnOrderNumber":{"type":"string"},"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"paidBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.PaidBy"},"customerReturnStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderStatus"},"returnProcessedOn":{"format":"date-time","type":"string"},"returnAdminCentreCode":{"type":"string"},"createdOn":{"format":"date-time","type":"string"},"returnItems":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnItemDto"}},"carrierServiceRouteId":{"type":"string"},"waivedShippingCost":{"type":"boolean"},"paymentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.PaymentInformationDto"},"rejectedReturnPackage":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Domain.Enums.PaidBy":{"enum":["Unpaid","Retailer","Shopper"],"type":"string"},"Returns.Oms.Domain.Enums.ReturnOrderStatus":{"enum":["Pending","Created","Received","OnHold","Released","Processed","AddedToManifest","SentToRetailer","ReceivedByRetailer","RemovedFromManifest","Cancelled","Refunded"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnItemDto":{"type":"object","properties":{"id":{"type":"string"},"returnItemReasonCode":{"type":"string"},"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnItemStatus"},"rejectionReason":{"type":"string"},"rejectionReasonDescription":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"dispositionId":{"type":"string"},"productDescription":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"colorNumber":{"type":"string"},"size":{"type":"string"},"styleNumber":{"type":"string"},"returnItemReasonComment":{"type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReplacementInformationDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReplacementType"},"reason":{"type":"string"},"isReplacementFor":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReplacementType":{"enum":["Replacement","Replaced","ExchangeReplacement","Exchanged","NativeExchangeReplacement"],"type":"string"},"Returns.Oms.Application.UseCases.Common.PaymentInformationDto":{"type":"object","properties":{"checkoutReference":{"type":"string"},"method":{"type":"string"},"price":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto":{"type":"object","properties":{"packageNumber":{"format":"int64","type":"integer"},"carrierTrackingReference":{"type":"string"},"carrierTrackingUrl":{"type":"string"},"rejectedItemsIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.PaymentDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.PaymentDto":{"type":"object","properties":{"method":{"type":"string"},"settled":{"type":"boolean"},"paymentBrand":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.DeliveryEstimatesDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.DeliveryEstimatesDto":{"type":"object","properties":{"eddMinDate":{"format":"date-time","type":"string"},"eddMaxDate":{"format":"date-time","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto":{"type":"object","properties":{"centreId":{"type":"string"},"countryIso":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnItemDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.OrderResponse.ReturnItemDto":{"type":"object","properties":{"id":{"type":"string"},"returnItemReasonCode":{"type":"string"},"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnItemStatus"},"rejectionReason":{"type":"string"},"rejectionReasonDescription":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"dispositionId":{"type":"string"},"productDescription":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"colorNumber":{"type":"string"},"size":{"type":"string"},"styleNumber":{"type":"string"},"returnItemReasonComment":{"type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReplacementInformationDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReplacementType"},"reason":{"type":"string"},"isReplacementFor":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReplacementType":{"enum":["Replacement","Replaced","ExchangeReplacement","Exchanged","NativeExchangeReplacement"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.PaymentInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.PaymentInformationDto":{"type":"object","properties":{"checkoutReference":{"type":"string"},"method":{"type":"string"},"price":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.ReplacementInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReplacementType"},"reason":{"type":"string"},"isReplacementFor":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReplacementType":{"enum":["Replacement","Replaced","ExchangeReplacement","Exchanged","NativeExchangeReplacement"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.ShippingInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ShippingInformationDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"shippingReferenceLastMile":{"type":"string"},"carrierReference":{"type":"string"},"barcodeReference":{"type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.ShopperAddressDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ShopperAddressDto":{"type":"object","properties":{"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"regionName":{"type":"string"},"countryName":{"type":"string"},"postalCode":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.UnitChargeDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.UnitChargeDto":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.UnitPriceDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.WeightDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto":{"type":"object","properties":{"packageNumber":{"format":"int64","type":"integer"},"carrierTrackingReference":{"type":"string"},"carrierTrackingUrl":{"type":"string"},"rejectedItemsIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}}
```

## The Returns.Oms.Domain.Enums.PaidBy object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.PaidBy":{"enum":["Unpaid","Retailer","Shopper"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.ReturnMethod object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.ReturnOrderStatus object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ReturnOrderStatus":{"enum":["Pending","Created","Received","OnHold","Released","Processed","AddedToManifest","SentToRetailer","ReceivedByRetailer","RemovedFromManifest","Cancelled","Refunded"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.ReplacementType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ReplacementType":{"enum":["Replacement","Replaced","ExchangeReplacement","Exchanged","NativeExchangeReplacement"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.ReturnItemStatus object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.ShippingStatus object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.WeightUnit object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.GetReturnOrder.GetReturnOrderWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.GetReturnOrder.GetReturnOrderWebResponse":{"description":"Get Return Order response object","type":"object","properties":{"contacts":{"description":"Return Order Contacts","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnLabelDtos.ReturnContactInformationDto"}},"id":{"description":"Id","type":"string"},"status":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderStatus"},"returnAdminCentreCode":{"description":"Return Admin Centre Code","type":"string"},"storeReturnsCentreCode":{"description":"Store Returns Centre Code (for RTS returns)","type":"string"},"returnsListingsGuid":{"format":"uuid","description":"Returns listing guid","type":"string"},"returnType":{"$ref":"#/components/schemas/Returns.Oms.Api.UseCases.Common.ReturnType"},"returnOrderNumber":{"description":"Return order number","type":"string"},"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"isPaperlessRoute":{"description":"Is paperless route","type":"boolean"},"paidBy":{"description":"Paid By","type":"string"},"carrierIdentifier":{"description":"Carrier Identifier","type":"string"},"countryCode":{"description":"Country Code (Origin Country ISO)","type":"string"},"dropOffLocation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.DropOffLocationDto"},"orderReference":{"description":"Order Reference","type":"string"},"createdOn":{"format":"date-time","description":"Date return order was created on","type":"string"},"lastUpdated":{"format":"date-time","description":"Date return order was last updated","type":"string"},"returnProcessedOn":{"format":"date-time","description":"Date return order was processed","type":"string"},"returnItems":{"description":"Return items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnOrderItemDto"}},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"routeCode":{"description":"RouteCode","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.PaymentInformationDto"},"store":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.StoreDto"},"waivedShippingCost":{"description":"Waived shipping cost","type":"boolean"},"splitInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.SplitInformationDto"},"rejectedReturnPackage":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto"},"retailerIdentifier":{"description":"Retailer Identifier","type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnLabelDtos.ReturnContactInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ContactType"},"firstName":{"type":"string"},"lastName":{"type":"string"},"unit":{"type":"string"},"poBox":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"},"cultureLanguageIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ContactType":{"enum":["Sender","Collection","PUDO"],"type":"string"},"Returns.Oms.Domain.Enums.ReturnOrderStatus":{"enum":["Pending","Created","Received","OnHold","Released","Processed","AddedToManifest","SentToRetailer","ReceivedByRetailer","RemovedFromManifest","Cancelled","Refunded"],"type":"string"},"Returns.Oms.Api.UseCases.Common.ReturnType":{"format":"int32","description":"Return Type Enum","enum":[1,2,3,4,5,6,7,8],"type":"integer"},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Application.UseCases.Common.DropOffLocationDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.LocationType"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"sortcode":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"telephone":{"type":"string"},"email":{"type":"string"},"openingTimesDescription":{"type":"string"},"openingTimes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OpeningTimeDto"}},"carrierServiceRouteId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.LocationType":{"enum":["Store","Pudo"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OpeningTimeDto":{"type":"object","properties":{"day":{"type":"string"},"opens":{"type":"string"},"closes":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReturnOrderItemDto":{"type":"object","properties":{"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnItemStatus"},"rejectionReason":{"type":"string"},"returnReasons":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto"}},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"prohibitedForReturns":{"type":"boolean"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShippingInformationDto"},"grading":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto":{"type":"object","properties":{"reasonCode":{"type":"string"},"description":{"type":"string"},"reasonComment":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"suppliedBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderParty"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnOrderParty":{"enum":["Shopper","CustomerService"],"type":"string"},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShippingInformationDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"shippingReferenceLastMile":{"type":"string"},"carrierReference":{"type":"string"},"barcodeReference":{"type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto":{"type":"object","properties":{"gradingType":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto":{"type":"object","properties":{"centreId":{"type":"string"},"countryIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.PaymentInformationDto":{"type":"object","properties":{"checkoutReference":{"type":"string"},"method":{"type":"string"},"price":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.StoreDto":{"type":"object","properties":{"tenantCode":{"type":"string"},"countryCode":{"type":"string"},"id":{"type":"string"},"storeName":{"type":"string"},"storeType":{"type":"string"},"partnerName":{"type":"string"},"storeNumber":{"format":"int64","type":"integer"},"city":{"type":"string"},"region":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"postalCode":{"type":"string"},"phoneNumber":{"type":"string"},"location":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.StoreLocationDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.StoreLocationDto":{"type":"object","properties":{"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.SplitInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.SplitType"},"originalReturnOrderNumber":{"type":"string"},"splitsReturnOrderNumbers":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"Returns.Oms.Domain.Entities.SplitType":{"format":"int32","enum":[0,1],"type":"integer"},"Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto":{"type":"object","properties":{"packageNumber":{"format":"int64","type":"integer"},"carrierTrackingReference":{"type":"string"},"carrierTrackingUrl":{"type":"string"},"rejectedItemsIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}}
```

## The Returns.Oms.Api.UseCases.Common.ReturnType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.Common.ReturnType":{"format":"int32","description":"Return Type Enum","enum":[1,2,3,4,5,6,7,8],"type":"integer"}}}}
```

## The Returns.Oms.Application.UseCases.Common.DropOffLocationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.DropOffLocationDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.LocationType"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"sortcode":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"telephone":{"type":"string"},"email":{"type":"string"},"openingTimesDescription":{"type":"string"},"openingTimes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OpeningTimeDto"}},"carrierServiceRouteId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.LocationType":{"enum":["Store","Pudo"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OpeningTimeDto":{"type":"object","properties":{"day":{"type":"string"},"opens":{"type":"string"},"closes":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.ReturnOrderItemDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ReturnOrderItemDto":{"type":"object","properties":{"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnItemStatus"},"rejectionReason":{"type":"string"},"returnReasons":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto"}},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"prohibitedForReturns":{"type":"boolean"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShippingInformationDto"},"grading":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto":{"type":"object","properties":{"reasonCode":{"type":"string"},"description":{"type":"string"},"reasonComment":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"suppliedBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderParty"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnOrderParty":{"enum":["Shopper","CustomerService"],"type":"string"},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShippingInformationDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"shippingReferenceLastMile":{"type":"string"},"carrierReference":{"type":"string"},"barcodeReference":{"type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto":{"type":"object","properties":{"gradingType":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto":{"type":"object","properties":{"centreId":{"type":"string"},"countryIso":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.SplitInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.SplitInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.SplitType"},"originalReturnOrderNumber":{"type":"string"},"splitsReturnOrderNumbers":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"Returns.Oms.Domain.Entities.SplitType":{"format":"int32","enum":[0,1],"type":"integer"}}}}
```

## The Returns.Oms.Application.UseCases.Common.StoreDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.StoreDto":{"type":"object","properties":{"tenantCode":{"type":"string"},"countryCode":{"type":"string"},"id":{"type":"string"},"storeName":{"type":"string"},"storeType":{"type":"string"},"partnerName":{"type":"string"},"storeNumber":{"format":"int64","type":"integer"},"city":{"type":"string"},"region":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"postalCode":{"type":"string"},"phoneNumber":{"type":"string"},"location":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.StoreLocationDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.StoreLocationDto":{"type":"object","properties":{"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnLabelDtos.ReturnContactInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnLabelDtos.ReturnContactInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ContactType"},"firstName":{"type":"string"},"lastName":{"type":"string"},"unit":{"type":"string"},"poBox":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"},"cultureLanguageIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ContactType":{"enum":["Sender","Collection","PUDO"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.OpeningTimeDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.OpeningTimeDto":{"type":"object","properties":{"day":{"type":"string"},"opens":{"type":"string"},"closes":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto":{"type":"object","properties":{"gradingType":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto":{"type":"object","properties":{"reasonCode":{"type":"string"},"description":{"type":"string"},"reasonComment":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"suppliedBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderParty"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnOrderParty":{"enum":["Shopper","CustomerService"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.StoreLocationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.StoreLocationDto":{"type":"object","properties":{"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Domain.Entities.SplitType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Entities.SplitType":{"format":"int32","enum":[0,1],"type":"integer"}}}}
```

## The Returns.Oms.Domain.Enums.ContactType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ContactType":{"enum":["Sender","Collection","PUDO"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.LocationType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.LocationType":{"enum":["Store","Pudo"],"type":"string"}}}}
```

## The Returns.Oms.Domain.Enums.ReturnOrderParty object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ReturnOrderParty":{"enum":["Shopper","CustomerService"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderWebRequest":{"description":"Create Return Order WebRequest","type":"object","properties":{"consumerEmailAddress":{"description":"Consumer Email Address","type":"string"},"cultureLanguageIso":{"description":"Culture Language ISO","type":"string"},"returnItems":{"description":"Return Items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.ReturnItemRequestDto"}},"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"returnType":{"$ref":"#/components/schemas/Returns.Oms.Api.UseCases.Common.ReturnType"},"isPaperlessRoute":{"description":"Is paperless route","type":"boolean"},"paidBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.PaidBy"},"carrierIdentifier":{"description":"Carrier Identifier","type":"string"},"dropOffLocation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.DropOffLocationDto"},"shippingReference":{"description":"Shipping Reference","type":"string"},"barcodeReference":{"description":"Barcode reference","type":"string"},"carrierReference":{"description":"Barcode reference","type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"returnAdminCentreCodeOverride":{"description":"Return admin centre code override","type":"string"},"skipRouteCode":{"description":"Skip Route Code assignment for the return if true","type":"boolean"},"skipSortationAndSplit":{"description":"If the skip flag is true, then the return order will not be split or sorted.","type":"boolean"},"collectionInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.CollectionInformationDto"},"returnOrderNumber":{"format":"int64","description":"Return Order Number","type":"integer"},"isSynchronousRequest":{"description":"Process the request synchronously. When true, the return order creation will complete\r\nbefore returning a response, similar to the migration endpoint behavior.","type":"boolean"},"includeInstructions":{"description":"Include instructions with LIAB label","type":"boolean"},"virtualBrandIdentifier":{"description":"Virtual brand identifier for returns partners","type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.ReturnItemRequestDto":{"type":"object","properties":{"reasonCode":{"type":"string"},"reasonComment":{"type":"string"},"dispositionId":{"type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto"},"monolithId":{"type":"string"},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType":{"enum":["ExchangeReplacement","Exchanged"],"type":"string"},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Api.UseCases.Common.ReturnType":{"format":"int32","description":"Return Type Enum","enum":[1,2,3,4,5,6,7,8],"type":"integer"},"Returns.Oms.Domain.Enums.PaidBy":{"enum":["Unpaid","Retailer","Shopper"],"type":"string"},"Returns.Oms.Application.UseCases.Common.DropOffLocationDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.LocationType"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"sortcode":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"telephone":{"type":"string"},"email":{"type":"string"},"openingTimesDescription":{"type":"string"},"openingTimes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OpeningTimeDto"}},"carrierServiceRouteId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.LocationType":{"enum":["Store","Pudo"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OpeningTimeDto":{"type":"object","properties":{"day":{"type":"string"},"opens":{"type":"string"},"closes":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Oms.Application.UseCases.Common.CollectionInformationDto":{"type":"object","properties":{"date":{"format":"date","type":"string"},"address":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.CollectionAddressDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.CollectionAddressDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderWebResponse":{"description":"Create Return Order WebResponse","type":"object","properties":{"returnsListingsGuid":{"format":"uuid","description":"Returns Listings Guid","type":"string"},"returnOrderNumber":{"description":"Return Order Number","type":"string"},"returnType":{"description":"Return Type","type":"string"},"returnMethod":{"description":"Return Method","type":"string"},"paidBy":{"description":"Paid By","type":"string"},"carrierIdentifier":{"description":"Carrier Identifier","type":"string"},"isPaperlessRoute":{"description":"Is paperless route","type":"boolean"},"returnItems":{"description":"Return Items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderItemWebResponse"}},"dropOffLocation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.DropOffLocationDto"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"paymentRedirectUrl":{"description":"Payment redirect url","type":"string"},"label":{"description":"Base 64 encoded label","type":"string"}},"additionalProperties":false},"Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderItemWebResponse":{"description":"Return Item Web Response","type":"object","properties":{"id":{"description":"Id","type":"string"},"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line Item Id","type":"string"},"productDescription":{"description":"Product description","type":"string"},"productImageUrl":{"description":"Product Image Url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"reasonCode":{"description":"Reason Code","type":"string"},"dispositionId":{"description":"Disposition Id","type":"string"},"reasonComment":{"description":"Reason comment","type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType":{"enum":["ExchangeReplacement","Exchanged"],"type":"string"},"Returns.Oms.Application.UseCases.Common.DropOffLocationDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.LocationType"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"sortcode":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"telephone":{"type":"string"},"email":{"type":"string"},"openingTimesDescription":{"type":"string"},"openingTimes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OpeningTimeDto"}},"carrierServiceRouteId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.LocationType":{"enum":["Store","Pudo"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OpeningTimeDto":{"type":"object","properties":{"day":{"type":"string"},"opens":{"type":"string"},"closes":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderItemWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.CreateReturnOrder.CreateReturnOrderItemWebResponse":{"description":"Return Item Web Response","type":"object","properties":{"id":{"description":"Id","type":"string"},"productCode":{"description":"Product code","type":"string"},"lineItemId":{"description":"Line Item Id","type":"string"},"productDescription":{"description":"Product description","type":"string"},"productImageUrl":{"description":"Product Image Url","type":"string"},"color":{"description":"Color","type":"string"},"size":{"description":"Size","type":"string"},"category":{"description":"Category","type":"string"},"reasonCode":{"description":"Reason Code","type":"string"},"dispositionId":{"description":"Disposition Id","type":"string"},"reasonComment":{"description":"Reason comment","type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType":{"enum":["ExchangeReplacement","Exchanged"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.CollectionInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.CollectionInformationDto":{"type":"object","properties":{"date":{"format":"date","type":"string"},"address":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.CollectionAddressDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.CollectionAddressDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateReturnOrder.ReturnItemRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateReturnOrder.ReturnItemRequestDto":{"type":"object","properties":{"reasonCode":{"type":"string"},"reasonComment":{"type":"string"},"dispositionId":{"type":"string"},"replacementInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto"},"monolithId":{"type":"string"},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType":{"enum":["ExchangeReplacement","Exchanged"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.CollectionAddressDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.CollectionAddressDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnReplacementInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"},"productImageUrl":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType":{"enum":["ExchangeReplacement","Exchanged"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateReturnOrder.RequestReplacementType":{"enum":["ExchangeReplacement","Exchanged"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.SearchReturnMethods.SearchReturnMethodsWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.SearchReturnMethods.SearchReturnMethodsWebRequest":{"description":"Search Return Methods Web Request","type":"object","properties":{"returnItems":{"description":"Return Items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemDto"}},"isShopperAtFault":{"description":"Indicates whether the shopper is at fault","type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReturnItemDto":{"type":"object","properties":{"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Api.UseCases.SearchReturnMethods.SearchReturnMethodsWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.SearchReturnMethods.SearchReturnMethodsWebResponse":{"description":"Search Return Methods Web Response","type":"object","properties":{"orderReference":{"description":"Order Reference","type":"string"},"originCountryIso":{"description":"Origin Country Iso","type":"string"},"destinationCountryIso":{"description":"Destination Country Iso","type":"string"},"selectedReturnAdminCentreCode":{"description":"Selected return admin centre code","type":"string"},"returnMethods":{"description":"Return Methods","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.SearchReturnMethods.ReturnMethodDto"}}},"additionalProperties":false},"Returns.Oms.Application.UseCases.SearchReturnMethods.ReturnMethodDto":{"type":"object","properties":{"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"paidBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.PaidBy"},"shippingRate":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.SearchReturnMethods.ShippingRateDto"},"carrierServiceRoute":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.SearchReturnMethods.CarrierServiceRouteDto"},"isShippingRateWaived":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Domain.Enums.PaidBy":{"enum":["Unpaid","Retailer","Shopper"],"type":"string"},"Returns.Oms.Application.UseCases.SearchReturnMethods.ShippingRateDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.SearchReturnMethods.CarrierServiceRouteDto":{"type":"object","properties":{"carrierServiceRouteId":{"type":"string"},"eswCarrierIdentifier":{"type":"string"},"carrierName":{"type":"string"},"serviceType":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ServiceType"},"carrierServiceCode":{"type":"string"},"carrierServiceName":{"type":"string"},"isPaperlessRoute":{"type":"boolean"},"isLocationRequired":{"type":"boolean"},"returnsCollections":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ServiceType":{"enum":["Express","Post","PUDO","Collection"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.Common.ReturnItemDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ReturnItemDto":{"type":"object","properties":{"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.SearchReturnMethods.ReturnMethodDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.SearchReturnMethods.ReturnMethodDto":{"type":"object","properties":{"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"paidBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.PaidBy"},"shippingRate":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.SearchReturnMethods.ShippingRateDto"},"carrierServiceRoute":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.SearchReturnMethods.CarrierServiceRouteDto"},"isShippingRateWaived":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Domain.Enums.PaidBy":{"enum":["Unpaid","Retailer","Shopper"],"type":"string"},"Returns.Oms.Application.UseCases.SearchReturnMethods.ShippingRateDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.SearchReturnMethods.CarrierServiceRouteDto":{"type":"object","properties":{"carrierServiceRouteId":{"type":"string"},"eswCarrierIdentifier":{"type":"string"},"carrierName":{"type":"string"},"serviceType":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ServiceType"},"carrierServiceCode":{"type":"string"},"carrierServiceName":{"type":"string"},"isPaperlessRoute":{"type":"boolean"},"isLocationRequired":{"type":"boolean"},"returnsCollections":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ServiceType":{"enum":["Express","Post","PUDO","Collection"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.SearchReturnMethods.CarrierServiceRouteDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.SearchReturnMethods.CarrierServiceRouteDto":{"type":"object","properties":{"carrierServiceRouteId":{"type":"string"},"eswCarrierIdentifier":{"type":"string"},"carrierName":{"type":"string"},"serviceType":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ServiceType"},"carrierServiceCode":{"type":"string"},"carrierServiceName":{"type":"string"},"isPaperlessRoute":{"type":"boolean"},"isLocationRequired":{"type":"boolean"},"returnsCollections":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ServiceType":{"enum":["Express","Post","PUDO","Collection"],"type":"string"}}}}
```

## The Returns.Oms.Application.UseCases.SearchReturnMethods.ShippingRateDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.SearchReturnMethods.ShippingRateDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Domain.Enums.ServiceType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Enums.ServiceType":{"enum":["Express","Post","PUDO","Collection"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.GetTrackingEvents.GetTrackingEventsWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.GetTrackingEvents.GetTrackingEventsWebRequest":{"description":"Get tracking events web request","type":"object","properties":{"outboundOrderReference":{"description":"Outbound Order Reference","type":"string"},"trackingReference":{"format":"int64","description":"Tracking reference","type":"integer"},"emailAddress":{"description":"Email address","type":"string"},"isViewableByShopper":{"description":"Is viewable by shopper","type":"boolean"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.GetTrackingEvents.GetTrackingEventsResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.GetTrackingEvents.GetTrackingEventsResponse":{"type":"object","properties":{"milestones":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.GetTrackingEvents.MilestoneResponseDto"}},"events":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.GetTrackingEvents.TrackingEventDetailsResponseDto"}},"carrier":{"type":"string"},"carrierReference":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.GetTrackingEvents.MilestoneResponseDto":{"type":"object","properties":{"code":{"type":"string"},"dateTime":{"format":"date-time","type":"string"},"location":{"type":"string"},"isCurrentMilestone":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.GetTrackingEvents.TrackingEventDetailsResponseDto":{"type":"object","properties":{"code":{"type":"string"},"dateTime":{"format":"date-time","type":"string"},"location":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.GetTrackingEvents.MilestoneResponseDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.GetTrackingEvents.MilestoneResponseDto":{"type":"object","properties":{"code":{"type":"string"},"dateTime":{"format":"date-time","type":"string"},"location":{"type":"string"},"isCurrentMilestone":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.GetTrackingEvents.TrackingEventDetailsResponseDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.GetTrackingEvents.TrackingEventDetailsResponseDto":{"type":"object","properties":{"code":{"type":"string"},"dateTime":{"format":"date-time","type":"string"},"location":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.GetCountryConfiguration.GetCountryConfigurationResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.GetCountryConfiguration.GetCountryConfigurationResponse":{"type":"object","properties":{"organisationId":{"type":"string"},"tenantCode":{"type":"string"},"brandCode":{"type":"string"},"brandName":{"type":"string"},"countryIso":{"type":"string"},"currencyIso":{"type":"string"},"returnsOmsEnabled":{"type":"boolean"},"portalSettings":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.BrandCountryPortalSettingsDto"},"locales":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.LocaleDto"}},"brandCountryReturnsCentreSettings":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.BrandCountryReturnsCentreSettingsDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.BrandCountryPortalSettingsDto":{"type":"object","properties":{"customerReturnReasonCodes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.CustomerReturnReasonCodeDto"}},"returnsPortalConfigurationSettings":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnsPortalConfigurationSettingsDto"},"blockDefectiveDangerGoods":{"type":"boolean"},"returnToStoreIsEnabled":{"type":"boolean"},"ingestionEnabled":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.CustomerReturnReasonCodeDto":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"visibleOnUI":{"type":"boolean"},"descriptionRequired":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReturnsPortalConfigurationSettingsDto":{"type":"object","properties":{"showRefund":{"type":"boolean"},"showLabel":{"type":"boolean"},"returnReasonMandatory":{"type":"boolean"},"noOfDaysAllowedForReturn":{"format":"int32","type":"integer"},"numberOfDeliveryDaysRequired":{"format":"int32","type":"integer"},"shippedPeriodDays":{"format":"int32","type":"integer"},"cancelOrderNoOfDays":{"format":"int32","type":"integer"},"isCancelOrderAllowed":{"type":"boolean"},"supportNativeExchanges":{"type":"boolean"},"displayImageThumbnails":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.LocaleDto":{"type":"object","properties":{"name":{"type":"string"},"cultureInfoCode":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.BrandCountryReturnsCentreSettingsDto":{"type":"object","properties":{"returnsCentreProcessingFee":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.ReturnsCentreProcessingFeeModel"}},"additionalProperties":false},"Returns.Oms.Domain.Entities.ReturnsCentreProcessingFeeModel":{"type":"object","properties":{"currencyIso":{"type":"string"},"amount":{"format":"double","type":"number"},"applyForShopperAtFault":{"type":"boolean"},"includeReturnFee":{"type":"boolean"},"includeMemberAndNonMemberFee":{"type":"boolean"},"memberFee":{"format":"double","type":"number"},"nonMemberFee":{"format":"double","type":"number"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.BrandCountryPortalSettingsDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.BrandCountryPortalSettingsDto":{"type":"object","properties":{"customerReturnReasonCodes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.CustomerReturnReasonCodeDto"}},"returnsPortalConfigurationSettings":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnsPortalConfigurationSettingsDto"},"blockDefectiveDangerGoods":{"type":"boolean"},"returnToStoreIsEnabled":{"type":"boolean"},"ingestionEnabled":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.CustomerReturnReasonCodeDto":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"visibleOnUI":{"type":"boolean"},"descriptionRequired":{"type":"boolean"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReturnsPortalConfigurationSettingsDto":{"type":"object","properties":{"showRefund":{"type":"boolean"},"showLabel":{"type":"boolean"},"returnReasonMandatory":{"type":"boolean"},"noOfDaysAllowedForReturn":{"format":"int32","type":"integer"},"numberOfDeliveryDaysRequired":{"format":"int32","type":"integer"},"shippedPeriodDays":{"format":"int32","type":"integer"},"cancelOrderNoOfDays":{"format":"int32","type":"integer"},"isCancelOrderAllowed":{"type":"boolean"},"supportNativeExchanges":{"type":"boolean"},"displayImageThumbnails":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.BrandCountryReturnsCentreSettingsDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.BrandCountryReturnsCentreSettingsDto":{"type":"object","properties":{"returnsCentreProcessingFee":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.ReturnsCentreProcessingFeeModel"}},"additionalProperties":false},"Returns.Oms.Domain.Entities.ReturnsCentreProcessingFeeModel":{"type":"object","properties":{"currencyIso":{"type":"string"},"amount":{"format":"double","type":"number"},"applyForShopperAtFault":{"type":"boolean"},"includeReturnFee":{"type":"boolean"},"includeMemberAndNonMemberFee":{"type":"boolean"},"memberFee":{"format":"double","type":"number"},"nonMemberFee":{"format":"double","type":"number"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.LocaleDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.LocaleDto":{"type":"object","properties":{"name":{"type":"string"},"cultureInfoCode":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.CustomerReturnReasonCodeDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.CustomerReturnReasonCodeDto":{"type":"object","properties":{"code":{"type":"string"},"description":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"visibleOnUI":{"type":"boolean"},"descriptionRequired":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.Common.ReturnsPortalConfigurationSettingsDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.Common.ReturnsPortalConfigurationSettingsDto":{"type":"object","properties":{"showRefund":{"type":"boolean"},"showLabel":{"type":"boolean"},"returnReasonMandatory":{"type":"boolean"},"noOfDaysAllowedForReturn":{"format":"int32","type":"integer"},"numberOfDeliveryDaysRequired":{"format":"int32","type":"integer"},"shippedPeriodDays":{"format":"int32","type":"integer"},"cancelOrderNoOfDays":{"format":"int32","type":"integer"},"isCancelOrderAllowed":{"type":"boolean"},"supportNativeExchanges":{"type":"boolean"},"displayImageThumbnails":{"type":"boolean"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Domain.Entities.ReturnsCentreProcessingFeeModel object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Entities.ReturnsCentreProcessingFeeModel":{"type":"object","properties":{"currencyIso":{"type":"string"},"amount":{"format":"double","type":"number"},"applyForShopperAtFault":{"type":"boolean"},"includeReturnFee":{"type":"boolean"},"includeMemberAndNonMemberFee":{"type":"boolean"},"memberFee":{"format":"double","type":"number"},"nonMemberFee":{"format":"double","type":"number"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Api.UseCases.UpdateReturnOrder.UpdateReturnOrderWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.UpdateReturnOrder.UpdateReturnOrderWebRequest":{"description":"Update Return Order web request.","type":"object","properties":{"status":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderStatus"},"statusReason":{"description":"Return order status reason","type":"string"},"returnItems":{"description":"Return Items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnOrderItemDto"}},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"skipSortationAndSplit":{"description":"if the skip flag equal true then the return order will not be spilled or sorted.","type":"boolean"},"addItemForOnHold":{"description":"If true, bypasses the validation of the return item processed status.","type":"boolean"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnOrderStatus":{"enum":["Pending","Created","Received","OnHold","Released","Processed","AddedToManifest","SentToRetailer","ReceivedByRetailer","RemovedFromManifest","Cancelled","Refunded"],"type":"string"},"Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnOrderItemDto":{"type":"object","properties":{"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnItemStatus"},"rejectionReason":{"type":"string"},"reasonCodeOverride":{"type":"string"},"reasonCode":{"type":"string"},"grading":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto"},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnItemStatus":{"enum":["InProgress","Accepted","Rejected"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto":{"type":"object","properties":{"gradingType":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.UpdateReturnOrder.UpdateReturnOrderWebResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.UpdateReturnOrder.UpdateReturnOrderWebResponse":{"description":"Update Return Order web response.","type":"object","properties":{"contacts":{"description":"Return Order Contacts","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnLabelDtos.ReturnContactInformationDto"}},"id":{"description":"Id","type":"string"},"status":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderStatus"},"returnAdminCentreCode":{"description":"Return Admin Centre Code","type":"string"},"storeReturnsCentreCode":{"description":"Store Returns Centre Code (for RTS returns)","type":"string"},"returnsListingsGuid":{"format":"uuid","description":"Returns listing guid","type":"string"},"returnType":{"$ref":"#/components/schemas/Returns.Oms.Api.UseCases.Common.ReturnType"},"returnOrderNumber":{"description":"Return order number","type":"string"},"returnMethod":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnMethod"},"isPaperlessRoute":{"description":"Is paperless route","type":"boolean"},"paidBy":{"description":"Paid By","type":"string"},"carrierIdentifier":{"description":"Carrier Identifier","type":"string"},"countryCode":{"description":"Country Code (Origin Country ISO)","type":"string"},"dropOffLocation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.DropOffLocationDto"},"orderReference":{"description":"Order Reference","type":"string"},"createdOn":{"format":"date-time","description":"Date return order was created on","type":"string"},"lastUpdated":{"format":"date-time","description":"Date return order was last updated","type":"string"},"returnProcessedOn":{"format":"date-time","description":"Date return order was processed","type":"string"},"returnItems":{"description":"Return items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnOrderItemDto"}},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"routeCode":{"description":"RouteCode","type":"string"},"paymentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.PaymentInformationDto"},"store":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.StoreDto"},"waivedShippingCost":{"description":"Waived shipping cost","type":"boolean"},"splitInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.SplitInformationDto"},"rejectedReturnPackage":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto"},"retailerIdentifier":{"description":"Retailer Identifier","type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateReturnOrder.CreateReturnLabelDtos.ReturnContactInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ContactType"},"firstName":{"type":"string"},"lastName":{"type":"string"},"unit":{"type":"string"},"poBox":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"},"cultureLanguageIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ContactType":{"enum":["Sender","Collection","PUDO"],"type":"string"},"Returns.Oms.Domain.Enums.ReturnOrderStatus":{"enum":["Pending","Created","Received","OnHold","Released","Processed","AddedToManifest","SentToRetailer","ReceivedByRetailer","RemovedFromManifest","Cancelled","Refunded"],"type":"string"},"Returns.Oms.Api.UseCases.Common.ReturnType":{"format":"int32","description":"Return Type Enum","enum":[1,2,3,4,5,6,7,8],"type":"integer"},"Returns.Oms.Domain.Enums.ReturnMethod":{"enum":["Postal","PUDO","Collection","Store"],"type":"string"},"Returns.Oms.Application.UseCases.Common.DropOffLocationDto":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.LocationType"},"name":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"postcode":{"type":"string"},"sortcode":{"type":"string"},"region":{"type":"string"},"country":{"type":"string"},"telephone":{"type":"string"},"email":{"type":"string"},"openingTimesDescription":{"type":"string"},"openingTimes":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.OpeningTimeDto"}},"carrierServiceRouteId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.LocationType":{"enum":["Store","Pudo"],"type":"string"},"Returns.Oms.Application.UseCases.Common.OpeningTimeDto":{"type":"object","properties":{"day":{"type":"string"},"opens":{"type":"string"},"closes":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ReturnOrderItemDto":{"type":"object","properties":{"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnItemStatus"},"rejectionReason":{"type":"string"},"returnReasons":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto"}},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.WeightDto"},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"prohibitedForReturns":{"type":"boolean"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ShippingInformationDto"},"grading":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto"},"fulfilmentInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnItemStatus":{"enum":["InProgress","Accepted","Rejected","RejectedNotReturned","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemReasonDto":{"type":"object","properties":{"reasonCode":{"type":"string"},"description":{"type":"string"},"reasonComment":{"type":"string"},"isRetailerAtFault":{"type":"boolean"},"suppliedBy":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ReturnOrderParty"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ReturnOrderParty":{"enum":["Shopper","CustomerService"],"type":"string"},"Returns.Oms.Application.UseCases.Common.WeightDto":{"type":"object","properties":{"weightTotal":{"format":"double","type":"number"},"weightUnit":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.WeightUnit"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.WeightUnit":{"enum":["Kg","Lb"],"type":"string"},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.ShippingInformationDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"shippingReferenceLastMile":{"type":"string"},"carrierReference":{"type":"string"},"barcodeReference":{"type":"string"},"shippingStatus":{"$ref":"#/components/schemas/Returns.Oms.Domain.Enums.ShippingStatus"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Enums.ShippingStatus":{"enum":["Unshipped","Shipped","Cancelled"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto":{"type":"object","properties":{"gradingType":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.FulfilmentInformationDto":{"type":"object","properties":{"centreId":{"type":"string"},"countryIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.PaymentInformationDto":{"type":"object","properties":{"checkoutReference":{"type":"string"},"method":{"type":"string"},"price":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.StoreDto":{"type":"object","properties":{"tenantCode":{"type":"string"},"countryCode":{"type":"string"},"id":{"type":"string"},"storeName":{"type":"string"},"storeType":{"type":"string"},"partnerName":{"type":"string"},"storeNumber":{"format":"int64","type":"integer"},"city":{"type":"string"},"region":{"type":"string"},"addressLine1":{"type":"string"},"addressLine2":{"type":"string"},"addressLine3":{"type":"string"},"postalCode":{"type":"string"},"phoneNumber":{"type":"string"},"location":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.StoreLocationDto"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.StoreLocationDto":{"type":"object","properties":{"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.SplitInformationDto":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.SplitType"},"originalReturnOrderNumber":{"type":"string"},"splitsReturnOrderNumbers":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"Returns.Oms.Domain.Entities.SplitType":{"format":"int32","enum":[0,1],"type":"integer"},"Returns.Oms.Application.UseCases.UpdateReturnOrder.RejectedReturnPackageDto":{"type":"object","properties":{"packageNumber":{"format":"int64","type":"integer"},"carrierTrackingReference":{"type":"string"},"carrierTrackingUrl":{"type":"string"},"rejectedItemsIds":{"type":"array","items":{"type":"string"}}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnOrderItemDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnOrderItemDto":{"type":"object","properties":{"returnItemStatus":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnItemStatus"},"rejectionReason":{"type":"string"},"reasonCodeOverride":{"type":"string"},"reasonCode":{"type":"string"},"grading":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto"},"id":{"type":"string"},"productCode":{"type":"string"},"lineItemId":{"type":"string"},"retailerLineItemId":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnItemStatus":{"enum":["InProgress","Accepted","Rejected"],"type":"string"},"Returns.Oms.Application.UseCases.Common.ReturnItemGradingDto":{"type":"object","properties":{"gradingType":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnItemStatus object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.UpdateReturnOrder.UpdateReturnItemStatus":{"enum":["InProgress","Accepted","Rejected"],"type":"string"}}}}
```

## The Returns.Oms.Api.UseCases.LabelRequest.LabelRequestWebRequest object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Api.UseCases.LabelRequest.LabelRequestWebRequest":{"description":"Web Request for requesting a pre printed label","type":"object","properties":{"outboundOrderReference":{"description":"Outbound order reference","type":"string"},"shippingReference":{"description":"Shipping reference","type":"string"},"shopperAddress":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateLabelRequest.ShopperAddressDto"},"orderItems":{"description":"Order items","type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateLabelRequest.OrderItemsDto"}},"includeInstructions":{"description":"Include instructions with LIAB label","type":"boolean"},"labelFormat":{"description":"Label Format (ZPL or PDF)","type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateLabelRequest.ShopperAddressDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"unit":{"type":"string"},"poBox":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"},"cultureLanguageIso":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateLabelRequest.OrderItemsDto":{"type":"object","properties":{"id":{"type":"string"},"productCode":{"type":"string"},"monolithId":{"format":"int64","type":"integer"},"parentProductCode":{"type":"string"},"lineItemId":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"composition":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"hsCodeRegion":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestWeightDto"},"unitCharges":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.UnitCharge"}},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestShippingInformationRequestDto"},"colour":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"categoryDescription":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"unitedNationsNumber":{"type":"string"},"packingInstructions":{"type":"string"},"prohibitedForReturns":{"type":"boolean"},"source":{"type":"string"},"material":{"type":"string"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"gender":{"type":"string"},"ageGroup":{"type":"string"},"productUrl":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestWeightDto":{"type":"object","properties":{"itemWeight":{"format":"double","type":"number"},"weightUnit":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Entities.UnitCharge":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestShippingInformationRequestDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"barcodeReference":{"type":"string"},"carrierReference":{"type":"string"},"shippingStatus":{"type":"string"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateLabelRequest.CreateLabelRequestResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateLabelRequest.CreateLabelRequestResponse":{"type":"object","properties":{"prePrintedLabelNumber":{"type":"string"},"orderReference":{"type":"string"},"shippingReference":{"type":"string"},"contentType":{"type":"string"},"carrierTrackingReference":{"type":"string"},"label":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateLabelRequest.OrderItemsDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateLabelRequest.OrderItemsDto":{"type":"object","properties":{"id":{"type":"string"},"productCode":{"type":"string"},"monolithId":{"format":"int64","type":"integer"},"parentProductCode":{"type":"string"},"lineItemId":{"type":"string"},"quantity":{"format":"int32","type":"integer"},"productDescription":{"type":"string"},"productCustomsDescription":{"type":"string"},"composition":{"type":"string"},"countryOfOriginIso":{"type":"string"},"hsCode":{"type":"string"},"hsCodeRegion":{"type":"string"},"weight":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestWeightDto"},"unitCharges":{"type":"array","items":{"$ref":"#/components/schemas/Returns.Oms.Domain.Entities.UnitCharge"}},"unitPrice":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.Common.UnitPriceDto"},"shippingInformation":{"$ref":"#/components/schemas/Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestShippingInformationRequestDto"},"colour":{"type":"string"},"size":{"type":"string"},"category":{"type":"string"},"categoryDescription":{"type":"string"},"personalized":{"type":"boolean"},"dangerousGoods":{"type":"boolean"},"unitedNationsNumber":{"type":"string"},"packingInstructions":{"type":"string"},"prohibitedForReturns":{"type":"boolean"},"source":{"type":"string"},"material":{"type":"string"},"productImageUrl":{"type":"string"},"mid":{"type":"string"},"midZipCode":{"type":"string"},"color":{"type":"string"},"gender":{"type":"string"},"ageGroup":{"type":"string"},"productUrl":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestWeightDto":{"type":"object","properties":{"itemWeight":{"format":"double","type":"number"},"weightUnit":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Domain.Entities.UnitCharge":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.Common.UnitPriceDto":{"type":"object","properties":{"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false},"Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestShippingInformationRequestDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"barcodeReference":{"type":"string"},"carrierReference":{"type":"string"},"shippingStatus":{"type":"string"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateLabelRequest.ShopperAddressDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateLabelRequest.ShopperAddressDto":{"type":"object","properties":{"firstName":{"type":"string"},"lastName":{"type":"string"},"unit":{"type":"string"},"poBox":{"type":"string"},"address1":{"type":"string"},"address2":{"type":"string"},"address3":{"type":"string"},"city":{"type":"string"},"region":{"type":"string"},"postalCode":{"type":"string"},"countryIso":{"type":"string"},"email":{"type":"string"},"telephone":{"type":"string"},"cultureLanguageIso":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestShippingInformationRequestDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestShippingInformationRequestDto":{"type":"object","properties":{"shippingReference":{"type":"string"},"barcodeReference":{"type":"string"},"carrierReference":{"type":"string"},"shippingStatus":{"type":"string"},"statusDate":{"format":"date-time","type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestWeightDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Application.UseCases.CreateLabelRequest.LabelRequestWeightDto":{"type":"object","properties":{"itemWeight":{"format":"double","type":"number"},"weightUnit":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Oms.Domain.Entities.UnitCharge object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Oms.Domain.Entities.UnitCharge":{"type":"object","properties":{"name":{"type":"string"},"amount":{"format":"double","type":"number"},"currency":{"type":"string"}},"additionalProperties":false}}}}
```

## The GetLocationsResponseDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"GetLocationsResponseDto":{"description":"Get locations response DTO implementation.","type":"object","properties":{"locations":{"description":"The list of locations found matching the criteria.","type":"array","items":{"$ref":"#/components/schemas/LocationResponseDto"}}}},"LocationResponseDto":{"description":"Location DTO implementation.","type":"object","properties":{"id":{"description":"The Location identifier. Could be the StoreId, KioskId, OutletId, PickupLocationId etc.","type":"string"},"eswId":{"description":"The EswId identifier. Added for StoreId. Data team expects to get unique store id (GUID) from OMS.","type":"string"},"type":{"$ref":"#/components/schemas/LocationType"},"name":{"description":"The name of the location eg Store Name, Pop Station Name etc.","type":"string"},"shortName":{"description":"The shortened name of the location.","type":"string"},"displayName":{"description":"The display name of the location.","type":"string"},"address1":{"description":"Line 1 of the address.","type":"string"},"address2":{"description":"Line 2 of the address.","type":"string"},"address3":{"description":"Line 3 of the address.","type":"string"},"displayAddress":{"description":"The display address.","type":"string"},"city":{"description":"The city of the location.","type":"string"},"postalCode":{"description":"The postal code of the location.","type":"string"},"sortCode":{"description":"The sort code of the location.","type":"string"},"region":{"description":"The region of the location.","type":"string"},"countryCode":{"description":"The country code for the location.","type":"string"},"country":{"description":"The country name for the location.","type":"string"},"telephone":{"description":"The telephone number of the location.","type":"string"},"email":{"description":"The email address of the location.","type":"string"},"latitude":{"format":"double","description":"Latitude co-ordinates of the location.","type":"number"},"longitude":{"format":"double","description":"Longitude co-ordinates of the location.","type":"number"},"distanceInKms":{"format":"double","description":"Distance to the location in kilometres.","type":"number"},"openingTimesDescription":{"description":"The opening times description for the location.","type":"string"},"openingTimes":{"description":"The opening times for the location.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimeResponseDto"}},"carrierCode":{"type":"string"},"carrierServiceRouteId":{"type":"string"},"locationCapabilities":{"$ref":"#/components/schemas/LocationCapabilities"},"isApproximate":{"type":"boolean"}}},"LocationType":{"enum":["Store","Pudo","Locker"],"type":"string"},"OpeningTimeResponseDto":{"description":"Opening time response DTO implementation.","type":"object","properties":{"day":{"$ref":"#/components/schemas/DayOfWeek"},"opens":{"type":"string"},"closes":{"type":"string"},"storeAvailability":{"$ref":"#/components/schemas/StoreAvailability"}}},"DayOfWeek":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"StoreAvailability":{"enum":["Default","ClosedWholeDay","OpenedWholeDay"],"type":"string"},"LocationCapabilities":{"enum":["None","Shop","PrintInStore","PackagelessReturns","NextDayDropOff","AcceptDelivery","AcceptDropOff"],"type":"string"}}}}
```

## The ProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"ProblemDetails":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"},"instance":{"type":"string"}},"additionalProperties":{}}}}}
```

## The ValidationProblemDetails object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"ValidationProblemDetails":{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"string"},"detail":{"type":"string"},"instance":{"type":"string"}},"additionalProperties":{}}}}}
```

## The LocationResponseDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"LocationResponseDto":{"description":"Location DTO implementation.","type":"object","properties":{"id":{"description":"The Location identifier. Could be the StoreId, KioskId, OutletId, PickupLocationId etc.","type":"string"},"eswId":{"description":"The EswId identifier. Added for StoreId. Data team expects to get unique store id (GUID) from OMS.","type":"string"},"type":{"$ref":"#/components/schemas/LocationType"},"name":{"description":"The name of the location eg Store Name, Pop Station Name etc.","type":"string"},"shortName":{"description":"The shortened name of the location.","type":"string"},"displayName":{"description":"The display name of the location.","type":"string"},"address1":{"description":"Line 1 of the address.","type":"string"},"address2":{"description":"Line 2 of the address.","type":"string"},"address3":{"description":"Line 3 of the address.","type":"string"},"displayAddress":{"description":"The display address.","type":"string"},"city":{"description":"The city of the location.","type":"string"},"postalCode":{"description":"The postal code of the location.","type":"string"},"sortCode":{"description":"The sort code of the location.","type":"string"},"region":{"description":"The region of the location.","type":"string"},"countryCode":{"description":"The country code for the location.","type":"string"},"country":{"description":"The country name for the location.","type":"string"},"telephone":{"description":"The telephone number of the location.","type":"string"},"email":{"description":"The email address of the location.","type":"string"},"latitude":{"format":"double","description":"Latitude co-ordinates of the location.","type":"number"},"longitude":{"format":"double","description":"Longitude co-ordinates of the location.","type":"number"},"distanceInKms":{"format":"double","description":"Distance to the location in kilometres.","type":"number"},"openingTimesDescription":{"description":"The opening times description for the location.","type":"string"},"openingTimes":{"description":"The opening times for the location.","type":"array","items":{"$ref":"#/components/schemas/OpeningTimeResponseDto"}},"carrierCode":{"type":"string"},"carrierServiceRouteId":{"type":"string"},"locationCapabilities":{"$ref":"#/components/schemas/LocationCapabilities"},"isApproximate":{"type":"boolean"}}},"LocationType":{"enum":["Store","Pudo","Locker"],"type":"string"},"OpeningTimeResponseDto":{"description":"Opening time response DTO implementation.","type":"object","properties":{"day":{"$ref":"#/components/schemas/DayOfWeek"},"opens":{"type":"string"},"closes":{"type":"string"},"storeAvailability":{"$ref":"#/components/schemas/StoreAvailability"}}},"DayOfWeek":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"StoreAvailability":{"enum":["Default","ClosedWholeDay","OpenedWholeDay"],"type":"string"},"LocationCapabilities":{"enum":["None","Shop","PrintInStore","PackagelessReturns","NextDayDropOff","AcceptDelivery","AcceptDropOff"],"type":"string"}}}}
```

## The LocationCapabilities object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"LocationCapabilities":{"enum":["None","Shop","PrintInStore","PackagelessReturns","NextDayDropOff","AcceptDelivery","AcceptDropOff"],"type":"string"}}}}
```

## The LocationType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"LocationType":{"enum":["Store","Pudo","Locker"],"type":"string"}}}}
```

## The OpeningTimeResponseDto object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"OpeningTimeResponseDto":{"description":"Opening time response DTO implementation.","type":"object","properties":{"day":{"$ref":"#/components/schemas/DayOfWeek"},"opens":{"type":"string"},"closes":{"type":"string"},"storeAvailability":{"$ref":"#/components/schemas/StoreAvailability"}}},"DayOfWeek":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"StoreAvailability":{"enum":["Default","ClosedWholeDay","OpenedWholeDay"],"type":"string"}}}}
```

## The DayOfWeek object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"DayOfWeek":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}}}}
```

## The StoreAvailability object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"StoreAvailability":{"enum":["Default","ClosedWholeDay","OpenedWholeDay"],"type":"string"}}}}
```

## The Returns.Documentation.Domain.Models.BaseResponse object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Documentation.Domain.Models.BaseResponse":{"type":"object","properties":{"userMessage":{"type":"string"},"details":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Documentation.Domain.Models.DocumentDetails object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Documentation.Domain.Models.DocumentDetails":{"type":"object","properties":{"orderReference":{"type":"string"},"returnOrderNumber":{"type":"string"},"contentType":{"type":"string"},"documentStatus":{"$ref":"#/components/schemas/Returns.Documentation.Domain.Enums.ReturnDocumentStatus"},"label":{"type":"string"},"cultureLanguageIso":{"type":"string"},"documentId":{"format":"uuid","type":"string"},"documentType":{"$ref":"#/components/schemas/Returns.Documentation.Domain.Models.ReturnDocumentType"},"carrierInfoDetails":{"$ref":"#/components/schemas/Returns.Documentation.Domain.Models.CarrierInfoDetails"}},"additionalProperties":false},"Returns.Documentation.Domain.Enums.ReturnDocumentStatus":{"enum":["Processing","Ready","Failed"],"type":"string"},"Returns.Documentation.Domain.Models.ReturnDocumentType":{"enum":["ReturnLabel","LastMileLabel","PrePrintedLabel","RejectedReturnLabel"],"type":"string"},"Returns.Documentation.Domain.Models.CarrierInfoDetails":{"type":"object","properties":{"carrierId":{"type":"string"},"carrierName":{"type":"string"},"carrierReference":{"type":"string"},"carrierTrackingReference":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Documentation.Domain.Enums.ReturnDocumentStatus object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Documentation.Domain.Enums.ReturnDocumentStatus":{"enum":["Processing","Ready","Failed"],"type":"string"}}}}
```

## The Returns.Documentation.Domain.Models.CarrierInfoDetails object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Documentation.Domain.Models.CarrierInfoDetails":{"type":"object","properties":{"carrierId":{"type":"string"},"carrierName":{"type":"string"},"carrierReference":{"type":"string"},"carrierTrackingReference":{"type":"string"}},"additionalProperties":false}}}}
```

## The Returns.Documentation.Domain.Models.ReturnDocumentType object

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"components":{"schemas":{"Returns.Documentation.Domain.Models.ReturnDocumentType":{"enum":["ReturnLabel","LastMileLabel","PrePrintedLabel","RejectedReturnLabel"],"type":"string"}}}}
```


---

# 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/returns-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.