Shipping Options [API]
The shipping options GET request allows you to view all your existing shipping options along with their parameters.
Notes:
| Description |
List available Shipping Options
|
| Action |
GET |
| URL |
<your URL here>/api/shipping_options |
Sample Request Parameters
|
(empty – no data required) |
Sample Successful Response
|
[
{
"id": 1,
"name": "UPS",
"vat_class_id": 1,
"max_size_m3": null,
"is_default": false,
"created_at": "2019-06-17T13:49:07.000-04:00",
"updated_at": "2019-10-09T16:32:56.000-04:00",
"available_locations": {
"countries": [
"US"
]
},
"show_choice": true,
"rule_type": "per_order_value",
"tracking_url_template": "https://www.ups.com/track?loc=en_US&tracknum={{tracking_number}}",
"auto_apply": false,
"is_private": true,
"deleted_at": null
}
]
|
Update Shipping Cost for an Order
| Description |
Update Shipping Cost for an Order |
| Action |
PATCH |
| URL |
<your URL here>/api/orders/<order_id>/set_shipping_costs.json |
| Sample Request Parameters |
{ "shipping_costs": 10 }
|
| Sample Successful Response |
{ "status": 200, "message": "The shipping costs where updated" } |
Field descriptions
| Name |
Type |
Description |
| id |
integer |
Shipping option identifier
|
| name |
string |
Shipping option name
|
| vat_class_id |
integer |
VAT class identifier
|
| is_default |
boolean |
Specifies if this is a default shipping option
|
| created_at |
datetime |
Datetime this shipping option was created
|
| updated_at |
datetime |
Most recent datetime this shipping option was modified
|
| available_locations |
list
|
A list of countries where this shipping option is available
|
| show_choice |
boolean |
Specifies if this shipping option is available in the order checkout menu
|
| rule_type |
string
|
The rule that determines how this shipping option will be applied to an order
|
| tracking_url_template |
string |
The URL template that allows user to look up shipment tracking
|
| auto_apply |
boolean |
Sets the shipping option for every customer if True
|
| is_private |
boolean |
Allows you to set this shipping option for individual customers?
|
| deleted_at |
datetime |
Datetime this shipping option was deleted
|
