Locations

You can use data from the Locations endpoints to get information on a geographic location where Product inventory is held.

Overview

The Locations datatype holds information on geographical locations at which stocks of products may be held, as referenced in the Products datatype

From the Locations endpoints you can retrieve:

  • A list of all the Locations of a commerce company: GET/companies/{companyId}/connections/{connectionId}/data/commerce-locations.
  • The details of an individual location:
    GET /companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}.

Data model

Field

Type

Decription

id

string

Unique identifier for the location.

name

string

Name of the location.

address

address

Addresses of the location.

modifiedDate

string
See date

Date the location details were last updated in the Codat system.

sourceModifiedDate

string
See date

Date the location details were last changed in the commerce or point of sale platform.

Address

Address details for a location.

Field

Type

Description

addressType

string

Type of location address:
billing — billing address
delivery — delivery address
inventory — address of a location where inventory is held

line1

string

First line of the location address.

line2

string

Second line of the location address.

city

string

City of the location address.

region

string

Region of the location address.

country

string

Country of the location address.

postalCode

string

Postal code or zip code of the location address.

Example data

{
    "id": "15",
    "name": "London Warehouse",
    "address": {
        "type": "Inventory"
        "line1": "Warner House",
        "line2": "98 Theobald's Road",
        "city": "London",
        "region": "",
        "country": "United Kingdom",
        "postalCode": "WC1X 8WB"
    },
        "modifiedDate":null,
        "sourceModifiedDate":"2020-08-12T14:37:37"
}

Did this page help you?