Heartwork API

Locations

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all locations, for the provided workspace

GET

https://api.heart.work

/core-api/inventory/locations

Fetches a collection of all locations, for the provided workspace › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

DisplayOrder

Query

string

ids

string[]

external_references

string[]

is_warehouse

boolean

is_pickup_location

boolean

is_stock_location

boolean

Fetches a collection of all locations, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/inventory/locations

curl --request GET \
  --url https://api.heart.work/core-api/inventory/locations

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "email": "email",
      "name": "name",
      "description": "description",
      "phoneNumber": "phoneNumber",
      "image": "image",
      "displayOrder": 0,
      "address": {
        "addressType": "addressType",
        "street": "street",
        "zipCode": "zipCode",
        "city": "city",
        "country": "country"
      },
      "isWarehouse": true,
      "isPickupLocation": true,
      "isStockLocation": true,
      "openingTimes": [
        {
          "dayOfWeek": "Sunday",
          "opensAt": "00:00:00",
          "closesAt": "00:00:00"
        }
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new location.

POST

https://api.heart.work

/core-api/inventory/locations

On success, returns the newly created entity in the response.

Creates and stores a new location. › Request Body

name

string · required

displayOrder

integer · int32 · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

object

object[]

Creates and stores a new location. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

displayOrder

integer · int32 · required

object · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

object[] · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

POST/core-api/inventory/locations

curl --request POST \
  --url https://api.heart.work/core-api/inventory/locations \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Fetches a single location, by id.

GET

https://api.heart.work

/core-api/inventory/locations/{id}

Fetches a single location, by id. › path Parameters

id

string · required

Unique id of the location to fetch.

Fetches a single location, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

displayOrder

integer · int32 · required

object · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

object[] · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

GET/core-api/inventory/locations/{id}

curl --request GET \
  --url https://api.heart.work/core-api/inventory/locations/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Updates an existing location, replacing it entirely.

PUT

https://api.heart.work

/core-api/inventory/locations/{id}

On success, returns the updated entity in the response.

Updates an existing location, replacing it entirely. › path Parameters

id

string · required

Updates an existing location, replacing it entirely. › Request Body

name

string · required

displayOrder

integer · int32 · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

id

string · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

object

object[]

Updates an existing location, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

displayOrder

integer · int32 · required

object · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

object[] · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

PUT/core-api/inventory/locations/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/inventory/locations/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Deletes an existing location, by id.

DELETE

https://api.heart.work

/core-api/inventory/locations/{id}

Deletes an existing location, by id. › path Parameters

id

string · required

Unique id of the location to delete.

Deletes an existing location, by id. › Responses

No data returned

DELETE/core-api/inventory/locations/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/inventory/locations/:id

shell

Example Responses

No example specified for this content type

Upload file to the cdn for locations, images have to be added to the locations afterwards

POST

https://api.heart.work

/core-api/inventory/locations/images

Upload file to the cdn for locations, images have to be added to the locations afterwards › Request Body

images

string[]

The images to upload

Upload file to the cdn for locations, images have to be added to the locations afterwards › Responses

fileUris

string[] · required

POST/core-api/inventory/locations/images

curl --request POST \
  --url https://api.heart.work/core-api/inventory/locations/images \
  --header 'Content-Type: multipart/form-data' \
  --form images=string

shell

Example Request Body

{
  "images": [
    "string"
  ]
}

json

Example Responses

{
  "fileUris": [
    "https://www.example.com/path/to/resource"
  ]
}

plain

Languages Pipelines

Heartwork API

Locations

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all locations, for the provided workspace

GET

https://api.heart.work

/core-api/inventory/locations

Fetches a collection of all locations, for the provided workspace › query Parameters

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

Name

DisplayOrder

Query

string

ids

string[]

external_references

string[]

is_warehouse

boolean

is_pickup_location

boolean

is_stock_location

boolean

Fetches a collection of all locations, for the provided workspace › Responses

object[] · required

total

integer · int32 · required

GET/core-api/inventory/locations

curl --request GET \
  --url https://api.heart.work/core-api/inventory/locations

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "email": "email",
      "name": "name",
      "description": "description",
      "phoneNumber": "phoneNumber",
      "image": "image",
      "displayOrder": 0,
      "address": {
        "addressType": "addressType",
        "street": "street",
        "zipCode": "zipCode",
        "city": "city",
        "country": "country"
      },
      "isWarehouse": true,
      "isPickupLocation": true,
      "isStockLocation": true,
      "openingTimes": [
        {
          "dayOfWeek": "Sunday",
          "opensAt": "00:00:00",
          "closesAt": "00:00:00"
        }
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new location.

POST

https://api.heart.work

/core-api/inventory/locations

On success, returns the newly created entity in the response.

Creates and stores a new location. › Request Body

name

string · required

displayOrder

integer · int32 · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

object

object[]

Creates and stores a new location. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

displayOrder

integer · int32 · required

object · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

object[] · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

POST/core-api/inventory/locations

curl --request POST \
  --url https://api.heart.work/core-api/inventory/locations \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Fetches a single location, by id.

GET

https://api.heart.work

/core-api/inventory/locations/{id}

Fetches a single location, by id. › path Parameters

id

string · required

Unique id of the location to fetch.

Fetches a single location, by id. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

displayOrder

integer · int32 · required

object · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

object[] · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

GET/core-api/inventory/locations/{id}

curl --request GET \
  --url https://api.heart.work/core-api/inventory/locations/:id

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Updates an existing location, replacing it entirely.

PUT

https://api.heart.work

/core-api/inventory/locations/{id}

On success, returns the updated entity in the response.

Updates an existing location, replacing it entirely. › path Parameters

id

string · required

Updates an existing location, replacing it entirely. › Request Body

name

string · required

displayOrder

integer · int32 · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

id

string · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

object

object[]

Updates an existing location, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

name

string · required

displayOrder

integer · int32 · required

object · required

isWarehouse

boolean · required

isPickupLocation

boolean · required

isStockLocation

boolean · required

object[] · required

externalReference

string

email

string

description

string

phoneNumber

string

image

string

PUT/core-api/inventory/locations/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/inventory/locations/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "email": "email",
  "name": "name",
  "description": "description",
  "phoneNumber": "phoneNumber",
  "image": "image",
  "displayOrder": 0,
  "address": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "isWarehouse": true,
  "isPickupLocation": true,
  "isStockLocation": true,
  "openingTimes": [
    {
      "dayOfWeek": "Sunday",
      "opensAt": "00:00:00",
      "closesAt": "00:00:00"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Deletes an existing location, by id.

DELETE

https://api.heart.work

/core-api/inventory/locations/{id}

Deletes an existing location, by id. › path Parameters

id

string · required

Unique id of the location to delete.

Deletes an existing location, by id. › Responses

No data returned

DELETE/core-api/inventory/locations/{id}

curl --request DELETE \
  --url https://api.heart.work/core-api/inventory/locations/:id

shell

Example Responses

No example specified for this content type

Upload file to the cdn for locations, images have to be added to the locations afterwards

POST

https://api.heart.work

/core-api/inventory/locations/images

Upload file to the cdn for locations, images have to be added to the locations afterwards › Request Body

images

string[]

The images to upload

Upload file to the cdn for locations, images have to be added to the locations afterwards › Responses

fileUris

string[] · required

POST/core-api/inventory/locations/images

curl --request POST \
  --url https://api.heart.work/core-api/inventory/locations/images \
  --header 'Content-Type: multipart/form-data' \
  --form images=string

shell

Example Request Body

{
  "images": [
    "string"
  ]
}

json

Example Responses

{
  "fileUris": [
    "https://www.example.com/path/to/resource"
  ]
}

plain

Languages Pipelines