Skip to content

Location

Location refers to the physical address of the account.

Properties of a location

  • * street: Street name.
  • house number: House number as an integer value. Ex: 1, 17.
  • house number addition: Any additional information to be attached to the house number, usually letters when the house number is not unique per street.
  • * postal code: The postal code should be valid for the country.
  • * city: Name of the city.
  • area code: Area code. Most likely every city has a unique area code. However that depends on each country. If there are multiple area codes for the city in the location, please select one. The area code is required to redirect emergency calls to the proper destination.
  • * country iso: ISO 3166-1 alpha-2 representation of the country, in lowercase. Ex: "nl", "de", "es", "fr"
  • * category: The category of location. Available types are: "postal" and "postbox".

The postal location is considered as the location where company is registered/located, and a postbox location if exist.

The postal location is mandatory, therefore is not possible to be deleted.

Only one location per type is supported.

The house number is mandatory based on the country. For England it is not mandatory. For all other countries it is.

The prefix * in the items listed above means they are mandatory.

Available features

  • List all locations of an account
  • Add locations to account
  • View details of location
  • Update details of location
  • Delete location

Examples

List all locations of an account
sequenceDiagram Actor->>Administration API: GET accounts owned by supplier Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/account/overviewUsingGET" "Swagger documentation" Administration API-->>Actor: Use the account id of an specific account Actor->>Administration API: GET locations that belong to the account selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/overviewUsingGET_5" "Swagger documentation" Administration API-->>Actor: OK!
Add locations to account
sequenceDiagram Actor->>Administration API: GET accounts owned by supplier Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/account/overviewUsingGET" "Swagger documentation" Administration API-->>Actor: Use the account id of an specific account Actor->>Administration API: Add location to the account selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/createUsingPOST_4" "Swagger documentation" Administration API-->>Actor: CREATED!
View details of location
sequenceDiagram Actor->>Administration API: GET locations that belong to an account Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/overviewUsingGET_5" "Swagger documentation" Administration API-->>Actor: Use the location id of an specific location! Actor->>Administration API: View details of the location selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/detailsUsingGET_3" "Swagger documentation" Administration API-->>Actor: OK!
Update details of location
sequenceDiagram Actor->>Administration API: GET locations that belong to an account Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/overviewUsingGET_5" "Swagger documentation" Administration API-->>Actor: Use the location id of an specific location! Actor->>Administration API: Update details of the location selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/updateUsingPUT_3" "Swagger documentation" Administration API-->>Actor: OK!
Delete location
sequenceDiagram Actor->>Administration API: GET locations that belong to an account Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/overviewUsingGET_5" "Swagger documentation" Administration API-->>Actor: Use the location id of an specific location! Actor->>Administration API: Delete the location selected before Note right of Administration API: See "https://api.host.url/webjars/swagger-ui/index.html?configUrl=/swagger-config.json#/location/deleteUsingDELETE_1" "Swagger documentation" Administration API-->>Actor: OK!