store_shipping_methods
Description
This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
Actions
- GET
- View a list of store_shipping_methods
- POST
- Create a new store_shipping_method
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "...",
"title": "This Collection"
},
"first": {
"href": "...?offset=0",
"title": "First Page of this Collection"
},
"prev": {
"href": "...?offset=0",
"title": "Previous Page of this Collection"
},
"next": {
"href": "...?offset=0",
"title": "Next Page of this Collection"
},
"last": {
"href": "...?offset=0",
"title": "Last Page of this Collection"
}
},
"_embedded": {
"fx:store_shipping_methods": [...]
},
"total_items": "5",
"returned_items": 5,
"limit": 20,
"offset": 0
}
<?xml version="1.0" encoding="UTF-8"?> <resource href="..."> <link rel="self" href="..." title="This Collection"/> <link rel="first" href="...?offset=0" title="First Page of this Collection"/> <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/> <link rel="next" href="...?offset=0" title="Next Page of this Collection"/> <link rel="last" href="...?offset=0" title="Last Page of this Collection"/> <resource href="..." rel="https://api.foxycart.com/rels/store_shipping_method"> ... </resource> <total_items>5</total_items> <returned_items>5</returned_items> <limit>20</limit> <offset>0</offset> </resource>
{
"properties": {
"total_items": "5",
"returned_items": 5,
"limit": 20,
"offset": 0
},
"entities": [...],
"links": [
{
"rel": [
"self"
],
"href": "..."
},
{
"rel": [
"first"
],
"href": "...?offset=0"
},
{
"rel": [
"prev"
],
"href": "...?offset=0"
},
{
"rel": [
"next"
],
"href": "...?offset=0"
},
{
"rel": [
"last"
],
"href": "...?offset=0"
}
],
"actions": [
]
}
Embedded Resource: store_shipping_method
Description
This resource represents an active shipping method for your store. It is also where you configure your account information if you want to use account-specific rate requests. This shipping method will be available for any item category with a shipping item_delivery_type.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
Actions
- GET
- View a store_shipping_method
- PATCH
- Update a store_shipping_method (send only the properties you want to modify)
- PUT
- Replace a store_shipping_method (send the entire representation)
- DELETE
- Delete a store_shipping_method
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Properties
| Property | Description | Type | Constraints |
|---|---|---|---|
| shipping_method_uri | The full API URI of the shipping method defined in our property helpers. | URL | shipping_methods |
| shipping_container_uri | The full API URI of the shipping method container defined in our property helpers. Each shipping method will have it's own shipping containers. | URL | See the shipping_containers link relationship under shipping_methods |
| shipping_drop_type_uri | The full API URI of the shipping method drop type defined in our property helpers. Each shipping method will have it's own shipping drop types. | URL | See the shipping_drop_types link relationship under shipping_methods |
| accountid | If using account specific rates, enter your shipping account id here. | String | Optional. 200 characters or less. |
| password | If using account specific rates, enter your shipping account password here. | String | Optional. 50 characters or less. |
| meter_number | If using account specific rates, enter your shipping account meter number here, if applicable. | String | Optional. 50 characters or less. |
| authentication_key | If using account specific rates, enter your shipping account authentication key here, if applicable. | String | Optional. 50 characters or less. |
| use_for_domestic | Set to true if you want this shipping method to apply to domestic shipping rate requests. Note: This value is read only true for CUSTOM-CODE. |
Boolean | true or false, 1 or 0. |
| use_for_international | Set to true if you want this shipping method to apply to international shipping rate requests. Note: This value is read only true for CUSTOM-CODE. |
Boolean | true or false, 1 or 0. |
| date_created | The date this resource was created. | Date | Read only |
| date_modified | The date this resource was last modified. | Date | Read only |
| custom_code | For the CUSTOM-CODE shipping method. JavaScript used to create and modify shipping rates. |
String | Text (JavaScript). 64kb max. |
| deployment_status | For the CUSTOM-CODE shipping method. Values are deploying, deployed, and error. |
String | Read only |
Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api-sandbox.foxycart.com/store_shipping_methods/1504",
"title": "This Store Shipping Method"
},
"fx:store": {
"href": "https://api-sandbox.foxycart.com/stores/66",
"title": "This Store"
},
"fx:store_shipping_services": {
"href": "https://api-sandbox.foxycart.com/store_shipping_methods/1504/store_shipping_services",
"title": "Shipping Services for This Shipping Method"
},
"fx:shipping_method": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2",
"title": "This Shipping Method"
},
"fx:shipping_container": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_containers/12",
"title": "This Shipping Container"
},
"fx:shipping_drop_type": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_drop_types/7",
"title": "This Shipping Drop Type"
},
"fx:shipping_methods": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods",
"title": "All Shipping Methods"
},
"fx:shipping_services": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2/shipping_services",
"title": "All Shipping Services for this Shipping Method"
},
"fx:shipping_containers": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods2/shipping_containers",
"title": "All Shipping Containers for this Shipping Method"
},
"fx:shipping_drop_types": {
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods2/shipping_drop_types",
"title": "All Shipping Drop Types for this Shipping Method"
}
},
"shipping_method_uri": "https://api-sandbox.foxycart.com/shipping_methods/2",
"shipping_container_uri": "https://api-sandbox.foxycart.com/shipping_containers/12",
"shipping_drop_type_uri": "https://api-sandbox.foxycart.com/shipping_drop_types/7",
"accountid": "",
"password": "",
"meter_number": "",
"authentication_key": "",
"use_for_domestic": true,
"use_for_international": true,
"date_created": null,
"date_modified": null
}
<?xml version="1.0" encoding="UTF-8"?> <resource href="https://api-sandbox.foxycart.com/store_shipping_methods/1504"> <link rel="self" href="https://api-sandbox.foxycart.com/store_shipping_methods/1504" title="This Store Shipping Method"/> <link rel="https://api.foxycart.com/rels/store" href="https://api-sandbox.foxycart.com/stores/66" title="This Store"/> <link rel="https://api.foxycart.com/rels/store_shipping_services" href="https://api-sandbox.foxycart.com/store_shipping_methods/1504/store_shipping_services" title="Shipping Services for This Shipping Method"/> <link rel="https://api.foxycart.com/rels/shipping_method" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2" title="This Shipping Method"/> <link rel="https://api.foxycart.com/rels/shipping_container" href="https://api-sandbox.foxycart.com/property_helpers/shipping_containers/12" title="This Shipping Container"/> <link rel="https://api.foxycart.com/rels/shipping_drop_type" href="https://api-sandbox.foxycart.com/property_helpers/shipping_drop_types/7" title="This Shipping Drop Type"/> <link rel="https://api.foxycart.com/rels/shipping_methods" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods" title="All Shipping Methods"/> <link rel="https://api.foxycart.com/rels/shipping_services" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2/shipping_services" title="All Shipping Services for this Shipping Method"/> <link rel="https://api.foxycart.com/rels/shipping_containers" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods2/shipping_containers" title="All Shipping Containers for this Shipping Method"/> <link rel="https://api.foxycart.com/rels/shipping_drop_types" href="https://api-sandbox.foxycart.com/property_helpers/shipping_methods2/shipping_drop_types" title="All Shipping Drop Types for this Shipping Method"/> <shipping_method_uri>https://api-sandbox.foxycart.com/shipping_methods/2</shipping_method_uri> <shipping_container_uri>https://api-sandbox.foxycart.com/shipping_containers/12</shipping_container_uri> <shipping_drop_type_uri>https://api-sandbox.foxycart.com/shipping_drop_types/7</shipping_drop_type_uri> <accountid></accountid> <password></password> <meter_number></meter_number> <authentication_key></authentication_key> <use_for_domestic>true</use_for_domestic> <use_for_international>true</use_for_international> <date_created></date_created> <date_modified></date_modified> </resource>
{
"class": [
"store_shipping_method"
],
"properties": {
"shipping_method_uri": "https://api-sandbox.foxycart.com/shipping_methods/2",
"shipping_container_uri": "https://api-sandbox.foxycart.com/shipping_containers/12",
"shipping_drop_type_uri": "https://api-sandbox.foxycart.com/shipping_drop_types/7",
"accountid": "",
"password": "",
"meter_number": "",
"authentication_key": "",
"use_for_domestic": true,
"use_for_international": true,
"date_created": null,
"date_modified": null
},
"links": [
{
"rel": [
"self"
],
"href": "https://api-sandbox.foxycart.com/store_shipping_methods/1504"
},
{
"rel": [
"https://api.foxycart.com/rels/store"
],
"href": "https://api-sandbox.foxycart.com/stores/66"
},
{
"rel": [
"https://api.foxycart.com/rels/store_shipping_services"
],
"href": "https://api-sandbox.foxycart.com/store_shipping_methods/1504/store_shipping_services"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_method"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_container"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_containers/12"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_drop_type"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_drop_types/7"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_methods"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_services"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods/2/shipping_services"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_containers"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods2/shipping_containers"
},
{
"rel": [
"https://api.foxycart.com/rels/shipping_drop_types"
],
"href": "https://api-sandbox.foxycart.com/property_helpers/shipping_methods2/shipping_drop_types"
}
],
"actions": [
{
"name": "self",
"title": "Update Store Shipping Method",
"method": "PATCH",
"href": "https://api-sandbox.foxycart.com/store_shipping_methods/1504",
"type": "application/x-www-form-urlencoded",
"fields": [
{
"name": "shipping_method_uri",
"title": "Shipping Method URI",
"type": "url",
"value": "https://api-sandbox.foxycart.com/shipping_methods/2"
},
{
"name": "shipping_container_uri",
"title": "Shipping Container URI",
"type": "url",
"value": "https://api-sandbox.foxycart.com/shipping_containers/12"
},
{
"name": "shipping_drop_type_uri",
"title": "Shipping Drop Type URI",
"type": "url",
"value": "https://api-sandbox.foxycart.com/shipping_drop_types/7"
},
{
"name": "accountid",
"title": "Accountid",
"type": "text",
"value": ""
},
{
"name": "password",
"title": "Password",
"type": "text",
"value": ""
},
{
"name": "meter_number",
"title": "Meter Number",
"type": "text",
"value": ""
},
{
"name": "authentication_key",
"title": "Authentication Key",
"type": "text",
"value": ""
},
{
"name": "use_for_domestic",
"title": "Use For Domestic",
"type": "checkbox",
"value": true
},
{
"name": "use_for_international",
"title": "Use For International",
"type": "checkbox",
"value": true
}
]
}
]
}
Zoomable Resources
The following related resources can be embedded within this resource by including a ?zoom=<child_resource> parameter. You can also filter by child resources by ?child_resource:property=<property_value>
store_shipping_services
shipping_method
shipping_container
shipping_drop_type