Order API

OrderFulfillment2

Represents a fulfillment (shipment) of order items.

Fulfillments track the shipping and delivery status of items in an order. This allows for delayed point accrual based on fulfillment or delivery events.

Properties

  • idstringoptional

    ID of the fulfillment in the ecommerce system

    This is the unique identifier for the fulfillment/shipment in your system.

    Example: "flf201"

  • timetimeoptional

    When the fulfillment was created

    This is typically when items were packed and prepared for shipping.

  • in_transit_timetimeoptional

    When the shipment was picked up by the carrier

    This marks when the items actually left your facility and are in transit to the customer.

  • deliveredbooleanoptional

    Whether the shipment has been delivered

    Set to true when you have confirmation that the customer received the items.

    Example: false

  • delivery_timetimeoptional

    When the shipment was delivered to the customer

    The actual delivery timestamp, if known. Only relevant when delivered is true.

  • itemsarray of OrderItemFulfillment2optional

    Which items and quantities are included in this fulfillment

    This allows tracking partial fulfillments where only some items or quantities from the order are shipped in this particular shipment.

    Example: [{"id":"xyz101","qty":2}]

Examples

Item Shipped

{
  "id": "flf201",
  "items": [
    {
      "id": "xyz101",
      "qty": 2
    }
  ],
  "delivered": false
}
Previous
Collection2