--- title: "View sales order" method: GET path: "/api/v1/salesOrders/{id}" tags: ["Sales Order"] --- # View sales order `GET /api/v1/salesOrders/{id}` Returns details of a sales order ## Path parameters - `id` string, required — Resource identifier. ## Response `200` Operation completed successfully. - object - `data` object — Representation of a Sales Order - `id` string — Resource identifier. - `documentNumber` string — Internal identification associated with a Sales Order - `externalOrderNumber` string — External identification associated with a Sales Order - `transactionNumber` string — Transaction number associated with a Sales Order - `customerOrderNumber` string — Customer order associated with a Sales Order - `externalOrderId` string — External ID associated with a Sales Order - `salesChannel` object, nullable — Represents a sales channel as a reference to another resource. This object can be null and contains an identifier and an optional name. - `id` string, required — Resource identifier. - `name` string, nullable - `bodyIntroduction` string — Initial description message for Sales Order - `bodyOutroduction` string — Ending description message for Sales Order - `internalDesignation` string — Internal designation for Sales Order - `date` string, date — a yyyy-mm-dd formatted date - `earliestFulfillmentDate` string, date, nullable — Earliest Fulfillment Date - `desiredDeliveryDate` string, date, nullable — Desired Delivery Date for the Sales Order - `desiredDeliveryDateCw` boolean — Flag indicating whether a calendar week should be printed on documents - `reservationDate` string, date, nullable — Reservation Date for the Sales Order - `editor` string — Creator of the Sales Order - `sales` object — Represents a sales representative with associated attributes. - `id` number, nullable - `name` string, nullable - `status` 'completed' | 'created' | 'released' | 'canceled' | 'unknown' — Status of the Sales Order - `customer` object — Customer linked to a Sales Order - `id` string — Resource identifier. - `number` string, nullable - `comment` string — Comment included in the Sales Order - `project` object — Reference to another resource - `id` string, required — Resource identifier. - `language` object — Language information for a Sales Order - `iso2` string, nullable, required — ISO 639-1 Code - `autoCreateDocuments` 'deliveryNote+invoice' | 'deliveryNote' | 'invoice' — Sets documents created by autoshippment. - `log` object — Logging information for the Sales Order - `createdAt` string, date-time — a atom formatted date time - `createdBy` object - `id` string — Resource identifier. - `name` string - `email` string, email - `financials` object — Financial information for a Sales Order - `paymentMethod` object, required — Reference to another resource - `id` string, required — Resource identifier. - `currency` string, required - `costCenter` object, nullable - `id` string, required — Resource identifier. - `number` string, nullable, required - `billingAddress` object - `type` 'mr' | 'mrs' | 'company' | 'other' - `name` string, required - `title` string - `contactPerson` string - `department` string - `subDepartment` string - `street` string - `zipCode` string - `city` string - `fax` string - `state` string - `country` string, required - `addressSupplement` string - `gln` string - `phoneNumber` string - `mobile` string - `salutation` string - `email` string, email - `tax` object - `taxation` 'domestic' | 'eu' | 'export' | 'taxfreedomestic' - `vatId` string - `taxDisplay` 'gross' | 'net' | 'auto' - `noTaxInfoText` boolean - `normalTaxRate` number, float - `reducedTaxRate` number, float - `paymentTerms` object - `paymentTargetDiscount` number, float - `paymentTargetDays` integer - `paymentTargetDiscountDays` integer - `directDebitDate` string, date, nullable — Earliest date for direct debit - `delivery` object — Delivery information for the Sales Order - `autoShipping` boolean - `fastLane` boolean - `shippingCosts` object[] - `id` string — Resource identifier. - `quantity` number, double, required - `comment` string - `shippingCostProduct` object, required - `id` string, required — Resource identifier. - `name` string - `description` string - `freeFields` object[], nullable - `id` string, required — Resource identifier. - `value` string, required - `number` string, nullable - `tax` object - `vatCategory` 'reduced' | 'normal' | 'exempt', nullable — VAT category. When importing a position only one of `rate` or `vatCategory` must be used. - `rate` number, float, nullable — VAT rate. When importing a position only one of `rate` or `vatCategory` must be used. - `taxText` string, nullable, required — Tax Text - `price` object — Money object with amount and currency - `amount` string, float — A string representing the amount - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217. - `discount` number, float — percentage discount to be applied to the position, expressed as a decimal value (0.15 = 15% discount) - `webId` string — technical position ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync info back to the originating shop / platform - `storageCountry` string, nullable — storageCountry - `preferredWarehouse` object, nullable — Use preferredWarehouse for fulfillment with delivery notes to define which warehouse should be used. - `id` string, nullable - `shippingAddress` object - `type` 'mr' | 'mrs' | 'company' | 'other' - `name` string, required - `department` string - `contactPerson` string - `subDepartment` string - `street` string - `zipCode` string - `city` string - `state` string - `country` string, required - `addressSupplement` string - `gln` string - `title` string - `email` string, email - `shippingMethod` object, required — Reference to another resource - `id` string, required — Resource identifier. - `deliveryTerms` object, nullable — Nullable reference to another resource - `id` string, required — Resource identifier. - `email` string, email - `conditions` string - `tags` object[] — Tags associated with the Sales Order - `id` string, required — Resource identifier. - `type` string, nullable - `title` string, nullable - `netSales` object — This contains amount with currency. - `amount` string, float, required — The total net sales amount. - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR', required — Currency matches one of currency values as specified in ISO-4217. - `total` object — This contains total with currency - `amount` string, float, required — The total amount including taxes and fees. - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR', required — Currency matches one of currency values as specified in ISO-4217. - `positions` object[] — Items included within the Sales Order - `id` string, required — Resource identifier. - `quantity` number, double, required - `sort` integer, required - `hasChildren` boolean, required — Whether a position has children - `parent` string, nullable, required — An id reference to the parent of the current position, null when position is not a child - `comment` string - `product` object, required - `id` string, required — Resource identifier. - `name` string - `description` string - `freeFields` object[], nullable - `id` string, required — Resource identifier. - `value` string, required - `number` string, nullable - `tax` object - `effectiveVatRate` number, float — The final VAT on a position. Calculated based on other fields. Only supported on the view endpoint and is always returned - `vatCategory` 'reduced' | 'normal' | 'exempt', nullable — VAT category. When importing a position only one of `rate` or `vatCategory` must be used. - `rate` number, float, nullable — VAT rate. When importing a position only one of `rate` or `vatCategory` must be used. - `taxText` string, nullable, required — Tax Text - `price` object — Money object with amount and currency - `amount` string, float — A string representing the amount - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217. - `netRevenueSingle` object - `amount` string, float, nullable - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217. - `netRevenueTotal` object - `amount` string, float, nullable - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217. - `grossRevenueSingle` object - `amount` string, float, nullable - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217. - `grossRevenueTotal` object - `amount` string, float, nullable - `currency` 'EUR' | 'USD' | 'JPY' | 'BGN' | 'CZK' | 'DKK' | 'GBP' | 'HUF' | 'PLN' | 'RON' | 'SEK' | 'CHF' | 'ISK' | 'NOK' | 'HRK' | 'RUB' | 'TRY' | 'AUD' | 'BRL' | 'CAD' | 'CNY' | 'HKD' | 'IDR' | 'ILS' | 'INR' | 'KRW' | 'MXN' | 'MYR' | 'NZD' | 'PHP' | 'SGD' | 'THB' | 'ZAR' | 'ARS' | 'CLP' | 'SAR' | 'AED' | 'QAR' — Currency matches one of currency values as specified in ISO-4217. - `discount` number, float - `webId` string — technical position ID in the originating shop system / platform (e.g. Shopify, Amazon, etc). This ID is used to sync info back to the originating shop / platform - `desiredQualityControlAttributes` object, nullable - `batch` string, nullable - `bestBeforeDate` string, date, nullable - `createdAt` string, date-time — a atom formatted date time - `updatedAt` string, date-time — a atom formatted date time ## Other responses - `401` — Unable to authenticate the client - `403` — Unable to authorize the client - `404` — Resource was not found or not enough access privileges - `406` — Requested resource representation does not exist. - `429` — Too many API calls made. --- [API](https://skmtc.net/xentral/apis/xentral-api.md) · [All operations](https://skmtc.net/xentral/apis/xentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xentral/xentral-api/revisions/8a27ba392442/schema)