Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Locations

Create new location

post/locations

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required
descriptionstring nullable
addressstring nullable

Postal address of the location

barcodestring nullable

String encoded barcode

parentIdinteger nullable

ID of the parent location

extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Department")

vendorIdsnumber[]

Vendor IDs

externalIdstring nullable

External ID for this location, unique per organization.

Example request

{
  "name": "Warehouses",
  "description": "The warehouse where we store the forklifts",
  "address": "1090 main street, Franklin",
  "barcode": "BWFPBNRHAW54CG",
  "parentId": 852,
  "extraFields": {
    "Department": "Electrical"
  },
  "vendorIds": [
    2
  ],
  "externalId": "ext-location-001"
}

Response

Successfully created location

idinteger required

Global ID of the location

Example response

{
  "id": 963
}