commerce/shipping/admin/profiles/ShippingStates

Use the ShippingStates sub-resource to manage the states your shipping profile supports. For example, you can specify one of your shipping profiles to only support Texas, Oklahoma, Arkansas, Louisiana, and New Mexico.

Each shipping state is composed of a user-definied code and name.

JSON Example

ShippingStates Properties

Property Description
countryCode

type: string

The 2-letter geographic code representing the country for the physical or mailing address. Currently limited to the US.

states

type: list of state

The states of the shipping profile.

state.code

type: string

The unique identifier of the object.

state.name

type: string

The user supplied name that appears in Admin. You can use this field for identification purposes.

Operations

Operation Name Request URI Description
GetStates GET %7bprofilecode%7d%2fshippingstates

Retrieves a list of shipping states and their details.

UpdateStates PUT %7bprofilecode%7d%2fshippingstates

Updates the details of the shipping states.