store_shipping_method

Collection: store_shipping_methods

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.

Required Scopes

Full store_full_access
Read shipping_settings_read
Write shipping_settings_write

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 (13)

shipping_method_uri String · Required

The full API URI of the shipping method defined in our property helpers.

See shipping_methods property helper.

shipping_container_uri String · Optional

The full API URI of the shipping method container defined in our property helpers. Each shipping method will have its own shipping containers.

See the shipping_containers link relationship under shipping_methods.

shipping_drop_type_uri String · Optional

The full API URI of the shipping method drop type defined in our property helpers. Each shipping method will have its own shipping drop types.

See the shipping_drop_types link relationship under shipping_methods.

accountid String (nullable) · Optional · max 200

If using account specific rates, enter your shipping account id here. For CUSTOM-CODE, this is the endpoint URL.

password String (nullable) · Optional · max 50

If using account specific rates, enter your shipping account password here.

meter_number String (nullable) · Optional · max 50

If using account specific rates, enter your shipping account meter number here, if applicable.

authentication_key String (nullable) · Optional · max 50

If using account specific rates, enter your shipping account authentication key here, if applicable.

use_for_domestic Boolean

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.

use_for_international Boolean

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.

custom_code String

For the CUSTOM-CODE shipping method. JavaScript used to create and modify shipping rates.

Text (JavaScript). 64kb max.

deployment_status String · Read-only

For the CUSTOM-CODE shipping method. Indicates the deployment state of custom code.

deployingdeployederror
date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (10)

self This Store Shipping Method
fx:store GET PATCH PUT DELETE This Store
fx:store_shipping_services GET POST Shipping Services for This Shipping Method
fx:shipping_method GET This Shipping Method
fx:shipping_container GET This Shipping Container
fx:shipping_drop_type GET This Shipping Drop Type
fx:shipping_methods GET All Shipping Methods
fx:shipping_services GET All Shipping Services for this Shipping Method
fx:shipping_containers GET All Shipping Containers for this Shipping Method
fx:shipping_drop_types GET All Shipping Drop Types for this Shipping Method

Zoomable Resources

Embed related resources using ?zoom=<resource>. Filter with ?resource:property=value.

store_shipping_services shipping_method shipping_container shipping_drop_type
https://api.foxycart.com/store_shipping_methods/{id}

Example Representation

Zoom
{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/store_shipping_methods/123",
      "title": "This Store Shipping Method"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:store_shipping_services": {
      "href": "https://api.foxycart.com/store_shipping_methods/123/store_shipping_services",
      "title": "Shipping Services for This Shipping Method"
    },
    "fx:shipping_method": {
      "href": "https://api.foxycart.com/property_helpers/shipping_methods/999",
      "title": "This Shipping Method"
    },
    "fx:shipping_container": {
      "href": "https://api.foxycart.com/property_helpers/shipping_containers/999",
      "title": "This Shipping Container"
    },
    "fx:shipping_drop_type": {
      "href": "https://api.foxycart.com/shipping_drop_type/456",
      "title": "This Shipping Drop Type"
    },
    "fx:shipping_methods": {
      "href": "https://api.foxycart.com/property_helpers/shipping_methods",
      "title": "All Shipping Methods"
    },
    "fx:shipping_services": {
      "href": "https://api.foxycart.com/property_helpers/shipping_methods/999/shipping_services",
      "title": "All Shipping Services for this Shipping Method"
    },
    "fx:shipping_containers": {
      "href": "https://api.foxycart.com/property_helpers/shipping_methods/999/shipping_containers",
      "title": "All Shipping Containers for this Shipping Method"
    },
    "fx:shipping_drop_types": {
      "href": "https://api.foxycart.com/property_helpers/shipping_methods/999/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
}