Developer docs

← All endpoints

GET/v1/tenants/{tenantId}/core/transactions/sales_orders

Synchronize sales_orders Experimental

Live entity representations and retained deletions, ordered by modification/deletion timestamp and ID. Use an overlap window when polling from a completed sync_through checkpoint. Requires transactions:read or core:read. Save sync_through after the final page succeeds, then subtract a configurable overlap window for the next poll.

Parameters

tenantIdpathstringnon-nullrequired
sincequerystringnon-nulloptional

Inclusive ISO 8601 timestamp with offset. Omit to synchronize everything. Cannot be combined with cursor.

cursorquerystringnon-nulloptional

Opaque next_cursor from the previous page. Pass it back unchanged to continue the same collection.

limitqueryintegernon-nulloptional

Combined entities and deletions per page: default 100, maximum 500. May change between pages.

  • Format: int32

Responses

200Response
application/jsonobjectnon-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

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

  • Format: BigDecimal
Example"100.0"
net_amountstringnon-nullrequired

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

  • Format: BigDecimal
Example"100.0"
vat_ratestringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
fulfillmentobjectnon-nullrequired
Show child fields
statusstringnon-nullrequired

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

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

View schema definition

invoicingobjectnon-nullrequired
Show child fields
statusstringnon-nullrequired

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

Allowed values"NOT_INVOICED""PARTIALLY_INVOICED""INVOICED"

View schema definition

linesarray of objectnon-nullrequired
Show item fields
fulfillmentanynon-nullrequired

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

View schema definition

idstringnon-nullrequired

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

invoicinganynon-nullrequired

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

View schema definition

notestringnullableoptional

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

positionintegernon-nullrequired

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

  • Format: int32
prepaymentanynon-nulloptional

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

versionintegernon-nullrequired

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

  • Format: int64
basic_net_unit_sales_pricestringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
campaign_code_at_salestringnullableoptional

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

campaign_idstringnullableoptional

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

campaign_name_at_salestringnullableoptional

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

campaign_net_unit_sales_pricestringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
company_idstringnon-nullrequired

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

confirmed_delivery_datestringnullableoptional

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

  • Format: date
Example"2026-01-14"
created_atstringnon-nullrequired

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

  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
estimated_delivery_datestringnullableoptional

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

  • Format: date
Example"2026-01-14"
gift_card_idstringnullableoptional

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

gross_line_amountstringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
line_discount_percentagestringnon-nullrequired

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

  • Format: BigDecimal
Example"100.0"
line_statusstringnon-nullrequired

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

line_typeanynon-nullrequired

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

View schema definition

modified_atstringnon-nullrequired

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

  • Format: ISO 8681 timestamp
Example"2025-10-28T12:37:42Z"
net_line_amountstringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
net_unit_consignment_pricestringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
net_unit_order_discount_amountstringnon-nullrequired

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

  • Format: BigDecimal
Example"100.0"
net_unit_sales_pricestringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
order_quantitystringnon-nullrequired

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

  • Format: BigDecimal
Example"100.0"
price_source_typestringnullableoptional

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

requested_delivery_datestringnullableoptional

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

  • Format: date
Example"2026-01-14"
resource_idstringnullableoptional

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

returned_sales_order_line_idstringnullableoptional

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

sales_processanynon-nullrequired

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

View schema definition

service_order_idstringnullableoptional

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

sku_idstringnullableoptional

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

supply_sourcestringnullableoptional

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

unit_coststringnullableoptional

Stored unit cost in the owning company's currency

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

  • Format: BigDecimal
Example"100.0"
vat_amountstringnullableoptional

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

  • Format: BigDecimal
Example"100.0"
vat_ratestringnon-nullrequired

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

  • Format: BigDecimal
Example"100.0"
warehouse_idstringnon-nullrequired

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

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

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

  • Format: BigDecimal
Example"100.0"
idstringnon-nullrequired

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

titlestringnullableoptional

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

can_be_applied_to_service_ordersbooleannon-nullrequired

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

discount_coupon_typestringnullableoptional

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

excluded_main_product_group_numbersarraynon-nullrequired

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

external_referencestringnon-nullrequired

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

included_main_product_group_numbersarraynon-nullrequired

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

loyalty_program_idstringnon-nullrequired

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

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"

View schema definition

400Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

401Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition

403Response
application/jsonobjectnon-null
errorstringnon-nullrequired

Stable error code

Example"INVALID_REQUEST"
messagestringnon-nullrequired

Human-readable error message

Example"Invalid customer ID format"
resolutionstringnon-nullrequired

Suggested next action

Example"Correct the customer ID and retry the request"

View schema definition