Heartwork API

SalesOrders

Endpointhttps://api.heart.work

Download schema

Fetches a collection of all sales orders, for the provided workspace

GET

https://api.heart.work

/core-api/salesorders

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

Take

integer · int32

Skip

integer · int32

SortOrder

string · enum

Enum values:

Asc

Desc

SortBy

string · enum

Enum values:

OrderNumber

OrderedAt

Query

string

ids

string[]

external_references

string[]

debtor_ids

string[]

ordered_by_ids

string[]

ordering_statuses

string[]

Enum values:

Draft

Completed

Canceled

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

object[] · required

total

integer · int32 · required

GET/core-api/salesorders

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

shell

Example Responses

{
  "data": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "orderNumber": 0,
      "orderedAt": "2024-08-25T15:00:00Z",
      "orderingStatus": "Draft",
      "processing": {
        "status": "Open"
      },
      "description": "description",
      "references": {
        "customer": "customer",
        "destination": "destination",
        "project": "project"
      },
      "payment": {
        "status": "Open",
        "paidAt": "2024-08-25T15:00:00Z"
      },
      "billing": {
        "address": {
          "addressType": "addressType",
          "street": "street",
          "zipCode": "zipCode",
          "city": "city",
          "country": "country"
        },
        "attendeeName": "attendeeName"
      },
      "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",
        "location": {
          "id": "id",
          "name": "name",
          "type": "Location"
        }
      },
      "channel": "channel",
      "customFields": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "tags": [
        "string"
      ],
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        },
        "totalPurchasePrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        }
      },
      "currency": {
        "code": "code",
        "conversionRate": 0
      },
      "debtor": {
        "id": "id",
        "name": "name",
        "type": "Account"
      },
      "orderedBy": {
        "id": "id",
        "name": "name",
        "type": "Contact"
      },
      "orderLineStatuses": [
        {
          "key": "key",
          "value": 0
        }
      ]
    }
  ],
  "total": 0
}

plain

Creates and stores a new sales order.

POST

https://api.heart.work

/core-api/salesorders

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

Creates and stores a new sales order. › Request Body

debtorId

string · required

orderedAt

string · date-time · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

channel

string · required

externalReference

string

orderedById

string

object

description

string

object

object[]

tags

string[]

object

Creates and stores a new sales order. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

orderNumber

integer · int64 · required

orderedAt

string · date-time · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

channel

string · required

object[] · required

tags

string[] · required

object · required

object[] · required

externalReference

string

description

string

object

POST/core-api/salesorders

curl --request POST \
  --url https://api.heart.work/core-api/salesorders \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "debtorId": "debtorId",
  "orderedById": "orderedById",
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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"
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "currency": {
    "code": "code",
    "conversionRate": 0
  }
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "debtorId": "debtorId",
  "orderedById": "orderedById",
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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"
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "currency": {
    "code": "code",
    "conversionRate": 0
  }
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "orderNumber": 0,
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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",
    "location": {
      "id": "id",
      "name": "name",
      "type": "Location"
    }
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalPurchasePrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    }
  },
  "currency": {
    "code": "code",
    "conversionRate": 0
  },
  "debtor": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "Contact"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ]
}

plain

Fetches a single sales order, by id.

GET

https://api.heart.work

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

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

orderNumber

integer · int64 · required

orderedAt

string · date-time · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

channel

string · required

object[] · required

tags

string[] · required

object · required

object[] · required

externalReference

string

description

string

object

GET/core-api/salesorders/{id}

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

shell

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "orderNumber": 0,
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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",
    "location": {
      "id": "id",
      "name": "name",
      "type": "Location"
    }
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalPurchasePrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    }
  },
  "currency": {
    "code": "code",
    "conversionRate": 0
  },
  "debtor": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "Contact"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ],
  "orderLines": [
    {
      "id": "id",
      "workspace": "workspace",
      "createdAt": "2024-08-25T15:00:00Z",
      "modifiedAt": "2024-08-25T15:00:00Z",
      "externalReference": "externalReference",
      "delivery": {
        "deliveredAt": "2024-08-25T15:00:00Z",
        "deliveryDate": "2024-08-25T15:00:00Z"
      },
      "salesOrderId": "salesOrderId",
      "quantity": 0,
      "product": {
        "id": "id",
        "name": "name",
        "type": "Product"
      },
      "status": "status",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "references": {
        "customer": "customer"
      },
      "totals": {
        "totalSalesPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        },
        "totalPurchasePrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        },
        "totalSuggestedRetailPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        },
        "totalCustomerPrice": {
          "amount": 0,
          "vatAmount": 0,
          "vatTotals": [
            {
              "vatCode": {
                "id": "id",
                "name": "name",
                "type": "VatCode"
              },
              "amount": 0
            }
          ]
        }
      }
    }
  ]
}

plain

Updates an existing sales order, replacing it entirely.

PUT

https://api.heart.work

/core-api/salesorders/{id}

On success, returns the updated entity in the response.

Updates an existing sales order, replacing it entirely. › path Parameters

id

string · required

Updates an existing sales order, replacing it entirely. › Request Body

debtorId

string · required

orderedAt

string · date-time · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

channel

string · required

id

string · required

externalReference

string

orderedById

string

object

description

string

object

object[]

tags

string[]

object

Updates an existing sales order, replacing it entirely. › Responses

id

string · required

workspace

string · required

createdAt

string · date-time · required

modifiedAt

string · date-time · required

orderNumber

integer · int64 · required

orderedAt

string · date-time · required

orderingStatus

string · enum · required

Enum values:

Draft

Completed

Canceled

object · required

deliveryMethod

string · enum · required

Enum values:

Delivery

Pickup

channel

string · required

object[] · required

tags

string[] · required

object · required

object[] · required

externalReference

string

description

string

object

PUT/core-api/salesorders/{id}

curl --request PUT \
  --url https://api.heart.work/core-api/salesorders/:id \
  --header 'Content-Type: application/json' \
  --data '
{
  "externalReference": "externalReference",
  "debtorId": "debtorId",
  "orderedById": "orderedById",
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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"
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "currency": {
    "code": "code",
    "conversionRate": 0
  },
  "id": "id"
}
'

shell

Example Request Body

{
  "externalReference": "externalReference",
  "debtorId": "debtorId",
  "orderedById": "orderedById",
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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"
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "currency": {
    "code": "code",
    "conversionRate": 0
  },
  "id": "id"
}

json

Example Responses

{
  "id": "id",
  "workspace": "workspace",
  "createdAt": "2024-08-25T15:00:00Z",
  "modifiedAt": "2024-08-25T15:00:00Z",
  "externalReference": "externalReference",
  "orderNumber": 0,
  "orderedAt": "2024-08-25T15:00:00Z",
  "orderingStatus": "Draft",
  "processing": {
    "status": "Open"
  },
  "description": "description",
  "references": {
    "customer": "customer",
    "destination": "destination",
    "project": "project"
  },
  "payment": {
    "status": "Open",
    "paidAt": "2024-08-25T15:00:00Z"
  },
  "billing": {
    "address": {
      "addressType": "addressType",
      "street": "street",
      "zipCode": "zipCode",
      "city": "city",
      "country": "country"
    },
    "attendeeName": "attendeeName"
  },
  "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",
    "location": {
      "id": "id",
      "name": "name",
      "type": "Location"
    }
  },
  "channel": "channel",
  "customFields": [
    {
      "key": "key",
      "value": "value"
    }
  ],
  "tags": [
    "string"
  ],
  "totals": {
    "totalSalesPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalPurchasePrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalSuggestedRetailPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    },
    "totalCustomerPrice": {
      "amount": 0,
      "vatAmount": 0,
      "vatTotals": [
        {
          "vatCode": {
            "id": "id",
            "name": "name",
            "type": "VatCode"
          },
          "amount": 0
        }
      ]
    }
  },
  "currency": {
    "code": "code",
    "conversionRate": 0
  },
  "debtor": {
    "id": "id",
    "name": "name",
    "type": "Account"
  },
  "orderedBy": {
    "id": "id",
    "name": "name",
    "type": "Contact"
  },
  "orderLineStatuses": [
    {
      "key": "key",
      "value": 0
    }
  ]
}

plain

Deletes an existing sales order, by id.

DELETE

https://api.heart.work

/core-api/salesorders/{id}

Deletes an existing sales order, by id. › path Parameters

id

string · required

Unique id of the sales order to delete.

Deletes an existing sales order, by id. › Responses

No Content

No data returned

DELETE/core-api/salesorders/{id}

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

shell

Example Responses

No example specified for this content type

POST

https://api.heart.work

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

path Parameters

id

string · required

Request Body

object[] · required

Responses

No data returned

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

curl --request POST \
  --url https://api.heart.work/core-api/salesorders/:id/lines \
  --header 'Content-Type: application/json' \
  --data '
{
  "items": [
    {
      "salesOrderId": "salesOrderId",
      "externalReference": "externalReference",
      "delivery": {
        "deliveredAt": "2024-08-25T15:00:00Z",
        "deliveryDate": "2024-08-25T15:00:00Z"
      },
      "quantity": 0,
      "productId": "productId",
      "status": "status",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "references": {
        "customer": "customer"
      }
    }
  ]
}
'

shell

Example Request Body

{
  "items": [
    {
      "salesOrderId": "salesOrderId",
      "externalReference": "externalReference",
      "delivery": {
        "deliveredAt": "2024-08-25T15:00:00Z",
        "deliveryDate": "2024-08-25T15:00:00Z"
      },
      "quantity": 0,
      "productId": "productId",
      "status": "status",
      "attributes": [
        {
          "key": "key",
          "value": "value"
        }
      ],
      "references": {
        "customer": "customer"
      }
    }
  ]
}

json

Example Responses

No example specified for this content type

Deletes an existing sales order line, by id.

DELETE

https://api.heart.work

/core-api/salesorders/{id}/lines/{lineId}

Deletes an existing sales order line, by id. › path Parameters

id

string · required

Unique id of the sales order.

lineId

string · required

Unique id of the sales order line to delete

Deletes an existing sales order line, by id. › Responses

No data returned

DELETE/core-api/salesorders/{id}/lines/{lineId}

curl --request DELETE \
  --url https://api.heart.work/core-api/salesorders/:id/lines/:lineId

shell

Example Responses

No example specified for this content type

GET

https://api.heart.work

/core-api/salesorders/stats/daily

query Parameters

From

string · date-time

Until

string · date-time

Responses

object · required

object[] · required

total

integer · int32 · required

GET/core-api/salesorders/stats/daily

curl --request GET \
  --url https://api.heart.work/core-api/salesorders/stats/daily

shell

Example Responses

{
  "grandTotals": {
    "amountNetTotal": 0,
    "amountNetAverage": 0,
    "count": 0,
    "deliveryMethodCounts": {
      "delivery": 0,
      "pickup": 0
    },
    "orderStatusCounts": {
      "draft": 0,
      "completed": 0,
      "canceled": 0
    }
  },
  "data": [
    {
      "amountNetTotal": 0,
      "amountNetAverage": 0,
      "count": 0,
      "deliveryMethodCounts": {
        "delivery": 0,
        "pickup": 0
      },
      "orderStatusCounts": {
        "draft": 0,
        "completed": 0,
        "canceled": 0
      },
      "date": "2024-08-25T15:00:00Z"
    }
  ],
  "total": 0
}

plain

Reports SalesOrderStatistics