SalesOrder

Field	Type	Required	Description
orderNumber	string		Number of the Order. Its need to be unique in the system
shopCode	ShopCode		Code of the source shop.
externalCode	ExternalCode		external order id min length 1
type	SalesOrderType		one of: standard · default: "standard"
customerId	string		Customer identifier
externalCustomerNumber	ExternalCustomerNumber		A customer number / reference to an external system.
status	SOStatus		one of: new, open, rejected, canceled, ready, fulfilled, completed, inProgress
expedited	boolean		Indicates if the order needs to be threated expediently
localeCode	LocaleCode		max length 5 · min length 2
currencyCode	CurrencyCode		max length 3 · min length 3
taxExempt	boolean
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
fulfillmentStatus	string		one of: open, inProgress, completed, actionRequired
primaryBillToAddressSequenceIndex	number		Position in the AddressSequences-Array, mandatory for all fulfillment methods that include billing like directShip and BOPIS
primaryShipToAddressSequenceIndex	number		Position in the AddressSequences-Array, mandatory for all fulfillment methods that include shipping like directShip
addressSequences	array[AddressSequence]
subTotal	number		Subtotal of the order 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	number		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		Shipping total without any discounts. Its based on the line items in the order format: float
shippingDiscountAmount	number		Sum of discounts applied to the shipping total format: float
shippingPromoAmount	number		format: float
shippingTotal	number		Shipping total including all discounts format: float
taxSummary	TaxSummary
total	number		Total sum of the order including tax, shipping and discounts 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
fulfillDate	FulfillDate		Date when the order status was changed to fulfilled format: date-time
completeDate	CompleteDate		Date when the order status was changed to completed format: date-time
sourceIp	SourceIP		IP address from the client where the order was placed. It can be a IPv4 or IPv6 address
userAgent	UserAgent		The UserAgent string from headers of the incoming request.
domain	Domain		The domain from which order came. pattern: ^(((?!-))(xn--|_{1,1})?[a-z0-9-]{0,61}[a-z0-9]{1,1}\.)*(xn--)?([a-z0-9][a-z0-9\-]{0,60}|[a-z0-9-]{1,30}\.[a-z]{2,})$
platform	Platform		The platform from which the order came. one of: engage, desktop, mobile, checkoutPage, inStoreApp, other
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.
campaignAttribution	CampaignAttribution		Campaign the order should be attributed to
lineItemCount	number
lineItems	array[object]

Example

{
  "orderNumber": 1293747,
  "shopCode": "shop_12345",
  "externalCode": "000000274",
  "type": "standard",
  "customerId": "55c98b8e-1100-497c-8df6-4b4f0353ab2a",
  "externalCustomerNumber": "C1756793",
  "status": "new",
  "expedited": false,
  "localeCode": "string",
  "currencyCode": "EUR",
  "taxExempt": true,
  "notes": "Please wrap each item individually.",
  "lineItems": [
    {
      "id": 10,
      "quantity": 5,
      "returnQuantity": 1,
      "product": {}
    }
  ]
}