GET
/
shipping
/
{shipmethodId}

Authorizations

Authorization
string
headerrequired

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

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Path Parameters

shipmethodId
string
required

24-character system-generated unique ID of shipping method

Response

200 - application/json

Details of shipping method

name
string
required

Shipping method name

description
string
required

Brief description of shipping method

taxCode
string
required

Tax code based on the state

minimumDays
integer
required

Minimum days for delivery

maximumDays
integer
required

Maximum days for delivery

cutOffTime
integer
required

Cut off delivery time

cost
number
required

Shipping cost

channel
string
required

Sales channel

createdBy
string
required

User who created the shipping method

addressType
string
required

Address type of delivery

shippingMethodId
string

24-character system-generated unique shipping method ID. Optional in the request body

region
string

Region or state of shipping

deleted
boolean

true: Shipping method is deleted <br /> false: Shipping method is active

updatedBy
string

User who last modified the shipping method

configuredBy
string

User who configured the shipping method

weight
object

Min-max value

cartValue
object

Min-max value

dimension
object

Min-Max dimension details

createdAt
string

Time of shipping method creation

updatedAt
string

Time of shipping method creation

Was this page helpful?

Create shipping methodDelete shipping method