Fulfillment profiles

List, read, create, update and delete fulfillment profiles, each a named set of fulfillment statuses.

A fulfillment profile is a named set of fulfillment statuses. These endpoints list, read, create, update and delete profiles. This area has 5 endpoints, each available in all seven SDKs.

At a glance

Endpoint	Method	Path	What it does
List fulfillment profiles	GET	/settings/fulfillment_profiles	Returns a page of fulfillment profiles.
Create a fulfillment profile	POST	/settings/fulfillment_profiles	Creates a fulfillment profile from a name and one or more statuses, and returns the profile.
Retrieve a fulfillment profile	GET	/settings/fulfillment_profiles/{fulfillment_profile_id}	Returns one fulfillment profile by its id.
Delete a fulfillment profile	DELETE	/settings/fulfillment_profiles/{fulfillment_profile_id}	Deletes a fulfillment profile. A successful call returns 204 with no body.
Update a fulfillment profile	PATCH	/settings/fulfillment_profiles/{fulfillment_profile_id}	Changes a fulfillment profile and returns it.

Before you call

Register your API credentials once when your app starts, as shown in Authentication. Every SDK sample on these pages then gets its client in one line. With cURL, send the access token in an Authorization header: Authorization: Bearer $ACCESS_TOKEN.

Things to know

• A profile needs at least one status. statuses lists each status with a name and a status_index, starting at 0.
• Writes are wrapped in fulfillment_profile, and one profile comes back under fulfillment_profile.
• The listing pages by cursor. Pass limit, then send the next_cursor from pagination as cursor until has_more is false.