API endpoints > clients > client > post

JSON data structure

• ActiveBooleanrequiredIs this client active?
• InactiveReasonStringa (small) tekst about deactivation of the client.
• NameStringrequiredMinimum length: 1The client name
• TimezoneTimezonerequired (type 12 min): 1A valid timezone name where this client is based in
• AddresssublistThe client's address. This is mandatory only when pre-alerting and creating labels through this API. If you do not, then this can be ignored.
  • CityStringrequiredMinimum length: 2, maximum length: 50Cityname
  • CompanyNameStringMinimum length: 1, maximum length: 100Optional company name
  • CountryCountryrequiredMinimum length: 2, maximum length: 3Country, iso3 format
  • EmailE-mailMinimum length: 2, maximum length: 100Email address (required for some carriers)
  • HouseNumberInteger numberMinimum value: 1Housenumber
  • NameStringrequiredMinimum length: 1, maximum length: 100Person name
  • NeighborhoodStringMaximum length: 50Neighborhood/community
  • NumberExtensionStringHousenumber extension (floor, a, etc.)
  • PhoneStringMinimum length: 5, maximum length: 20Phone number (required for some carriers)
  • PostalCodeStringrequiredMinimum length: 3, maximum length: 15Postalcode
  • StateStringMinimum length: 2, maximum length: 50State/province name (required in some countries)
  • Streetname1StringrequiredMinimum length: 3, maximum length: 100Street name line 1 (can include housenumber if not defined in HouseNumber)
  • Streetname2StringMaximum length: 100Street name line 2, not supported by all carriers!
• CompanyContactsublistrequiredA contact person in the company
  • EmailE-mailrequiredMinimum length: 1The client contact email address
  • NameStringrequiredMinimum length: 1The client contact name
  • PhonePhonenumberrequiredMinimum length: 1(direct) phone numer to reach the company contact
• CustomssublistCustoms information. This is mandatory only if labels are created using this API and shipments are crossing customs borders.
  • EoriEUStringMinimum length: 3, maximum length: 100EU Eori number
  • EoriUKStringMinimum length: 3, maximum length: 100UK Eori number
  • VATUKStringMinimum length: 3, maximum length: 100UK VAT number
• Optionssublistoverall client settings, make sure that when you patch a client, that the full list is provided, since this will overwrite all existing options.
  • DefaultCountryCountrySets the default country to send to (used for manual entry using the APP).
  • LabelZPLBooleanIf set, ZPL code is generated for the labels instead of creating a PDF. Any carrier not able to do so will be ignored.
  • MaxConcurrentProcessInteger numberMinimum value: 1, maximum value: 5For certain types of processes such as label creation etc. this sets the maximum number of concurrent processes that this client can run.
  • RulebookActiveBooleanDetermines if the rulebook is executed during shipment imports in the shipments endpoint
  • ZipcodeAddressBooleanIf set, the address street and city is set to the official registered names for the given zipcode, if possible
  • ZipcodeValidationBooleanIf set, the address is compared to the zipcode values. If not correct an error is thrown (unless ZipcodeAddress is set)

JSON reply data

• ClientIdStringAlways returnedMinimum length: 1The internal client id for the new client
• ErrorListArray of objectsList of errors, to clarify the Error if possible
  • IdInteger numberAlways returnedMaximum value: 999The error id, see the error list
  • TekstStringAlways returnedMaximum length: 255Textual error for detailed information