Create a fulfillment

Creates a fulfillment, i.e. a record of getting a sale's items to the customer.

Required permission:

GroupPermission
Fulfilment & ShippingCreate, edit, pick, ship and return fulfilments
Body Params

A fulfillment: how a sale's items get to the customer, e.g. shipped from a warehouse.

carrier
object
integer
required
destination_address
object
required
string
integer
integer
lines
array of objects
required
lines*
metadata
object
string
returns
array of objects
returns
integer
shipments
array of objects
shipments
source_warehouse
object
integer
string
required

Fulfillment status, e.g. Closed.

tags
array of strings
tags
string
required

Fulfillment type, e.g. Warehouse To Customer.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json