Create shipping method
Creates shipping method. Response includes shippingMethodId, which is required for subsequent calls such as GET /{shipmethodId}, PATCH/{shipmethodId}, DELETE /{shipmethodId}, and GET /{shipMethodId}/items.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
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.
Body
Details of shipping method
Shipping method name
Brief description of shipping method
Tax code based on the state
Minimum days for delivery
Maximum days for delivery
Cut off delivery time
Shipping cost
Sales channel
User who created the shipping method
Address type of delivery
24-character system-generated unique shipping method ID. Optional in the request body
Region or state of shipping
true: Shipping method is deleted <br /> false: Shipping method is active
User who last modified the shipping method
User who configured the shipping method
Min-max value
Min-max value
Min-Max dimension details
Time of shipping method creation
Time of shipping method creation
Response
Details of shipping method
Shipping method name
Brief description of shipping method
Tax code based on the state
Minimum days for delivery
Maximum days for delivery
Cut off delivery time
Shipping cost
Sales channel
User who created the shipping method
Address type of delivery
24-character system-generated unique shipping method ID. Optional in the request body
Region or state of shipping
true: Shipping method is deleted <br /> false: Shipping method is active
User who last modified the shipping method
User who configured the shipping method
Min-max value
Min-max value
Min-Max dimension details
Time of shipping method creation
Time of shipping method creation
Was this page helpful?