Heartwork Commerce API

PickupLocations

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all PickupLocations, for the provided workspace

GET

https://api.heart.work

/commerce-api/catalog/pickuplocations

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

take

integer · int32

For paged querying, the amount of records to take (defaults to 100)

skip

integer · int32

For paged querying, the amount of records to skip (defaults to 0)

sort_order

string · enum

For sorting data, the direction to sort in (defaults to Ascending)

Enum values:

Asc

Desc

sort_by

string · enum

For sorting data, the name of the property used to sort by

Enum values:

Name

DisplayOrder

q

string

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

200

object[] · required

total

integer · int32 · required

GET/commerce-api/catalog/pickuplocations

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/pickuplocations

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": "opensAt",
          "closesAt": "closesAt"
        }
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "total": 0
}

plain

Fetches a single PickupLocation, by id.

GET

https://api.heart.work

/commerce-api/catalog/pickuplocations/{id}

Fetches a single PickupLocation, by id. › path Parameters

id

string · required

Unique id of the PickupLocation to fetch.

Fetches a single PickupLocation, 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/commerce-api/catalog/pickuplocations/{id}

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/pickuplocations/: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": "opensAt",
      "closesAt": "closesAt"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Languages ProductCategories

Heartwork Commerce API

PickupLocations

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all PickupLocations, for the provided workspace

GET

https://api.heart.work

/commerce-api/catalog/pickuplocations

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

take

integer · int32

For paged querying, the amount of records to take (defaults to 100)

skip

integer · int32

For paged querying, the amount of records to skip (defaults to 0)

sort_order

string · enum

For sorting data, the direction to sort in (defaults to Ascending)

Enum values:

Asc

Desc

sort_by

string · enum

For sorting data, the name of the property used to sort by

Enum values:

Name

DisplayOrder

q

string

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

200

object[] · required

total

integer · int32 · required

GET/commerce-api/catalog/pickuplocations

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/pickuplocations

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": "opensAt",
          "closesAt": "closesAt"
        }
      ],
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ]
    }
  ],
  "total": 0
}

plain

Fetches a single PickupLocation, by id.

GET

https://api.heart.work

/commerce-api/catalog/pickuplocations/{id}

Fetches a single PickupLocation, by id. › path Parameters

id

string · required

Unique id of the PickupLocation to fetch.

Fetches a single PickupLocation, 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/commerce-api/catalog/pickuplocations/{id}

curl --request GET \
  --url https://api.heart.work/commerce-api/catalog/pickuplocations/: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": "opensAt",
      "closesAt": "closesAt"
    }
  ],
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ]
}

plain

Languages ProductCategories