Find shipping methods

At checkout, customers choose their preferred shipping method based on delivery timelines and costs. Moreover, it may be necessary for you to review available shipping methods to ensure they’re current and accurate. To support these scenarios, you must get the latest shipping methods.

This endpoint gets shipping methods based on given filter conditions.

Authorizations

Authorization

string

headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Query Parameters

offset

integer

default: 0

Number of records to skip before returning all records. For example, offset=20, limit=10 returns records 21-30.

limit

integer

default: 10

Maximum number of records per page

Required range: 1 < x < 100

Body

application/json

Search criteria

filters

object[]

required

• Option 1
• Option 2

Show child attributes

sort

string

default: -shippingMethod.createdAt

Field or property name to sort the results. + represents ascending and - represents descending order of sorting

Response

200 - application/json

Search response

data

object[]

Show child attributes

pagination

object

Pagination response

Show child attributes

stats

string[]

A list of stats.