# Fulfillment API Reference

Fulfillment object:

{
	"type": "fulfillments",
	"id": "(string)",
	"attributes": {
		"status": "string,in:pending,processing,success,cancelled,error,failure",
		"shipment_status": "string,in:pending,awaiting-shipment,awaiting-pickup,shipped,delivered,cancelled,failure",
		"tracking": [
			"tracking_company": "...",
			"tracking_url": "...",
			"tracking_number": "..."
		],
		"order_items": [
			{
				"order_item_id": "...",
				"quantity": { Integer }
			},
			...
		],
		"item_count": { Integer },
		"notify_customer": { Boolean },
		"created_at": "string|datetime",
		"updated_at": "string|datetime"
	}
}

Related resources: Order, Order Item

# Writable fields

Field name	Creating	Updating
send_notification	boolean	boolean
shipment_status	string\|in:pending,awaiting-shipment,awaiting-pickup,shipped,delivered,cancelled,failure	string\|in:pending,awaiting-shipment,awaiting-pickup,shipped,delivered,cancelled,failure
order_items	array	array
tracking	array	array
notify_customer	boolean	boolean

# Writable relationships

Relationship name	Relationship resource type	Type	Creating	Updating
order	orders	To-one	Yes - Required	No

# Sortable

Field name
shipment_status
status
created_at
updated_at

# Filters

Filter name	Detail
order_item_id	string
order_item_ids	string, separate ids by commas
order_id	uuid
shipment_status	string
status	string
created_at	string\|datetime
created_at	string\|datetime

← Transactions Shippings →