Example payload

{
    "object": "fulfillment",
    "id": 42916,
    "custom_variables": null,
    "estimated_delivery_range_end": null,
    "estimated_delivery_range_start": null,
    "fulfillment_number": null,
    "merchant_id": null,
    "return_journey": false,
    "status_code": "pending",
    "updated_at": "2024-07-17T15:39:59Z",
    "uuid": "fe402ebf-4f70-4b0d-a50f-0e78bfe8914b",
    "created_at": "2024-07-17T00:00:00Z",
    "shipping_address": {
        "object": "address",
        "id": 83760
    },
    "trackers": {
        "object": "list",
        "data": [
            {
                "object": "tracker",
                "id": 37371
            }
        ]
    },
    "line_items": {
        "object": "list",
        "data": [
            {
                "object": "line_item",
                "id": 8793
            }
        ]
    },
    "notifications": {
        "object": "list",
        "data": [
            {
                "object": "notification",
                "id": 34768
            }
        ]
    },
}

Attributes

FIELDDESCRIPTION
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 across Shipup
estimated_delivery_range_end
datetime
End of estimated delivery date range for the fulfillment
fulfillment_number
string
Shop reference of the fulfillment.
merchant_id
string
ID used by the shop for the fulfillment
status_code
string
Fulfillment status. See available values
created_at
datetime
Time at which the fulfillment was imported into Shipup
updated_at
datetime
Time at which the fulfillment was last updated

Expandable resources