Menu

Shipping Profiles API Routes

A shipping profile defines a type of items that are shipping in a similar manner. For example, digital products may have a digital shipping profile.

These API routes allow admin users to manage shipping profiles.

GET /admin/shipping-profiles#

List Shipping Profiles

Retrieve a list of shipping profiles. The shipping profiles can be filtered by fields such as id. The shipping profiles 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 shipping profile's ID.
qstringOptional
Search term to filter the shipping profile's searchable properties.
typestringOptional
Filter by a shipping profile's type.
namestringOptional
Filter by a shipping profile's name.
created_atobjectOptional
Filter by a shipping profile's creation date. Accepts the filter operators.
updated_atobjectOptional
Filter by a shipping profile's update date. Accepts the filter operators.
deleted_atobjectOptional
Filter by a shipping profile's deletion date. Accepts the filter operators.
$andobject[]Optional
Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.
$orobject[]Optional
Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.
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 number of items.
shipping_profilesobject[]
The list of shipping profiles.

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

POST /admin/shipping-profiles#

Create Shipping Profile

Create a shipping profile.

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.

Request body (application/json)

namestring
The shipping profile's name.
typestring
The shipping profile's type.
metadataobjectOptional
The shipping profile's metadata, used to store custom key-value pairs. Learn more in the Manage Metadata section.

Request examples

Responses

200 OK

shipping_profileobject
The shipping profile's details..

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

GET /admin/shipping-profiles/{id}#

Get a Shipping Profile

Retrieve a shipping profile by its ID. You can expand the shipping profile's relations or select the fields that should be returned.

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

Path parameters

idstring
The shipping profile'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

shipping_profileobject
The shipping profile's details..

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

POST /admin/shipping-profiles/{id}#

Update a Shipping Profile

Update a shipping profile's details.

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

Path parameters

idstring
The shipping profile'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 shipping profile's name.
typestringOptional
The shipping profile's type.
metadataobjectOptional
The shipping profile's metadata. Learn more in the Manage Metadata section.

Request examples

Responses

200 OK

shipping_profileobject
The shipping profile's details..

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

DELETE /admin/shipping-profiles/{id}#

Delete a Shipping Profile

Delete a shipping profile.

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

Path parameters

idstring
The shipping profile's ID.

Request examples

Responses

200 OK

idstring
The shipping profile's ID.
objectstring
The name of the deleted object.

Default: "shipping_profile"

deletedboolean
Whether the shipping profile was deleted.

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