Heartwork Commerce API

Accounts

Endpointhttps://api.heart.work

Download schema

Fetches a single account, for the current logged in user.

GET

https://api.heart.work

/commerce-api/accounts/current

Fetches a single account, for the current logged in user. › Responses

displayName

string · required

object[] · required

externalReference

string

object

GET/commerce-api/accounts/current

curl --request GET \
  --url https://api.heart.work/commerce-api/accounts/current

shell

Example Responses

{
  "displayName": "displayName",
  "externalReference": "externalReference",
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    ]
  }
}

plain

Adds an address to an account.

POST

https://api.heart.work

/commerce-api/accounts/current/addresses

On success, returns the updated entity in the response.

Adds an address to an account. › Request Body

addressType

string

street

string

zipCode

string

city

string

country

string

Adds an address to an account. › Responses

No data returned

POST/commerce-api/accounts/current/addresses

curl --request POST \
  --url https://api.heart.work/commerce-api/accounts/current/addresses \
  --header 'Content-Type: application/json' \
  --data '
{
  "addressType": "addressType",
  "street": "street",
  "zipCode": "zipCode",
  "city": "city",
  "country": "country"
}
'

shell

Example Request Body

{
  "addressType": "addressType",
  "street": "street",
  "zipCode": "zipCode",
  "city": "city",
  "country": "country"
}

json

Example Responses

No example specified for this content type

Auth

Heartwork Commerce API

Accounts

Endpointhttps://api.heart.work

Download schema

Fetches a single account, for the current logged in user.

GET

https://api.heart.work

/commerce-api/accounts/current

Fetches a single account, for the current logged in user. › Responses

displayName

string · required

object[] · required

externalReference

string

object

GET/commerce-api/accounts/current

curl --request GET \
  --url https://api.heart.work/commerce-api/accounts/current

shell

Example Responses

{
  "displayName": "displayName",
  "externalReference": "externalReference",
  "shippingAddress": {
    "addressType": "addressType",
    "street": "street",
    "zipCode": "zipCode",
    "city": "city",
    "country": "country"
  },
  "otherAddresses": [
    {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    }
  ],
  "commerceSettings": {
    "priceSettings": {
      "showSalesPrice": true,
      "showCustomerPrice": true,
      "showSuggestedRetailPrice": true
    },
    "locations": [
      {
        "id": "id",
        "name": "name",
        "type": "type"
      }
    ]
  }
}

plain

Adds an address to an account.

POST

https://api.heart.work

/commerce-api/accounts/current/addresses

On success, returns the updated entity in the response.

Adds an address to an account. › Request Body

addressType

string

street

string

zipCode

string

city

string

country

string

Adds an address to an account. › Responses

No data returned

POST/commerce-api/accounts/current/addresses

curl --request POST \
  --url https://api.heart.work/commerce-api/accounts/current/addresses \
  --header 'Content-Type: application/json' \
  --data '
{
  "addressType": "addressType",
  "street": "street",
  "zipCode": "zipCode",
  "city": "city",
  "country": "country"
}
'

shell

Example Request Body

{
  "addressType": "addressType",
  "street": "street",
  "zipCode": "zipCode",
  "city": "city",
  "country": "country"
}

json

Example Responses

No example specified for this content type

Auth