Country
GET
Retrieve countries by conditions
_cnd[substring]
string
Retrieve country by substring
_cnd[hasStates]
boolean
Retrieve only countries with states
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Model\Country>[] array
Sample response
[{"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>"}]
_cnd[substring]
string
Retrieve country by substring
_cnd[hasStates]
boolean
Retrieve only countries with states
_cnd[limit]
array
Sets the offset (first item) and the limit (second item)
_cnd[orderBy]
array
Sets sorting order field
default Success <XLite\Model\Country>[] array
Sample response
[{"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>"}]
GET
Retrieve country by id
id
integer Required
Id value of the Country object
default Success <XLite\Model\Country>
Sample response
{"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>"}
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
[] array
States (relation)
regions
[] array
Regions (relation)
currency
id
integer Required
Id value of the Country object
default Success <XLite\Model\Country>
Sample response
{"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>"}
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
States (relation)
regions
Regions (relation)
currency
PUT
Update country by id
id
integer Required
Id value of the Country object
<XLite\Model\Country>
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
[] array
States (relation)
regions
[] array
Regions (relation)
currency
[] array
States (relation)
regions
[] array
Regions (relation)
currency
id
integer Required
Id value of the Country object
<XLite\Model\Country>
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
States (relation)
regions
Regions (relation)
currency
default Success <XLite\Model\Country>
Sample response
{"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>"}
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
States (relation)
regions
Regions (relation)
currency
DELETE
Delete country by id
id
integer Required
Id value of the Country object
default Success <XLite\Model\Country>
Sample response
{"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>"}
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
[] array
States (relation)
regions
[] array
Regions (relation)
currency
id
integer Required
Id value of the Country object
default Success <XLite\Model\Country>
Sample response
{"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>"}
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
States (relation)
regions
Regions (relation)
currency
POST
Add new country
<XLite\Model\Country>
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
[] array
States (relation)
regions
[] array
Regions (relation)
currency
[] array
States (relation)
regions
[] array
Regions (relation)
currency
<XLite\Model\Country>
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
States (relation)
regions
Regions (relation)
currency
default Success <XLite\Model\Country>
Sample response
{"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>"}
code
string
Country code (ISO 3166-1 alpha-2)
id
integer
Id
code3
string
Country code (ISO 3166-1 alpha-3)
enabled
boolean
Enabled falg
states
States (relation)
regions
Regions (relation)
currency