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.

FIELDDESCRIPTION
merchant_id
string, required
ID used by the shop for the fulfillment
fulfillment_number
string, optional
Shop reference of the fulfillment. For instance, this can be the order number suffixed by an underscore and the fulfillment count (ABCD_1)
estimated_delivery_range_start
datetime, optional
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
estimated_delivery_range_end
datetime, optional
End of estimated delivery date range
custom_variables
object, optional
Custom variables for the fulfillment
status_code
string, optional, see available values
Fulfillment status. This field is required if you want to send pre-shipment notifications. Each status_code is associated with a pre-shipment notification
can_assign_items
boolean
This attribute is meant 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
warehouse_merchant_id string, optionalID of the warehouse (or equivalent) for this fulfillment. When not provided, we will associate the fulfillment to the company's default warehouse.
shipping_address
object, optional
An address is a physical address.
See address payload above
line_items
array of objects, optional
Fulfilled line items (not shipped yet). Before fulfillment, line items are placed in the order object. Once shipped, they are placed in the tracker object.
See line Item payload above
trackers
array of objects, optional
Trackers related to this fulfillment
See tracker payload below