Product packages

List product packages

GET

/product-packages

One page of records, newest first unless you say otherwise, with the total count in meta so you know how far to paginate.

Required scope: product-packages:read.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Query Parameters

page?integer

1-based. meta.totalPages says how many there are.

Range1 <= value

Default1

per_page?integer

Rows per page. A value above 200 returns 400 - never a silent clamp.

Range1 <= value <= 200

Default50

sort?string

Prefix with - for descending. An undeclared sort returns 400.

Default"name"

Value in"name""-name""createdAt""-createdAt"

q?string

Case-insensitive "contains", across: name, description.

Response Body

The requested page.

application/json

response

data*array<>

meta*

Example Request

curl -X GET 'https://api.usedashly.com/v1/product-packages'

Example Request

curl -X GET 'https://api.usedashly.com/v1/product-packages'

Example ResponseSchema

{
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "meta": {
    "page": 0,
    "perPage": 0,
    "total": 0,
    "totalPages": 0
  }
}

{  "data": [    {      "id": "string",      "name": "string",      "description": "string",      "createdAt": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "perPage": 0,    "total": 0,    "totalPages": 0  }}

Links are given as the target's public id (clientId: "hsbftmp3f5"); the API resolves them server-side. Fields the database requires but the interface decides for you are filled in the same way here.

Required scope: product-packages:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Header Parameters

Request Body

application/json

body

name*string

Length1 <= length <= 200

description?string

Lengthlength <= 2000

createdAt?string

When this actually happened, for an import. Past dates only; defaults to now. updatedAt follows it unless the body sets one.

Formatdate-time

Response Body

Created. The body is the new record, as a read would return it.

application/json

response

data*

Example Request

curl -X POST 'https://api.usedashly.com/v1/product-packages' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/product-packages' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Retrieve a product package

GET

/product-packages/{id}

The full record, custom fields included when the resource carries them. A record from another agency is a 404, not a 403 - its existence is not ours to confirm.

Required scope: product-packages:read.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Response Body

Found.

application/json

response

data*

Example Request

curl -X GET 'https://api.usedashly.com/v1/product-packages/string'

Example Request

curl -X GET 'https://api.usedashly.com/v1/product-packages/string'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Update a product package

PATCH

/product-packages/{id}

A partial update: only the fields you send change. One exception - customFields is replaced wholesale, not merged, so sending it with a single key clears the others. Read the record, merge, then write.

Required scope: product-packages:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Request Body

application/json

body

name?string

Length1 <= length <= 200

description?string

Lengthlength <= 2000

Response Body

Updated. The body is the record as it now stands.

application/json

response

data*

Example Request

curl -X PATCH 'https://api.usedashly.com/v1/product-packages/string' \
  -H 'Content-Type: application/json' \
  -d '{}'

Example Request

curl -X PATCH 'https://api.usedashly.com/v1/product-packages/string' \  -H 'Content-Type: application/json' \  -d '{}'

Example ResponseSchema

{
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "createdAt": "2019-08-24T14:15:22Z"
  }
}

{  "data": {    "id": "string",    "name": "string",    "description": "string",    "createdAt": "2019-08-24T14:15:22Z"  }}

Delete a product package

DELETE

/product-packages/{id}

Permanent. The audit log keeps the trace; the record does not come back.

Required scope: product-packages:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Path Parameters

id*string

The record's public id (hsbftmp3f5), as returned in the id field. An internal UUID returns 404.

Response Body

Deleted. Empty body.

Example Request

curl -X DELETE 'https://api.usedashly.com/v1/product-packages/string'

Example Request

curl -X DELETE 'https://api.usedashly.com/v1/product-packages/string'

Example Response

Empty

List available actions

GET

/product-packages/actions

Every verb this resource answers to, with its target and the JSON Schema of its body - the same contracts this document describes, readable at runtime.

Required scope: product-packages:read.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Response Body

The available verbs.

application/json

response

data*array<>

Example Request

curl -X GET 'https://api.usedashly.com/v1/product-packages/actions'

Example Request

curl -X GET 'https://api.usedashly.com/v1/product-packages/actions'

Example ResponseSchema

{
  "data": [
    {
      "name": "string",
      "label": "string",
      "description": "string",
      "target": "item",
      "readOnly": true,
      "path": "string",
      "input": {}
    }
  ]
}

{  "data": [    {      "name": "string",      "label": "string",      "description": "string",      "target": "item",      "readOnly": true,      "path": "string",      "input": {}    }  ]}

Create a package with its lines

POST

/product-packages/actions/create-with-items

Creates a package and its priced lines in one call: name, description, and lines - a catalogue product by its public id, quantity, unit price in cents, discount and tax rate.

Does what the dashboard's createPackageAction does - same implementation, so the two cannot diverge.

Required scope: product-packages:write.

Authorization

bearerAuth

headerAuthorizationBearer <token>

Your agency's API key: Authorization: Bearer ak_…. Created in Connectors → API & webhooks and shown once. A key authenticates an agency, not a person.

Header Parameters

Request Body

application/json

body

name*string

Length1 <= length <= 200

description?string

Lengthlength <= 2000

Default""

items?array<>

Itemsitems <= 100

Default[]

Response Body

Done.

application/json

response

data*unknown

The action's result; its shape depends on the verb.

Example Request

curl -X POST 'https://api.usedashly.com/v1/product-packages/actions/create-with-items' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string"
}'

Example Request

curl -X POST 'https://api.usedashly.com/v1/product-packages/actions/create-with-items' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'

Example ResponseSchema

{
  "data": null
}

{  "data": null}

List product packagesCopy Anchor Link

AuthorizationCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Create a product packageCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Retrieve a product packageCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Update a product packageCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

Delete a product packageCopy Anchor Link

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

List available actionsCopy Anchor Link

AuthorizationCopy Anchor Link

Response BodyCopy Anchor Link

Create a package with its linesCopy Anchor Link

AuthorizationCopy Anchor Link

Header ParametersCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

List product packages

Authorization

Query Parameters

Response Body

Create a product package

Authorization

Header Parameters

Request Body

Response Body

Retrieve a product package

Authorization

Path Parameters

Response Body

Update a product package

Authorization

Path Parameters

Request Body

Response Body

Delete a product package

Authorization

Path Parameters

Response Body

List available actions

Authorization

Response Body

Create a package with its lines

Authorization

Header Parameters

Request Body

Response Body