PurchaseOrderRequest

Creates a purchase order together with its line items and its vendor and buyer contact records.

  • buyerContact
    Type: object
    required

    The buying contact at your organization. At least one of email or phone is required.

    • email
      Type: string Format: emailnullable
    • externalId
      Type: string nullable
    • name
      Type: string nullable
    • phone
      Type: string nullable

      E.164 format, including the country code.

    • phoneExtension
      Type: string nullable

      Digits only.

  • lineItems
    Type: array object[] · PurchaseOrderLineItemRequest[]
    required

    The ordered lines. May be empty.

    One ordered line on a purchase order.

    • lineNumber
      Type: string
      required

      Your line identifier. Unique within the purchase order.

    • currency
      Type: string
      min length:  
      3
      max length:  
      3

      ISO 4217 currency code. Defaults to USD when omitted.

    • customData
      Type: object nullable

      Arbitrary JSON key-value data you want carried on the line.

    • description
      Type: string
      max length:  
      1000      nullable
    • expectedArrivalDate
      Type: string nullable

      Day this line is expected to arrive. A calendar day (2026-09-02) or a full timestamp is accepted; only the UTC calendar day is stored. Send null to clear it.

    • openQuantity
      Type: integer nullable

      Integer numbers.

    • orderedQuantity
      Type: integer nullable

      Integer numbers.

    • sku
      Type: string nullable
    • status
      Type: string · PurchaseOrderStatusenum

      Lifecycle state of a purchase order or one of its line items.

      values
      • OPEN
      • CLOSED
      • CANCELED
    • unitOfMeasure
      Type: string nullable
    • unitPrice
      Type: string nullable

      Non-negative decimal string with up to 8 integer and 2 fractional digits.

  • purchaseOrder
    Type: object
    required
    • purchaseOrderDate
      Type: string
      required

      Day the purchase order was issued. A calendar day (2026-08-18) or a full timestamp is accepted; only the UTC calendar day is stored.

    • purchaseOrderNumber
      Type: string
      required

      Your purchase order number. Unique within your system.

    • status
      Type: string · PurchaseOrderStatusenum
      required

      Lifecycle state of a purchase order or one of its line items.

      values
      • OPEN
      • CLOSED
      • CANCELED
    • customData
      Type: object nullable
    • internalPurchaseOrderNumber
      Type: string nullable
  • vendor
    Type: object
    required

    The vendor shipping the purchase order. Matched on vendorCode within your system: an existing vendor is reused rather than duplicated.

    • name
      Type: string
      required
    • vendorCode
      Type: string
      required

      Your vendor identifier. Unique within your system.

  • vendorContact
    Type: object nullable

    A contact at the vendor. At least one of email or phone is required when supplied.

    • email
      Type: string Format: emailnullable
    • name
      Type: string nullable
    • phone
      Type: string nullable

      E.164 format, including the country code.