Developers
API referenceBusiness sign in

Schema

Market

A live market. Cross-border shipping is not offered: origin, destination and Business are always in one market.

Fields

Market fields
FieldTypeDescription
codeRequiredMarketCodeTwo-letter market (country network) code. Ghana (GH) is live; each market is a separate domestic network.
nameRequiredstring
statusRequiredenumOne of LIVE
timezoneRequiredstringIANA time zone for dates and cut-offs.
currencyRequiredobject
codeRequiredstring
minorUnitRequiredintegerDigits after the decimal point; amounts are integers in this minor unit.
symbolRequiredstring
localesRequiredarray of string
defaultLocaleRequiredstring
phoneRequiredobject
countryCodeRequiredstring
nationalLengthRequiredinteger
trunkPrefixOptionalstring or null
exampleRequiredstring
identityDocumentsOptionalarray of object
typeRequiredstring
nameRequiredstring
addressOptionalobject
fieldsRequiredarray of string
postcodeOptionalobject or null
nameRequiredstring
requiredRequiredboolean
supportOptionalobject
emailOptionalstring or null
phoneOptionalstring or null
whatsappOptionalstring or null
hoursOptionalstring or null
productsRequiredarray of ServiceCodeProducts sold in the market.

Used by