ReturnOrder

Field	Type	Description
`orderNumber`	`string`
`externalCode`	ExternalCode	external order id min length 1
`salesOrderNumber`	`string`
`type`	ReturnOrderType	one of: `return`
`customerId`	`string`	Customer identifier
`externalCustomerNumber`	ExternalCustomerNumber	A customer number / reference to an external system.
`status`	ReturnOrderStatus	one of: `draft`, `new`, `inTransit`, `arrived`, `inReview`, `accepted`, `rejected`, `canceled`, `completed` · default: `"new"`
`expedited`	`boolean`
`localeCode`	LocaleCode	max length 5 · min length 2
`currencyCode`	CurrencyCode	max length 3 · min length 3
`notes`	Notes	Customer notes where the shopper can provide special instructions. The notes are shown in the In-Store App & Admin. max length 1000
`specialInstructions`	SpecialInstructions	Special instructions of the order. It can contain special shipping or fulfillment instructions
`data`	`object`
`primaryBillToAddressSequenceIndex`	`number`
`primaryShipToAddressSequenceIndex`	`number`
`addressSequences`	array[ROAddressSequence]
`subTotal`	`number`	The subtotal of the order (Formula: Sum of all lineItem.extendedPrice) format: `float`
`discountAmount`	OrderDiscountAmount	Total amount of all applied promotions with coupons on order level. Without line item level promotions, since these are already included in the order subtotal. format: `float` · default: `0`
`promoAmount`	OrderPromoAmount	Total amount of all applied promotions on order level. Without line item level promotions, since these are already included in the order subtotal. format: `float` · default: `0`
`taxAmount`	TaxAmount	Tax amount of the first tax group (e.g. for german taxes this is an absolut number based on either 7% or 19% of the order total; the order total is 10.00 EUR so the taxAmount is 10.00 EUR * 0.19 = 1.9 EUR) format: `float` · default: `0`
`tax2Amount`	Tax2Amount	Tax amount of the second tax group (can be used for additional taxes like for example US state taxes) format: `float` · default: `0`
`shippingSubTotal`	`number`	format: `float`
`shippingDiscountAmount`	`number`	format: `float`
`shippingPromoAmount`	`number`	format: `float`
`shippingTotal`	`number`	format: `float`
`taxExempt`	`boolean`
`taxSummary`	TaxSummary
`total`	`number`	The final price of the return order, including all promotions, discounts, shipping costs etc. format: `float`
`date`	CreateDate	Date of the order when it was created in the Shopgate system format: `date-time`
`submitDate`	SubmitDate	Date when the order was submitted by the customer format: `date-time`
`completeDate`	CompleteDate	Date when the order status was changed to completed format: `date-time`
`dropOffType`	DropOffType	one of: `inPerson`, `shipped`
`dropOffLocationCode`	`string`	Location where the order is returned
`os`	OS	Operation system of the source device one of: `ios`, `android`, `other`
`imported`	Imported	Indicates if the order has been imported from an external system. Enabling this flag means that there will be no further processes triggered by this order like emitting events, calculating properties like prices, or starting payment transactions.
`paymentTransactions`	array[PaymentTransaction]
`lineItems`	array[ROLineItem]

Example

{
  "orderNumber": "R1293747",
  "externalCode": "000000274",
  "salesOrderNumber": "1293747",
  "type": "return",
  "customerId": "55c98b8e-1100-497c-8df6-4b4f0353ab2a",
  "externalCustomerNumber": "C1756793",
  "status": "draft",
  "expedited": true,
  "localeCode": "string",
  "currencyCode": "EUR",
  "notes": "Please wrap each item individually.",
  "specialInstructions": "House behind the dumpster"
}