| Field | Type | Description | Validation |
|---|---|---|---|
carrier_tracking_url | string | The tracking URL provided by the carrier. | |
deliver_by | string | The date and time by which the fulfillment should be delivered. | - |
id | number (double) | The ID of this object in Delivery Hub. | Valid uuid |
items_count | number (double) | The number of items included in the fulfillment. | - |
fulfillment_method | string | Designates if the fulfillment method is direct delivery to the recipient's address or via a PUDO (pickup/dropoff) location. When empty, the default value is direct. | - |
fulfillment_type | string | Designates if this is a delivery or return. When empty, the default value is delivery. | - |
name | string | The name of the fulfillment. | 1-225 characters Required if idis absent. |
notes | array | Additional order details, such as contact or address instructions. | - |
order_id | number (double) | Bringg's ID for this order. | - |
pudo_location_id | string | The ID of the PUDO (pickup/drop off) location for this fulfillment. | Forbidden if fulfillment_method is direct.1-225 characters |
products | array | An array of product objects associated with the fulfillment. See Product. | Required |
quote_id | string | ID of the quote associated with the fulfillment. | Required, Valid uuid |
recipient | object | An object containing information about the recipient. | Required if recipient_address is present. Forbidden if recipient_location_id is present. |
recipient_address | object | The address of the party receiving the fulfillment. In the case of returns, this is the retailer. | |
recipient_address_id | number (double) | The ID for this address in Delivery Hub. | Valid uuid |
recipient_id | number (double) | ID of the recipient associated with the fulfillment. | Valid uuid |
recipient_location_id | number (double) | Delivery Hub's or your source system's ID for the recipient's location. | Forbidden if recipient or recipient_address are present. |
required_service_level | string | The service levels required for this shipment, as defined by your organization and based on included products. For example, certain hazardous materials might require delivery within 72 hours. | |
sender | object | Represents the party sending the fulfillment. In the case of returns, this is the customer. | Required if sender_address is present or if sender_location_idis absent. Forbidden if sender_location_id is present. |
sender_address | object | The address of the party sending the fulfillment. In the case of returns, this is the customer. | Required if sender is present or sender_location_id is absent. Forbidden if sender_location_id is present.Omit when |
sender_address_id | number (double) | Delivery Hub's ID for the sender's location. This is the shipping location for delivery use cases. | Valid uuid |
sender_id | number (double) | ID of the sender associated with the fulfillment. | Valid uuid |
sender_location_id | number (double) | Delivery Hub's or your source system's ID for the sender's location. This is the shipping location for delivery use cases. | Required if sender or sender_address are absent. Forbidden if sender or sender_address is present. |
service | string | The service level for the quoted booking, such as same-day. | Required if pudo_location_id is present,Required if shipping_account_id is present,1-225 characters Omit to manually trigger shipping rules in the carrier assignment modal (learn more). |
shipments | array of objects | The shipments that belong to this order, listed as an array. | |
shipping_account_id | number (double) | The shipping account used for the quoted or actual booking. | Required if pudo_location_id is present,Required if service is present,positive integer Omit to manually trigger shipping rules in the carrier assignment modal (learn more). |
source_id | string | Your source system's ID for this fulfillment. | Required if shipping_account_id is present,1-225 characters |
status | string | Current status of the fulfillment. Possible values:Quoted New PartiallyFulfilled ReadyToShip PickedUp InTransit OutForDelivery Delivered Exception CanceledByCarrier Canceled | - |
total_weight | number (double) | The total weight of all items included in the fulfillment. | - |