Heartwork Commerce API

SalesOrders

Endpointhttps://api.heart.work

Download schema

Fetches a single sales order, by id.

GET

https://api.heart.work

/commerce-api/salesorders/{id}

Fetches a single sales order, by id. › path Parameters

id

string · required

Unique id of the sales order to fetch.

Fetches a single sales order, by id. › Responses

id

string · required

orderNumber

string · required

channel

string · required

orderedAt

string · date-time · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

object · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

object[] · required

object

externalReference

string

description

string

object

GET/commerce-api/salesorders/{id}

curl --request GET \
  --url https://api.heart.work/commerce-api/salesorders/:id

shell

Example Responses

{
  "id": "id",
  "orderNumber": "orderNumber",
  "channel": "channel",
  "orderedAt": "2024-08-25T15:00:00Z",
  "deliveryMethod": "Delivery",
  "processing": {
    "status": "Open"
  },
  "orderingStatus": "Draft",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    }
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "externalReference": "externalReference",
  "description": "description",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "location": {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  },
  "orderLines": [
    {
      "id": "id",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "quantity": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "status": "status",
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        }
      }
    }
  ]
}

plain

GET

https://api.heart.work

/commerce-api/salesorders/order-number/{orderNumber}

path Parameters

orderNumber

integer · int32 · required

Responses

id

string · required

orderNumber

string · required

channel

string · required

orderedAt

string · date-time · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

object · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

object[] · required

object

externalReference

string

description

string

object

GET/commerce-api/salesorders/order-number/{orderNumber}

curl --request GET \
  --url https://api.heart.work/commerce-api/salesorders/order-number/:orderNumber

shell

Example Responses

{
  "id": "id",
  "orderNumber": "orderNumber",
  "channel": "channel",
  "orderedAt": "2024-08-25T15:00:00Z",
  "deliveryMethod": "Delivery",
  "processing": {
    "status": "Open"
  },
  "orderingStatus": "Draft",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    }
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "externalReference": "externalReference",
  "description": "description",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "location": {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  },
  "orderLines": [
    {
      "id": "id",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "quantity": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "status": "status",
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        }
      }
    }
  ]
}

plain

Fetches a collection of all sales orders, filtered by the input

GET

https://api.heart.work

/commerce-api/salesorders

Fetches a collection of all sales orders, filtered by the input › 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:

OrderNumber

OrderedAt

q

string

ordered_by_ids

string[]

Fetches a collection of all sales orders, filtered by the input › Responses

object[] · required

total

integer · int32 · required

GET/commerce-api/salesorders

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "orderNumber": "orderNumber",
      "channel": "channel",
      "orderedAt": "2024-08-25T15:00:00Z",
      "deliveryMethod": "Delivery",
      "processing": {
        "status": "Open"
      },
      "orderingStatus": "Draft",
      "references": {
        "customer": "customer",
        "destination": "destination",
        "project": "project"
      },
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        }
      },
      "orderedBy": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "orderLineStatuses": [
        {
          "key": "key",
          "value": 0
        }
      ],
      "externalReference": "externalReference",
      "description": "description",
      "delivery": {
        "status": "Open",
        "address": {
          "addressType": "addressType",
          "street": "street",
          "zipCode": "zipCode",
          "city": "city",
          "country": "country"
        },
        "attendeeName": "attendeeName",
        "comments": "comments"
      },
      "pickup": {
        "status": "Open",
        "comments": "comments",
        "location": {
          "id": "id",
          "name": "name",
          "type": "type"
        }
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new sales order.

POST

https://api.heart.work

/commerce-api/salesorders

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

Creates and stores a new sales order. › Request Body

channel

string · required

object · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

externalReference

string

description

string

currency

string

object

Creates and stores a new sales order. › Responses

id

string · required

orderNumber

string · required

POST/commerce-api/salesorders

curl --request POST \
  --url https://api.heart.work/commerce-api/salesorders \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "channel",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "externalReference": "externalReference",
  "description": "description",
  "currency": "currency",
  "deliveryMethod": "Delivery",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "locationId": "locationId"
  }
}
'

shell

Example Request Body

{
  "channel": "channel",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "externalReference": "externalReference",
  "description": "description",
  "currency": "currency",
  "deliveryMethod": "Delivery",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "locationId": "locationId"
  }
}

json

Example Responses

{
  "id": "id",
  "orderNumber": "orderNumber"
}

plain

Updates the status of an existing sales order

PUT

https://api.heart.work

/commerce-api/salesorders/{id}/ordering-status

On success, returns the updated entity in the response.

Updates the status of an existing sales order › path Parameters

id

string · required

Updates the status of an existing sales order › query Parameters

status

string · enum

Enum values:

Draft

Completed

Canceled

Updates the status of an existing sales order › Responses

No data returned

PUT/commerce-api/salesorders/{id}/ordering-status

curl --request PUT \
  --url https://api.heart.work/commerce-api/salesorders/:id/ordering-status

shell

Example Responses

No example specified for this content type

Adds new sales order lines to a sales order.

POST

https://api.heart.work

/commerce-api/salesorders/{id}/lines

Adds new sales order lines to a sales order. › path Parameters

id

string · required

Adds new sales order lines to a sales order. › Request Body

object[]

quantity

number · double · required

productId

string · required

object[]

Adds new sales order lines to a sales order. › Responses

No data returned

POST/commerce-api/salesorders/{id}/lines

curl --request POST \
  --url https://api.heart.work/commerce-api/salesorders/:id/lines \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "quantity": 0,
    "productId": "productId",
    "attributes": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  }
]
'

shell

Example Request Body

[
  {
    "quantity": 0,
    "productId": "productId",
    "attributes": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  }
]

json

Example Responses

No example specified for this content type

GET

https://api.heart.work

/commerce-api/salesorders/filters

Responses

object[] · required

GET/commerce-api/salesorders/filters

curl --request GET \
  --url https://api.heart.work/commerce-api/salesorders/filters

shell

Example Responses

{
  "orderedBys": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ]
}

plain

Products Stocks

Heartwork Commerce API

SalesOrders

Endpointhttps://api.heart.work

Download schema

Fetches a single sales order, by id.

GET

https://api.heart.work

/commerce-api/salesorders/{id}

Fetches a single sales order, by id. › path Parameters

id

string · required

Unique id of the sales order to fetch.

Fetches a single sales order, by id. › Responses

id

string · required

orderNumber

string · required

channel

string · required

orderedAt

string · date-time · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

object · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

object[] · required

object

externalReference

string

description

string

object

GET/commerce-api/salesorders/{id}

curl --request GET \
  --url https://api.heart.work/commerce-api/salesorders/:id

shell

Example Responses

{
  "id": "id",
  "orderNumber": "orderNumber",
  "channel": "channel",
  "orderedAt": "2024-08-25T15:00:00Z",
  "deliveryMethod": "Delivery",
  "processing": {
    "status": "Open"
  },
  "orderingStatus": "Draft",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    }
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "externalReference": "externalReference",
  "description": "description",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "location": {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  },
  "orderLines": [
    {
      "id": "id",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "quantity": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "status": "status",
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        }
      }
    }
  ]
}

plain

GET

https://api.heart.work

/commerce-api/salesorders/order-number/{orderNumber}

path Parameters

orderNumber

integer · int32 · required

Responses

id

string · required

orderNumber

string · required

channel

string · required

orderedAt

string · date-time · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

object · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

object[] · required

object

externalReference

string

description

string

object

GET/commerce-api/salesorders/order-number/{orderNumber}

curl --request GET \
  --url https://api.heart.work/commerce-api/salesorders/order-number/:orderNumber

shell

Example Responses

{
  "id": "id",
  "orderNumber": "orderNumber",
  "channel": "channel",
  "orderedAt": "2024-08-25T15:00:00Z",
  "deliveryMethod": "Delivery",
  "processing": {
    "status": "Open"
  },
  "orderingStatus": "Draft",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "type"
          },
          "amount": 0
        }
      ]
    }
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "type"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "externalReference": "externalReference",
  "description": "description",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "location": {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  },
  "orderLines": [
    {
      "id": "id",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "quantity": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "status": "status",
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        }
      }
    }
  ]
}

plain

Fetches a collection of all sales orders, filtered by the input

GET

https://api.heart.work

/commerce-api/salesorders

Fetches a collection of all sales orders, filtered by the input › 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:

OrderNumber

OrderedAt

q

string

ordered_by_ids

string[]

Fetches a collection of all sales orders, filtered by the input › Responses

object[] · required

total

integer · int32 · required

GET/commerce-api/salesorders

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "orderNumber": "orderNumber",
      "channel": "channel",
      "orderedAt": "2024-08-25T15:00:00Z",
      "deliveryMethod": "Delivery",
      "processing": {
        "status": "Open"
      },
      "orderingStatus": "Draft",
      "references": {
        "customer": "customer",
        "destination": "destination",
        "project": "project"
      },
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "type"
              },
              "amount": 0
            }
          ]
        }
      },
      "orderedBy": {
        "id": "id",
        "name": "name",
        "type": "type"
      },
      "orderLineStatuses": [
        {
          "key": "key",
          "value": 0
        }
      ],
      "externalReference": "externalReference",
      "description": "description",
      "delivery": {
        "status": "Open",
        "address": {
          "addressType": "addressType",
          "street": "street",
          "zipCode": "zipCode",
          "city": "city",
          "country": "country"
        },
        "attendeeName": "attendeeName",
        "comments": "comments"
      },
      "pickup": {
        "status": "Open",
        "comments": "comments",
        "location": {
          "id": "id",
          "name": "name",
          "type": "type"
        }
      }
    }
  ],
  "total": 0
}

plain

Creates and stores a new sales order.

POST

https://api.heart.work

/commerce-api/salesorders

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

Creates and stores a new sales order. › Request Body

channel

string · required

object · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

externalReference

string

description

string

currency

string

object

Creates and stores a new sales order. › Responses

id

string · required

orderNumber

string · required

POST/commerce-api/salesorders

curl --request POST \
  --url https://api.heart.work/commerce-api/salesorders \
  --header 'Content-Type: application/json' \
  --data '
{
  "channel": "channel",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "externalReference": "externalReference",
  "description": "description",
  "currency": "currency",
  "deliveryMethod": "Delivery",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "locationId": "locationId"
  }
}
'

shell

Example Request Body

{
  "channel": "channel",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "externalReference": "externalReference",
  "description": "description",
  "currency": "currency",
  "deliveryMethod": "Delivery",
  "delivery": {
    "status": "Open",
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName",
    "comments": "comments"
  },
  "pickup": {
    "status": "Open",
    "comments": "comments",
    "locationId": "locationId"
  }
}

json

Example Responses

{
  "id": "id",
  "orderNumber": "orderNumber"
}

plain

Updates the status of an existing sales order

PUT

https://api.heart.work

/commerce-api/salesorders/{id}/ordering-status

On success, returns the updated entity in the response.

Updates the status of an existing sales order › path Parameters

id

string · required

Updates the status of an existing sales order › query Parameters

status

string · enum

Enum values:

Draft

Completed

Canceled

Updates the status of an existing sales order › Responses

No data returned

PUT/commerce-api/salesorders/{id}/ordering-status

curl --request PUT \
  --url https://api.heart.work/commerce-api/salesorders/:id/ordering-status

shell

Example Responses

No example specified for this content type

Adds new sales order lines to a sales order.

POST

https://api.heart.work

/commerce-api/salesorders/{id}/lines

Adds new sales order lines to a sales order. › path Parameters

id

string · required

Adds new sales order lines to a sales order. › Request Body

object[]

quantity

number · double · required

productId

string · required

object[]

Adds new sales order lines to a sales order. › Responses

No data returned

POST/commerce-api/salesorders/{id}/lines

curl --request POST \
  --url https://api.heart.work/commerce-api/salesorders/:id/lines \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "quantity": 0,
    "productId": "productId",
    "attributes": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  }
]
'

shell

Example Request Body

[
  {
    "quantity": 0,
    "productId": "productId",
    "attributes": [
      {
        "key": "key",
        "value": "value"
      }
    ]
  }
]

json

Example Responses

No example specified for this content type

GET

https://api.heart.work

/commerce-api/salesorders/filters

Responses

object[] · required

GET/commerce-api/salesorders/filters

curl --request GET \
  --url https://api.heart.work/commerce-api/salesorders/filters

shell

Example Responses

{
  "orderedBys": [
    {
      "id": "id",
      "name": "name",
      "type": "type"
    }
  ]
}

plain

Products Stocks