PurchaseOrderUpdate

New expected dates for a purchase order and its lines, as stated by the supplier. Scoped to the purchase order, with the affected lines nested. Apply the dates as updated promise dates on the purchase order.

The whole request body, sent without the shared event envelope.

Every event carries at least one new date — on the purchase order, on a line, or both. Each date field is individually optional because dates appear only at the level the supplier stated them, so no single field is the one that is always set. That is a guarantee about what Augment sends, not a shape you have to validate.

  • collectedAt
    required
    • Type: string · InputDateTimeUtcFormat: date-time

      When Augment collected the update from the supplier, as a UTC ISO 8601 timestamp ending in Z. Use it to order updates for the same purchase order — a later collectedAt reflects the more recent thing the supplier said.

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

    The lines that have a new date. Lines the supplier said nothing new about are omitted, so this array is empty when the supplier stated dates only at purchase order level.

    One purchase order line that has a new expected date.

    • identifier
      Type: string
      required

      How the supplier referred to the line. Matches the lineNumber you sent on the purchase order when Augment can resolve it; otherwise it is the identifier the supplier used, which is often a SKU and sometimes prose such as Line 2. Resolve it against your own lines before applying the dates, and route what you cannot match for review — this field is not a guaranteed reference to a line you sent.

    • expectedArrivalDate
      Type: string | null Format: date

      New expected arrival date for this line, as a UTC calendar day. Null when the supplier gave no new arrival date for the line.

    • expectedShipDate
      Type: string | null Format: date

      New expected ship date for this line, as a UTC calendar day. Null when the supplier gave no new ship date for the line.

    • note
      Type: string | null

      What the typed fields cannot carry — the supplier's account of why this line's dates moved.

  • purchaseOrderNumber
    Type: string
    required

    Your purchase order number, as sent when the purchase order was created.

  • source
    enum
    const:  
    SUPPLIER_EMAIL
    required

    Where the dates came from. New values may be added as Augment collects updates over other channels, so treat this as an open set.

    values
    • SUPPLIER_EMAIL
  • expectedArrivalDate
    Type: string | null Format: date

    New expected arrival date for the whole purchase order, as a UTC calendar day. Present only when the supplier stated one date for the order rather than per line. Null otherwise.

  • expectedShipDate
    Type: string | null Format: date

    New expected ship date for the whole purchase order, as a UTC calendar day. Present only when the supplier stated one date for the order rather than per line. Null otherwise.

  • note
    Type: string | null

    What the typed fields cannot carry — the supplier's account of why the dates moved, at purchase order level.