Orders

Create order

To create an order, you need to use the access_token that you previously obtained.

Take a look at our Swagger documentation for the API here.

Send a POST request to https://beta-api.ambita.com/kode/v1/orders/[cadastre|share|map]

Example request

curl -s \
      -H "Content-Type: application/json" \
      -H "Authorization: Bearer ej577asf-a5k6-42yq-a3a2-fh03hb8cb58c" \
      https://beta-api.ambita.com/kode/v1/orders/cadastre -d "
        {
                \"deliveryInformation\": {
                  // delivery information object
                },
                \"orderData\": {
                  \"address\": \"Infoveien 1, 9999 Infoland\",
                  \"cadastre\": \"9999-1-1-0-0\"
                },
                \"products\": [
                  {
                    \"code\": \"WI99990033\"
                  }
                ],
                \"reference\": \"some-reference\",
                \"technicalReference\": \"some-technical-reference\"
        }"

JSON body structure

Property	Description

Property	Description
`deliveryInformation`*	Object that includes information related to delivery of the products, see section below
`orderData`	Order data required to order the products specified which will differ based on the type of product being ordered between cadastre, share, map products, see section below
`reference`	This reference is used to connect multiple orders to one reference, usually an assignment key and commonly used for billing reference
`technicalReference`*	This reference is used to reference an order in our system, to a unique id in your system, good for debugging and lookups
`products`	Array of objects, see section below

* indicates optional fields

deliveryInformation object

Property	Description

Property	Description
`address`*	Address line
`address2`*	Address line 2
`address3`*	Address line 3
`alias`*	Alias
`companyName`*	Company name
`email`*	Email
`name`*	Name
`phone`*	Phone
`postalCode`*	Postal code

* indicates optional fields

orderData object

Property	Description

Property	Description
For ordering cadastre products, see example below
`address`	Important to use this format `{Street address}, {Postal code} {Postal place}`, for example, `Infoveien 1, 9999 Infoland`
`cadastre`	Cadastre should always include all required parts `{Kommunenummer}-{Gårdsnummer}-{Bruksnummer}-{Festenummer}-{Seksjonsnummer}`, for example, `0301-100-10-0-0`
For ordering share products, see example below
`organizationNumber`	Organization number
`shareNumber`	The id of the owner's right of occupation in the cooperative
For ordering map products, see example below
`geometry`	A closed GeoJSON polygon specified in ETRS89 / UTM zone 33N or ETRS89 / UTM zone 32N
`spatialReference`	Spatial reference the `geometry` is specified in either 25833 or 25832

Example cadastre products orderData

"orderData": {
  "address": "Infoveien 1, 9999 Infoland",
  "cadastre": "9999-1-1-0-0"
}

Example share products orderData

"orderData": {
  "organizationNumber": 988424587,
  "shareNumber": 136
}

Example map products orderData

products array of objects

Property	Description

Property	Description
`code`	Use products API to find correct product codes in given municipality
`data`*	Additional data required to order a specific product that varies based on a product, see example below

* indicates optional fields

Example map products array with additional data

Example response

Get order

To get an order, you need to use the access_token that you previously obtained.

Take a look at our Swagger documentation for the API here.

Send a GET request to https://beta-api.ambita.com/kode/v1/orders/1234567

Example request

Example response