GET
Retrieve regions by conditions
_path=region

_cnd[limit]
array 
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array 
Sets sorting order field
default Success <XLite\Model\Region>[] array
Sample response
[{"code":"example","name":"example","weight":51,"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"},"states":[{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}]}]

GET
Retrieve region by id
_path=region/{id}

id
integer Required
Id value of the Region object
default Success <XLite\Model\Region>
Sample response
{"code":"example","name":"example","weight":51,"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"},"states":[{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}]}
code
string
Region code
name
string
Region name
weight
integer
Region weight
country
states
[] array
States (relation)

PUT
Update region by id
_path=region/{id}

id
integer Required
Id value of the Region object
<XLite\Model\Region>
code
string
Region code
name
string
Region name
weight
integer
Region weight
country
states
[] array
States (relation)
default Success <XLite\Model\Region>
Sample response
{"code":"example","name":"example","weight":51,"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"},"states":[{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}]}
code
string
Region code
name
string
Region name
weight
integer
Region weight
country
states
[] array
States (relation)

DELETE
Delete region by id
_path=region/{id}

id
integer Required
Id value of the Region object
default Success <XLite\Model\Region>
Sample response
{"code":"example","name":"example","weight":51,"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"},"states":[{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}]}
code
string
Region code
name
string
Region name
weight
integer
Region weight
country
states
[] array
States (relation)

POST
Add new region
_path=region/0

<XLite\Model\Region>
code
string
Region code
name
string
Region name
weight
integer
Region weight
country
states
[] array
States (relation)
default Success <XLite\Model\Region>
Sample response
{"code":"example","name":"example","weight":51,"country":{"restrictions":"<XLite\\Module\\XC\\PitneyBowes\\Model\\ProductRestriction>[] array","code":"string","id":"integer","code3":"string","enabled":"boolean","states":"<XLite\\Model\\State>[] array","regions":"<XLite\\Model\\Region>[] array","currency":"<XLite\\Model\\Currency>"},"states":[{"state_id":"integer","state":"string","code":"string","country":"<XLite\\Model\\Country>","region":"<XLite\\Model\\Region>"}]}
code
string
Region code
name
string
Region name
weight
integer
Region weight
country
states
[] array
States (relation)