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

header

required

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.

Example:

0

limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

Body

application/json

Search criteria

filters

object[]

required

• Option 1
• Option 2

Criteria to find shipments by a single value. Condition between field and value is anything except IN and NIN when valueSearchFilter is used.

Show child attributes

filters.condition

enum<string>

default:

EQ

required

Search condition to apply filter

Available options:

EQ,

NEQ,

IN,

NIN,

LT,

GT,

LTE,

GTE

Example:

"EQ"

filters.field

string

required

Field name

Example:

"shippingMethod.addressType"

filters.value

Search criteria using a single value

Example:

"ORDER_CREATE"

sort

string

default:

-shippingMethod.createdAt

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

Example:

"+shippingMethod.createdAt"

Response

200

application/json

Returns list of shipping methods

Search response

data

object[]

Shipping method response model

Show child attributes

data.code

string

required

Shipping method code such as Same Day Delivery (SDD), Standard Shipping (STH), etc.

Example:

"SDD"

data.name

string

required

Shipping method name

Example:

"Express Delivery"

data.addressType

enum<string>

Address type. For example - APO: Army Post Office or MPO: Military Post Office

Available options:

APO,

MPO,

PO,

Business,

Residence

Example:

"APO"

data.attributes

object

User defined custom attributes. This is a placeholder for addition info (in key: value pairs)

Show child attributes

data.attributes.{key}

object

User defined custom attributes. This is a placeholder for addition info (in key: value pairs)

Example:

{ "carrier": "FedEx", "type": "Next Day" }

Example:

{ "carrier": "FedEx", "type": "Next Day" }

data.carrier

string

Shipping carrier name

Example:

"FedEx"

data.cartValue

object

Minimum and maximum values (weight, cost, etc.)

Show child attributes

data.cartValue.max

number

Maximum value

Example:

3.1

data.cartValue.min

number

Minimum value

Example:

2.1

data.channelId

string

Channel ID

Example:

"12"

data.configuredBy

string

User (ID or name) who configured the shipping method

Example:

"User3"

data.cost

number

Shipping cost given by merchant

Example:

20.5

data.createdAt

string

Time of shipping method creation (UTC)

Example:

"2022-08-01T20:03:28.483Z"

data.createdBy

string

User (ID or name) who created the shipping method

Example:

"User1"

data.currency

string

default:

USD

Three-letter currency code as defined by ISO-4217

Example:

"USD"

data.cutoffTime

integer

Time at which the current 'order day' is over. Note: If an order is delivered after the cutoff time, it's considered as delivered the next working day. For example, if the cutoff time is set to 5:00 PM, any orders delivered after this time will be considered to have been delivered the following business day.

Example:

1330

data.description

string

Brief description of shipping method

Example:

"Express Delivery 2 - 5 days"

data.dimension

object

Minimum and maximum dimensions

Show child attributes

data.dimension.max

object

Item dimensions

Show child attributes

data.dimension.max.height

number

Item height

Example:

2.4

data.dimension.max.length

number

Item length

Example:

4.6

data.dimension.max.uom

string

Unit of measurement (UOM)

Example:

"EA"

data.dimension.max.width

number

Item width

Example:

3.5

data.dimension.min

object

Item dimensions

Show child attributes

data.dimension.min.height

number

Item height

Example:

2.4

data.dimension.min.length

number

Item length

Example:

4.6

data.dimension.min.uom

string

Unit of measurement (UOM)

Example:

"EA"

data.dimension.min.width

number

Item width

Example:

3.5

data.isDeleted

boolean

true: Shipping method is deleted. false: Shipping method isn't deleted.

Example:

false

data.maximumDays

integer

Maximum duration required to deliver an order starting from the time it's placed

Example:

5

data.minimumDays

integer

Minimum duration required to deliver an order starting from the time it's placed

Example:

2

data.region

string

State or region of delivery

Example:

"CA"

data.shippingMethodId

string

Shipping method ID

Example:

"5349b4ddd2781d08c09890f4"

data.taxCode

string

Tax code associated with a shipping method. Depends on the applicable tax laws and regulations in each jurisdiction.

Example:

"FR01"

data.updatedAt

string

Time of last update to shipping method (UTC)

Example:

"2022-08-01T20:03:28.483Z"

data.updatedBy

string

User (ID or name) who update the shipping method

Example:

"User2"

data.weight

object

Minimum and maximum values (weight, cost, etc.)

Show child attributes

data.weight.max

number

Maximum value

Example:

3.1

data.weight.min

number

Minimum value

Example:

2.1

pagination

object

Pagination response

Show child attributes

pagination.count

integer

Total number of search results

Example:

1000

pagination.limit

integer

default:

10

Maximum number of records per page

Required range: 1 <= x <= 100

Example:

10

pagination.offset

integer

default:

0

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

Required range: x >= 0

Example:

1

stats

string[]

A list of stats.

The stats details.