← All schemas

CoreApiSalesOrder

snowbee.coreapi.CoreApiPage_snowbee.coreapi.CoreApiSalesOrder

object · non-null

itemsarray of objectnon-nullrequired

Show item fields

Exactly one of these shapes is allowed.

deleted objectnon-null

typestringnon-nullrequired

Allowed values"deleted"

idstringnon-nullrequired

changed_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

deleted_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

entity objectnon-null

typestringnon-nullrequired

Allowed values"entity"

dataobjectnon-nullrequired

Show child fields

idstringnon-nullrequired

freightobjectnullableoptional

Show child fields

gross_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

net_amountstringnon-nullrequired

• Format: BigDecimal

Example"100.0"

vat_ratestringnullableoptional

• Format: BigDecimal

Example"100.0"

fulfillmentobjectnon-nullrequired

Show child fields

statusstringnon-nullrequired

Allowed values"PENDING""PARTIALLY_FULFILLED""FULFILLED""CANCELLED"

invoicingobjectnon-nullrequired

Show child fields

statusstringnon-nullrequired

Allowed values"NOT_INVOICED""PARTIALLY_INVOICED""INVOICED"

linesarray of objectnon-nullrequired

Show item fields

fulfillmentobjectnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

View schema definition

idstringnon-nullrequired

invoicingobjectnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

View schema definition

notestringnullableoptional

positionintegernon-nullrequired

• Format: int32

prepaymentanynullableoptional

Further nesting is omitted. See the schema for the full definition.

View schema definition

versionintegernon-nullrequired

• Format: int64

basic_net_unit_sales_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

campaign_code_at_salestringnullableoptional

campaign_idstringnullableoptional

campaign_name_at_salestringnullableoptional

campaign_net_unit_sales_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

company_idstringnon-nullrequired

confirmed_delivery_datestringnullableoptional

• Format: date

Example"2026-01-14"

created_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

estimated_delivery_datestringnullableoptional

• Format: date

Example"2026-01-14"

gift_card_idstringnullableoptional

gross_line_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

line_discount_percentagestringnon-nullrequired

• Format: BigDecimal

Example"100.0"

line_statusstringnon-nullrequired

line_typestringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

Allowed values"PRODUCT""RESOURCE""GIFT_CARD""SERVICE_ORDER"

View schema definition

modified_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

net_line_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

net_unit_consignment_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

net_unit_order_discount_amountstringnon-nullrequired

• Format: BigDecimal

Example"100.0"

net_unit_sales_pricestringnullableoptional

• Format: BigDecimal

Example"100.0"

order_quantitystringnon-nullrequired

• Format: BigDecimal

Example"100.0"

price_source_typestringnullableoptional

requested_delivery_datestringnullableoptional

• Format: date

Example"2026-01-14"

resource_idstringnullableoptional

returned_sales_order_line_idstringnullableoptional

sales_processstringnon-nullrequired

Further nesting is omitted. See the schema for the full definition.

Allowed values"NORMAL""RETURN""CLAIM"

View schema definition

service_order_idstringnullableoptional

sku_idstringnullableoptional

supply_sourcestringnullableoptional

unit_coststringnullableoptional

Stored unit cost in the owning company's currency

• Format: BigDecimal

Example"100.0"

vat_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

vat_ratestringnon-nullrequired

• Format: BigDecimal

Example"100.0"

warehouse_idstringnon-nullrequired

referencestringnullableoptional

statusstringnon-nullrequired

versionintegernon-nullrequired

• Format: int64

campaign_idstringnullableoptional

click_and_collect_cart_idstringnullableoptional

company_idstringnon-nullrequired

created_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

currency_iso_codestringnon-nullrequired

customer_idstringnon-nullrequired

customer_typestringnon-nullrequired

Allowed values"B2B""B2C""COMPANY""RETAIL_STORE""ECOM_STORE"

delivery_addressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired

emailstringnullableoptional

namestringnon-nullrequired

phonestringnullableoptional

streetstringnon-nullrequired

country_iso_codestringnon-nullrequired

post_codestringnon-nullrequired

discount_couponsarray of objectnon-nullrequired

Show item fields

amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

idstringnon-nullrequired

titlestringnullableoptional

can_be_applied_to_service_ordersbooleannon-nullrequired

discount_coupon_typestringnullableoptional

excluded_main_product_group_numbersarray of stringnon-nullrequired

Show item fields

Further nesting is omitted. See the schema for the full definition.

external_referencestringnon-nullrequired

included_main_product_group_numbersarray of stringnon-nullrequired

Show item fields

Further nesting is omitted. See the schema for the full definition.

loyalty_program_idstringnon-nullrequired

document_statusstringnon-nullrequired

ecom_store_idstringnullableoptional

exchange_ratestringnon-nullrequired

• Format: BigDecimal

Example"100.0"

external_order_idstringnullableoptional

external_order_numberstringnullableoptional

fixed_invoice_due_datestringnullableoptional

• Format: date

Example"2026-01-14"

internal_notestringnullableoptional

invoice_addressobjectnon-nullrequired

Show child fields

citystringnon-nullrequired

namestringnon-nullrequired

streetstringnon-nullrequired

country_iso_codestringnon-nullrequired

post_codestringnon-nullrequired

invoice_email_addressstringnullableoptional

is_retail_orderbooleannon-nullrequired

liable_to_vatbooleannon-nullrequired

modified_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

note_to_customerstringnullableoptional

order_datestringnon-nullrequired

• Format: date

Example"2026-01-14"

order_discount_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

order_discount_percentagestringnullableoptional

• Format: BigDecimal

Example"100.0"

organisational_unit_idstringnon-nullrequired

organisational_unit_typestringnon-nullrequired

Allowed values"DEPARTMENT""RETAIL_STORE""ECOM_STORE"

sales_order_numberstringnon-nullrequired

sales_order_type_idstringnon-nullrequired

sold_atstringnullableoptional

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

sold_by_idstringnon-nullrequired

terms_of_delivery_for_tenant_idstringnullableoptional

terms_of_payment_idstringnon-nullrequired

total_gross_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

total_net_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

total_vat_amountstringnullableoptional

• Format: BigDecimal

Example"100.0"

warehouse_idstringnon-nullrequired

changed_atstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

View schema definition

next_cursorstringnullablerequired

sync_throughstringnon-nullrequired

• Format: ISO 8681 timestamp

Example"2025-10-28T12:37:42Z"

{
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiSalesOrder"
      },
      "title": "List<CoreApiItem<CoreApiSalesOrder>>"
    },
    "next_cursor": {
      "type": [
        "null",
        "string"
      ],
      "title": "String"
    },
    "sync_through": {
      "type": "string",
      "format": "ISO 8681 timestamp",
      "example": "2025-10-28T12:37:42Z",
      "title": "ISO8681"
    }
  },
  "required": [
    "items",
    "next_cursor",
    "sync_through"
  ],
  "title": "CoreApiPage<CoreApiSalesOrder>"
}