Menu

Fulfillment Sets API Routes

A fulfillment set is a general form or way of fulfillment, such as "shipping" or "pick up".

All fulfillment-related configurations in a store are related to a fulfillment set.

These API routes allow admin users to manage fulfillment sets.

DELETE /admin/fulfillment-sets/{id}#

Delete Fulfillment Set

Delete a fulfillment set.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment set's ID.

Request examples

Responses

200 OK

idstring
The fulfillment set's ID.
objectstring
The name of the deleted object.

Default: "fulfillment_set"

deletedboolean
Whether the fulfillment set was deleted.

400, 401, 404, 409, 422, 500: an error response is returned.

POST /admin/fulfillment-sets/{id}/service-zones#

Add a Service Zone to a Fulfillment Set

Add a service zone to a fulfillment set.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment set's ID.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Request body (application/json)

namestring
The service zone's name.
geo_zonesobject[]
The service zone's geo zones.

Request examples

Responses

200 OK

fulfillment_setobject
The service zone's fulfillment set.

400, 401, 404, 409, 422, 500: an error response is returned.

GET /admin/fulfillment-sets/{id}/service-zones/{zone_id}#

Get a Service Zone in a Fulfillment Set

Retrieve a service zone that belongs to a fulfillment set. be paginated.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment set's ID.
zone_idstring
The service zone's ID.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Request examples

Responses

200 OK

service_zoneobject
The shipping option's service zone.

400, 401, 404, 409, 422, 500: an error response is returned.

POST /admin/fulfillment-sets/{id}/service-zones/{zone_id}#

Update the Service Zone of a Fulfillment Set

Update the details of a service zone in a fulfillment set.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment set's ID.
zone_idstring
The service zone's ID.

Query parameters

fieldsstringOptional
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.

Request body (application/json)

namestringOptional
The service zone's name.
geo_zonesobject[]Optional
The service zone's associated geo zones.

Request examples

Responses

200 OK

fulfillment_setobject
The service zone's fulfillment set.

400, 401, 404, 409, 422, 500: an error response is returned.

DELETE /admin/fulfillment-sets/{id}/service-zones/{zone_id}#

Remove a Service Zone from Fulfillment Set

Remove a service zone that belongs to a fulfillment set.

Authentication: secret API key (HTTP Basic authorization), cookie session, JWT bearer token.

Path parameters

idstring
The fulfillment set's ID.
zone_idstring
The service zone's ID.

Request examples

Responses

200 OK

idstring
The service zone's ID.
objectstring
The name of the deleted object.

Default: "service_zone"

deletedboolean
Whether the service zone was deleted.
parentobjectOptional
The service zone's fulfillment set.

400, 401, 404, 409, 422, 500: an error response is returned.

Found a problem with this page?Report Issue
Edited Nov 14·Edit this page