shipping_address_types : Foxy hAPI

shipping_address_types

Description

This property helper lets you know which shipping address types we currently support for calculating shipping costs. The values here correspond with Store resource's shipping_address_type property.

The values JSON object has the following properties

residential: Rate as Residential.
commercial: Rate as Commercial.
determine_by_company: Rate based on Company field.

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 shipping_address_types
HEAD: Get just the header response
OPTIONS: Get a response explaining which HTTP methods are supported

Properties

Property	Description	Type	Constraints
message	A small, human readable explanation of this property helper.	String	Read only
values	JSON objects with the checkout types supported. The key values are the values you use for the Store resource's `shipping_address_type` property.	JSON	Read only

Example Representation

{
    "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
        "self": {
            "href": "https://api.foxycart.com/property_helpers/shipping_address_types",
            "title": "List of valid address type values for the Store resource shipping_address_type setting."
        },
        "fx:property_helpers": {
            "href": "https://api.foxycart.com/property_helpers",
            "title": "Property Helpers Home"
        }
    },
    "message": "The values listed here are the correct values for the Store shipping_address_type field. The values are listed in the format value => description.",
    "values": {
        "residential": "Rate as Residential",
        "commercial": "Rate as Commercial",
        "determine_by_company": "Rate based on Company field"
    }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/property_helpers/shipping_address_types">
  <link rel="self" href="https://api.foxycart.com/property_helpers/shipping_address_types" title="List of valid address type values for the Store resource shipping_address_type setting."/>
  <link rel="https://api.foxycart.com/rels/property_helpers" href="https://api.foxycart.com/property_helpers" title="Property Helpers Home"/>
  <message>The values listed here are the correct values for the Store shipping_address_type field. The values are listed in the format value =&amp;gt; description.</message>
  <values>
    <residential>Rate as Residential</residential>
    <commercial>Rate as Commercial</commercial>
    <determine_by_company>Rate based on Company field</determine_by_company>
  </values>
</resource>

{
    "properties": {
        "message": "The values listed here are the correct values for the Store checkout_type field. The values are listed in the format value => description.",
        "values": {
            "default_account": "Allow guest and customer accounts, default to account",
            "default_guest": "Allow guest and customer accounts, default to guest",
            "account_only": "Allow customer accounts only",
            "guest_only": "Allow guests only"
        }
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/property_helpers/checkout_types"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/property_helpers"
            ],
            "href": "https://api.foxycart.com/property_helpers"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.