Developer docs

← All schemas

CoreApiSalesOrder

snowbee.coreapi.CoreApiItem_snowbee.coreapi.CoreApiSalesOrder

object · non-null

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
Show child fields
statusstringnon-nullrequired
Allowed values"PENDING""PARTIALLY_FULFILLED""FULFILLED""CANCELLED"
cancelled_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
fulfilled_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
pending_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
picked_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
picking_in_progress_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
picking_list_idsarray of stringnon-nullrequired
shipment_idsarray of stringnon-nullrequired
shipped_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
idstringnon-nullrequired
invoicingobjectnon-nullrequired
Show child fields
statusstringnon-nullrequired
Allowed values"NOT_INVOICED""PARTIALLY_INVOICED""INVOICED"
invoice_idsarray of stringnon-nullrequired
invoice_line_idsarray of stringnon-nullrequired
invoiced_quantitystringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
notestringnullableoptional
positionintegernon-nullrequired
  • Format: int32
prepaymentobjectnullableoptional
Show child fields
statusstringnon-nullrequired

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

Allowed values"PENDING""DELIVERED""CANCELLED"

View schema definition

applied_gross_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
collected_gross_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
configured_gross_amountstringnullableoptional
  • Format: BigDecimal
Example"100.0"
refunded_gross_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
unapplied_gross_amountstringnon-nullrequired
  • Format: BigDecimal
Example"100.0"
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
Allowed values"PRODUCT""RESOURCE""GIFT_CARD""SERVICE_ORDER"
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
Allowed values"NORMAL""RETURN""CLAIM"
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
external_referencestringnon-nullrequired
included_main_product_group_numbersarray of stringnon-nullrequired
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 raw schema
{
  "discriminator": {
    "propertyName": "type",
    "mapping": {
      "deleted": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiSalesOrder",
      "entity": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiSalesOrder"
    }
  },
  "oneOf": [
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Deleted_snowbee.coreapi.CoreApiSalesOrder"
    },
    {
      "$ref": "#/components/schemas/snowbee.coreapi.CoreApiItem.Entity_snowbee.coreapi.CoreApiSalesOrder"
    }
  ],
  "title": "CoreApiItem<CoreApiSalesOrder>"
}