Menu

Fulfillment Providers API Routes

A fulfillment provider is a third-party integration or custom logic used to fulfill an order's items.

Fulfillment providers are installed as module providers.

GET /admin/fulfillment-providers#

List Fulfillment Providers

Retrieve a list of fulfillment providers. The fulfillment providers can be filtered by fields such as id. The fulfillment providers can also be sorted or paginated.

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

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.
offsetnumberOptional
The number of items to skip when retrieving a list.
limitnumberOptional
Limit the number of items returned in the list.
orderstringOptional
The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.
idstring | string[]Optional
Filter by a fulfillment provider's ID.
is_enabledbooleanOptional
Filter by whether the fulfillment provider is enabled.
qstringOptional
Search term to filter a fulfillment provider's searchable properties.
stock_location_idstring | string[]Optional
Filter by associated stock location's ID.
with_deletedbooleanOptional
Whether to include deleted records in the result.

Request examples

Responses

200 OK

limitnumber
The maximum number of items returned.
offsetnumber
The number of items skipped before retrieving the returned items.
countnumber
The total count of items.
fulfillment_providersobject[]
The list of fulfillment providers.
estimate_countnumberOptional
The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

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

GET /admin/fulfillment-providers/{id}/options#

List Fulfillment Options

Retrieve the list of fulfillment options of a fulfillment provider. These options may be retrieved from an integrated third-party service.

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

Path parameters

idstring
The fulfillment provider's ID.

Request examples

Responses

200 OK

limitnumber
The maximum number of items returned.
offsetnumber
The number of items skipped before retrieving the returned items.
countnumber
The total number of items.
fulfillment_optionsobject[]
The list of fulfillment options.
estimate_countnumberOptional
The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.

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