States

Represents a state belonging to a physical address. This object is used by the Customer API.

State object

Attributes

Attributes
id string Unique object's identifier.
code string ISO or local code determined.
country string Country ID the state belongs to.
name string Name of the state.

State object

{
    "id": "US-CA",
    "code": "CA",
    "country": "US",
    "name": "California"
}

See the complete list of states available in Piriod

List states

GET https://api.piriod.com/generals/states/

Lists states objects. Learn more about pagination and filtering.

Query Parameters

Name	Type	Description
country	string	ID string of a particular country or multiple countries (using __in filter operator)
name	string	Exact or snippet of the currency name (using __exact, __contains or __icontains operators)

200 A list of states.

{
  "count": 26,
  "next": null,
  "previous": null,
  "results": [
    {
      "id": "US-CA",
      "code": "CA",
      "country": "US",
      "name": "California",
    },
    {
      "id": "US-NC",
      "code": "NC",
      "country": "US",
      "name": "Carolina del Norte"
    },
    ...
    ...
    ...
    {
      "id": "US-OH",
      "code": "OH",
      "country": "US",
      "name": "Ohio"
    },
    {
      "id": "US-OK",
      "code": "OK",
      "country": "US",
      "name": "Oklahoma"
    }
  ]
}