Get shipping methods

Getting Started

Authentication v3

Concepts
System Apps
User Apps
Authentication Endpoints

Product Catalog

Product Catalog API - Overview
Developer Guide
Data Ingestion Best Practices
Attributes & Attribute Mapping
Categories
Products
Collections
Background Jobs
Bulk Import & Export
Published Products

Orders

Orders (3.0.0)
Developer Guide
Orders FAQ
Shopping Lists
Shipping Methods
- POST
  Find shipping methods
- DEL
  Delete shipping method
- POST
  Create shipping method
- GET
  Get shipping method
- PUT
  Update shipping method
- GET
  Get item IDs for given shipping method
- POST
  Add items to shipping method
- POST
  Delete items from shipping method
- POST
  Get shipping methods
Imports
Exports
Orders
Frauds
Notifications
Backorders Preorders
Cancellations
Allocations
Shipments
Inventory Transfers
Tracking
Invoices
Payments
Credits
Appeasements
Returns

Inventory

Inventory (3.0.0)
Inventory FAQ
Imports
Counters
Inventory
Locations
Networks

Integrations

Offers

Offers (3.0.0)
Developer Guide
Real-time Pricing Engine
Price Lists
Prices
Price Types
Price Controls
Price Methods
Priced Products
Add-ons
Promotions
Coupons
Coupon Codes
Redemptions
Product Exclusion Lists
Segments
Imports
Exports
Attributes
Webhook Events

Carts

Overview
Developer Guides
Carts
Order Draft
Items
Addresses
Payments
Fulfillment
Customer
Coupons
Validations
Cart Orchestrator

Customers

Customer Profile
Customer Address
Customer Self

POST

shipping-methods

actions

filter-by-item-id

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

itemId

string

required

Item ID

Response

200 - application/json

List of shipping methods and their details

shippingMethods

object[]

Details of shipping methods

shippingMethods.addressType

enum<string>

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

Available options:

APO,

MPO,

PO,

Business,

Residence

shippingMethods.attributes

object

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

shippingMethods.carrier

string

Shipping carrier name

shippingMethods.cartValue

object

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

shippingMethods.channelId

string

Channel ID

shippingMethods.code

string

required

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

shippingMethods.configuredBy

string

User (ID or name) who configured the shipping method

shippingMethods.cost

number

Shipping cost given by merchant

shippingMethods.createdAt

string

Time of shipping method creation (UTC)

shippingMethods.createdBy

string

User (ID or name) who created the shipping method

shippingMethods.currency

string

default: USD

Three-letter currency code as defined by ISO-4217

shippingMethods.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.

shippingMethods.description

string

Brief description of shipping method

shippingMethods.dimension

object

Minimum and maximum dimensions

shippingMethods.isDeleted

boolean

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

shippingMethods.maximumDays

integer

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

shippingMethods.minimumDays

integer

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

shippingMethods.name

string

required

Shipping method name

shippingMethods.region

string

State or region of delivery

shippingMethods.shippingMethodId

string

Shipping method ID

shippingMethods.taxCode

string

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

shippingMethods.updatedAt

string

Time of last update to shipping method (UTC)

shippingMethods.updatedBy

string

User (ID or name) who update the shipping method

shippingMethods.weight

object

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

Was this page helpful?

Delete items from shipping method Getting Started with Imports