Create shipping method
On your storefront, shipping methods determine how products are delivered to your customers. Some of the common shipping methods are domestic, international, free shipping, and express delivery.
This endpoint is used to create a new shipping method. In the response, you will also get a shipping method ID, which will be required for subsequent calls to get, update, and delete this shipping method.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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 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.
Unique request ID
Body
Details to create shipping method
Shipping method code such as Same Day Delivery (SDD), Standard Shipping (STH), etc.
Shipping method name
Address type. For example - APO: Army Post Office or MPO: Military Post Office
APO, MPO, PO, Business, Residence User defined custom attributes. This is a placeholder for addition info (in key: value pairs)
Shipping carrier name
Minimum and maximum values (weight, cost, etc.)
Shipping cost given by merchant
User (ID or name) who created the shipping method
Three-letter currency code as defined by ISO-4217
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.
Brief description of shipping method
Minimum and maximum dimensions
Maximum duration required to deliver an order starting from the time it's placed
Minimum duration required to deliver an order starting from the time it's placed
State or region of delivery
Tax code associated with a shipping method. Depends on the applicable tax laws and regulations in each jurisdiction.
Minimum and maximum values (weight, cost, etc.)
Response
Shipping method response model
Shipping method code such as Same Day Delivery (SDD), Standard Shipping (STH), etc.
Shipping method name
Address type. For example - APO: Army Post Office or MPO: Military Post Office
APO, MPO, PO, Business, Residence User defined custom attributes. This is a placeholder for addition info (in key: value pairs)
Shipping carrier name
Minimum and maximum values (weight, cost, etc.)
Channel ID
User (ID or name) who configured the shipping method
Shipping cost given by merchant
Time of shipping method creation (UTC)
User (ID or name) who created the shipping method
Three-letter currency code as defined by ISO-4217
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.
Brief description of shipping method
Minimum and maximum dimensions
true: Shipping method is deleted. false: Shipping method isn't deleted.
Maximum duration required to deliver an order starting from the time it's placed
Minimum duration required to deliver an order starting from the time it's placed
State or region of delivery
Shipping method ID
Tax code associated with a shipping method. Depends on the applicable tax laws and regulations in each jurisdiction.
Time of last update to shipping method (UTC)
User (ID or name) who update the shipping method
Minimum and maximum values (weight, cost, etc.)
Was this page helpful?