> 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/ingestion.md).

# Ingestion

## POST /returns/v1/{identifier}/outbound-orders

> Creates an Outbound Order

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"servers":[{"url":"https://api.esw.com"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header","description":"Please insert JWT with Bearer into field"}},"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},"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":{}},"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":{}},"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}}},"paths":{"/returns/v1/{identifier}/outbound-orders":{"post":{"tags":["Ingestion"],"summary":"Creates an Outbound Order","parameters":[{"schema":{"type":"string"},"in":"path","name":"identifier","required":true}],"responses":{"201":{"description":"The Outbound Order has been successfully created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebResponse"}}}},"400":{"description":"Validation has failed for Outbound Order creation request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"}}}},"401":{"description":"User is not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"403":{"description":"User does not have permissions to hit the endpoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"409":{"description":"The Outbound Order already exists. (If replaceOrderPermitted is false)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"500":{"description":"A unexpected error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}}},"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.CreateOutboundOrder.CreateOutboundOrderWebRequest"}}},"description":"The request body"}}}}}
```

## PUT /returns/v1/{identifier}/outbound-orders/{orderReference}

> Updates an Outbound Order

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"servers":[{"url":"https://api.esw.com"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header","description":"Please insert JWT with Bearer into field"}},"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"},"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":{}},"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":{}},"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.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}}},"paths":{"/returns/v1/{identifier}/outbound-orders/{orderReference}":{"put":{"tags":["Ingestion"],"summary":"Updates an Outbound Order","parameters":[{"schema":{"type":"string"},"in":"path","name":"identifier","required":true},{"schema":{"type":"string"},"in":"path","name":"orderReference","required":true}],"responses":{"200":{"description":"The Outbound Order has been successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebResponse"}}}},"400":{"description":"Validation has failed for Outbound Order update request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"}}}},"401":{"description":"User is not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"403":{"description":"User does not have permissions to hit the endpoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"404":{"description":"Outbound Order does not exist","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"500":{"description":"An unexpected error occurred","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}}},"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.UpdateOutboundOrder.UpdateOutboundOrderWebRequest"}}},"description":"The request body"}}}}}
```

## POST /returns/v1/{identifier}/outbound-shipments

> Submits an Outbound Shipment

```json
{"openapi":"3.1.1","info":{"title":"GRP Returns API","version":"1"},"servers":[{"url":"https://api.esw.com"}],"security":[{"Bearer":[]}],"components":{"securitySchemes":{"Bearer":{"type":"apiKey","name":"Authorization","in":"header","description":"Please insert JWT with Bearer into field"}},"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},"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":{}},"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":{}},"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"}}},"paths":{"/returns/v1/{identifier}/outbound-shipments":{"post":{"tags":["Ingestion"],"summary":"Submits an Outbound Shipment","parameters":[{"schema":{"type":"string"},"in":"path","name":"identifier","required":true}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ValidationProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"}}}}},"requestBody":{"content":{"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebRequest"}},"application/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebRequest"}},"text/json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebRequest"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/Returns.Ingestion.Api.UseCases.SubmitOutboundShipment.SubmitOutboundShipmentWebRequest"}}},"description":"The request body"}}}}}
```


---

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