Skip to main content
POST
/
v1
/
fulfillments
Create
curl --request POST \
  --url https://{defaultHost}/v1/fulfillments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fulfillment": {
    "order": "acb10075-95a8-421b-a654-b75020ae35e7",
    "fulfillment_items": [
      {
        "line_item": "6f765ca4-81c2-4bbe-aabd-796618c49fa7",
        "quantity": 1
      }
    ],
    "shipments": [
      {
        "shipping_provider": "1719674c-0934-4d54-bc99-66d55be65b44",
        "inherit_weight": false,
        "weight": 2,
        "weight_unit": "lb",
        "dimensions": {
          "length": 10,
          "width": 8,
          "height": 5,
          "unit": "in"
        },
        "shipping_date": "2026-04-14",
        "from_contact": {
          "name": "Sender Name",
          "email": "sender@example.com",
          "phone": "555-123-4567",
          "address": {
            "line_1": "123 Main St",
            "city": "New York",
            "state": "NY",
            "postal_code": "10001",
            "country": "US"
          }
        },
        "to_contact": {
          "name": "Receiver Name",
          "email": "receiver@example.com",
          "phone": "555-987-6543",
          "address": {
            "line_1": "456 Oak Ave",
            "city": "Los Angeles",
            "state": "CA",
            "postal_code": "90001",
            "country": "US"
          }
        }
      }
    ]
  }
}
'
{
  "id": "a0c97f60-df45-4ed9-9ee7-f4ce0bd06c16",
  "object": "fulfillment",
  "notifications_enabled": false,
  "number": "0000-F1",
  "shipment_status": "unshipped",
  "g_weight": 0,
  "order": "acb10075-95a8-421b-a654-b75020ae35e7",
  "created_at": 1776176532,
  "updated_at": 1776176532
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
fulfillment
object

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

notifications_enabled
boolean

Whether or not notifications should be sent to customers when fulfillments are created and updated.

shipment_status
string

The current shipment status of this fulfillment – one of unshippable, unshipped, label_purchased, shipped, in_transit, delivered, returned, or failed.

metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

g_weight
number

Total weight of the entire fulfillment in grams.

number
string

The unique identifier for this fulfillment that is auto generated based on this account's order protocol.

order

Expandable – The associated order ID.

fulfillment_items

Expandable – Property not returned unless expanded.

trackings

Expandable – Property not returned unless expanded.

shipments

Expandable – Property not returned unless expanded.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.