Skip to main content

ServiceSalesOrder

idstring<uuid>required

Sales order id.

Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
orderNumberstringnullablerequired

Order number.

Example: SO-000001
statusstringnullablerequired

Lifecycle status.

Possible values: [DRAFT, AWAITING_PAYMENT, CONFIRMED, PARTIALLY_INVOICED, INVOICED, PARTIALLY_SHIPPED, SHIPPED, DELIVERED, CANCELLED, RETURNED, null]

paymentStatusstringnullablerequired

How much of the order has been paid.

Possible values: [PENDING, PARTIAL, PAID, OVERDUE, REFUNDED, DRAFT, PENDING_APPROVAL, APPROVED, PROCESSED, CANCELLED, REVERSED, null]

customerIdstring<uuid>nullablerequired

The customer the order is for.

Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
orderDatestring<date-time>nullablerequired

Order date.

Example: 2026-01-15T09:30:00.000Z
promisedDatestring<date-time>nullablerequired

Date the order is promised for.

Example: 2026-01-15T09:30:00.000Z
shippedDatestring<date-time>nullablerequired

When the order shipped.

Example: 2026-01-15T09:30:00.000Z
deliveredDatestring<date-time>nullablerequired

When the order was delivered.

Example: 2026-01-15T09:30:00.000Z
currencystringnullablerequired

ISO 4217 currency code of every amount on the order.

Example: USD
exchangeRatenumbernullablerequired

Rate from the document currency to the workspace currency.

Example: 1
subtotalnumbernullablerequired

Sum of the line values before discount and tax.

Example: 25
discountAmountnumbernullablerequired

Total discount.

Example: 0
taxAmountnumbernullablerequired

Total tax.

Example: 2.5
shippingAmountnumbernullablerequired

Shipping charge.

Example: 0
totalAmountnumbernullablerequired

Grand total in the document currency.

Example: 27.5
paymentTermsstringnullablerequired

Payment terms code.

Example: NET_30
customerPoNumberstringnullablerequired

The buyer's purchase order number.

Example: PO-12345
referencestringnullablerequired

Your own reference for the order.

Example: INT-0001
trackingNumberstringnullablerequired

Carrier tracking number.

Example: TRACK-000000
items object[]required

Order lines.

  • Array [
    • productIdstring<uuid>nullablerequired

    Product id.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    variantIdstring<uuid>nullablerequired

    Variant id.

    Example: 9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d
    skustringnullablerequired

    Stock keeping unit.

    Example: SKU-1001
    namestringnullablerequired

    Line name.

    Example: Sample Widget
    quantitynumbernullablerequired

    Quantity.

    Example: 2
    uomIdstring<uuid>nullablerequired

    The unit the quantity is in.

    Example: 5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b
    unitPricenumbernullablerequired

    Unit price in the document currency.

    Example: 12.5
    discountPercentnumbernullablerequired

    Line discount percent.

    Example: 0
    discountAmountnumbernullablerequired

    Line discount amount in the document currency.

    Example: 0
    taxRatenumbernullablerequired

    Tax rate percent.

    Example: 10
    taxAmountnumbernullablerequired

    Tax on the line in the document currency.

    Example: 2.5
    totalAmountnumbernullablerequired

    Line total in the document currency.

    Example: 27.5
    shippedQuantitynumbernullablerequired

    Quantity shipped so far.

    Example: 0
    invoicedQuantitynumbernullablerequired

    Quantity invoiced so far.

    Example: 0
    canceledQuantitynumbernullablerequired

    Quantity cancelled.

    Example: 0
  • ]
    • updatedAtstring<date-time>nullablerequired

    When the order last changed. Use the newest value as the next updatedAfter.

    Example: 2026-01-15T09:30:00.000Z
    ServiceSalesOrder
    {
      "id": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
      "orderNumber": "SO-000001",
      "status": "DRAFT",
      "paymentStatus": "PENDING",
      "customerId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
      "orderDate": "2026-01-15T09:30:00.000Z",
      "promisedDate": "2026-01-15T09:30:00.000Z",
      "shippedDate": "2026-01-15T09:30:00.000Z",
      "deliveredDate": "2026-01-15T09:30:00.000Z",
      "currency": "USD",
      "exchangeRate": 1,
      "subtotal": 25,
      "discountAmount": 0,
      "taxAmount": 2.5,
      "shippingAmount": 0,
      "totalAmount": 27.5,
      "paymentTerms": "NET_30",
      "customerPoNumber": "PO-12345",
      "reference": "INT-0001",
      "trackingNumber": "TRACK-000000",
      "items": [
        {
          "productId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "variantId": "9d2f6b1c-8e47-4a30-b5c2-0e1f3a4b5c6d",
          "sku": "SKU-1001",
          "name": "Sample Widget",
          "quantity": 2,
          "uomId": "5b0c8a6e-2f4d-4d6e-9a53-7c1d2e3f4a5b",
          "unitPrice": 12.5,
          "discountPercent": 0,
          "discountAmount": 0,
          "taxRate": 10,
          "taxAmount": 2.5,
          "totalAmount": 27.5,
          "shippedQuantity": 0,
          "invoicedQuantity": 0,
          "canceledQuantity": 0
        }
      ],
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }