Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Locations

Create or update location by external ID

Idempotent upsert keyed on the external ID in the path. If a location has this external ID, it will be updated (and undeleted, if the location was previously deleted). Otherwise, a new location will be created with this external ID.

patch/locations/external/{externalId}

Path parameters

externalIdstring required

External ID of the location

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
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

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
  ]
}

Response

Successfully updated location

Example response

{
  "location": {
    "id": 963,
    "name": "Warehouses",
    "description": "The warehouse where we store the forklifts",
    "address": "1090 main street, Franklin",
    "barcode": "BWFPBNRHAW54CG",
    "parentId": 852,
    "childrenIds": [
      342,
      521
    ],
    "thumbnail": {
      "id": 12345,
      "mimeType": "image/png",
      "fileName": "image.png",
      "url": "http://example.com/image.png",
      "createdAt": "2022-01-01T00:00:00.000Z",
      "width": 220,
      "height": 100
    },
    "attachments": [
      {
        "id": 12345,
        "mimeType": "image/png",
        "fileName": "image.png",
        "url": "http://example.com/image.png",
        "createdAt": "2022-01-01T00:00:00.000Z",
        "width": 220,
        "height": 100
      }
    ],
    "extraFields": {
      "Department": "Electrical"
    },
    "teamIds": [
      2
    ],
    "vendorIds": [
      2
    ],
    "createdAt": "2022-01-01T00:00:00.000Z",
    "updatedAt": "2022-01-01T00:00:00.000Z",
    "externalId": "ext-location-001"
  }
}