Example fulfillment object
{
"object": "fulfillment",
"id": 194072,
"custom_variables": {},
"estimated_delivery_range_end": 1565769600,
"estimated_delivery_range_start": 1565596800,
"fulfillment_number": "000051310_1",
"merchant_id": "51590",
"status_code": "shipped",
"created_at": 1565596800,
"updated_at": 1565596800,
"line_items": null,
"order": null,
"shipping_address": null,
"trackers": null
}
In Shipup, a fulfillment represents a shipment of one or more items in an order. When an order has been completely fulfilled, it means that all the items that are included in the order have been sent to the customer.
In most cases, a merchant will make just one shipment per order, but sometimes the availability or size of items in the order requires a merchant to make more than one shipment. Each shipment should be treated as a separate fulfillment.
On rare occasions, a fulfillment can later be split into multiple shipments. A fulfillment can thus have multiple tracker objects associated.
| FIELD | DESCRIPTION |
|---|---|
| id integer | Unique identifier of the fulfillment |
| canceled boolean | Whether or not the fulfillment is canceled |
| custom_variables object | Custom variables for the fulfillment |
| estimated_delivery_range_start datetime | Estimated delivery date for the fulfillment. If estimated_delivery_range_end is also provided, a range will be displayed. Otherwise, estimated_delivery_range_start will be displayed alone This field and estimated_delivery_range_end are currently only used to display a delivery estimate in the order view of your tracking page. The tracker object's displayable_expected_delivery_date field is more globally used accros Shipup |
| estimated_delivery_range_end datetime | End of estimated delivery date range for the fulfillment |
| fulfillment_number string | Shop reference of the fulfillment. For instance, this can be the order number suffixed by an underscore and the fulfillment count (ABCD_1) |
| merchant_id string | ID used by the shop for the fulfillment |
| status_code string (see available values) | Fulfillment status |
| can_assign_items boolean | This attribute is ment to be set to true by default.The only occasion in which this attribute is set to false is when: 1/ you have multiple trackers in the fulfillment 2/ you do not know in which tracker each line item has been shipped, you only know that the items have been shipped |
| line_items list of line items, expandable | List of items constituting the fulfillment |
| order order, expandable | Order this fulfillment is included in |
| shipping_address address, expandable | Mailing address to where the fulfillment will be shipped |
| trackers list of trackers, expandable | List of trackers constituting the fulfillment |
| created_at datetime | Time at which the fulfillment was imported into Shipup |
| updated_at datetime | Time at which the fulfillment was last updated |