Deprecated

API v1 is deprecated. It keeps working for existing integrations but gets no new features. New integrations should use API v2: start with the v2 quickstart or browse the v2 reference.

Stores

View as Markdown

One store per storefront you run, so quotes and orders are kept apart per storefront.

The store object

Attributes

  • idstring

    Identifier for this store. Pass it as store_id on quotes and orders.

  • namestring

    The name you gave this storefront.

  • external_referenceobjectOptional

    Your own identifier for this storefront, or null if you did not set one.

  • archivedboolean

    Whether this store is archived. An archived store keeps its history but refuses new quotes and orders.

  • created_attimestamp

    ISO 8601 timestamp of when this store was created.

The store object
{
  ,
  ,
  ,
  ,
  
}

List your stores

GET/v1/stores

Credentials
An API key with the PRICING or FULL permission.
For
Designers
Operation id
v1_listStores

Returns your stores, newest first. Archived stores are excluded unless you pass include_archived=true.

Query parameters

  • pagenumber

    1-based page index.

    Range at least 1. Defaults to 1.
  • page_sizenumber

    Number of stores per page (max 100).

    Range 1 to 100. Defaults to 20.
  • include_archivedboolean

    Include archived stores in the results. Defaults to false, so closed storefronts stay out of the way.

    Defaults to false.

Returns200 OK

Paginated list of stores.

Responses

  • 200

    Paginated list of stores.

  • 400

    page or page_size is outside the allowed range.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use store endpoints.

  • 429

    Rate limit exceeded.

Errors use the v1 error body.

GET/v1/stores
curl "https://public-api.dapi.digital/v1/stores" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "items": [
    {
      "id": "str_9f2c4a7b13d84e0fa6c5b8e21d47a903",
      "name": "Clicker Shop UK",
      "external_reference": "shop_uk_001",
      "archived": false,
      "created_at": "2026-09-02T12:00:00.000Z"
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 3
}

Create a store

POST/v1/stores

Credentials
An API key with the PRICING or FULL permission.
For
Designers
Operation id
v1_createStore

Creates a store representing one of your storefronts.

A store keeps one storefront's quotes and orders bookkept apart from the others on your account. It is not an authentication boundary: your API key still reaches every store you own.

Once your account has at least one store, store_id becomes required when creating quotes and orders. This stops a storefront from silently omitting it and mixing its records in with the rest.

Request body

  • namestringRequired

    Human-readable name for this storefront. Shown only to you.

  • external_referencestring

    Your own identifier for this storefront, so you can reconcile without keeping a mapping table. Opaque to us and never interpreted. Must be unique across your live stores.

Returns201 Created

Store created. Returns the store object.

Responses

  • 201

    Store created.

  • 400

    The request could not be validated.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use store endpoints.

  • 409

    Another live store already uses this external_reference.

  • 429

    Rate limit exceeded.

Errors use the v1 error body.

POST/v1/stores
curl -X POST "https://public-api.dapi.digital/v1/stores" \
  -H "x-api-key: $DAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Clicker Shop UK",
  "external_reference": "shop_uk_001"
}'
Response
{
  "id": "str_9f2c4a7b13d84e0fa6c5b8e21d47a903",
  "name": "Clicker Shop UK",
  "external_reference": "shop_uk_001",
  "archived": false,
  "created_at": "2026-09-02T12:00:00.000Z"
}

Get one store

GET/v1/stores/{storeId}

Credentials
An API key with the PRICING or FULL permission.
For
Designers
Operation id
v1_getStore

Returns the store matching the given id, archived or not.

Path parameters

  • storeIdstringRequired

    The store id returned when it was created.

Returns200 OK

The requested store. Returns the store object.

Responses

  • 200

    The requested store.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use store endpoints.

  • 404

    No store with this id exists for your account.

  • 429

    Rate limit exceeded.

Errors use the v1 error body.

GET/v1/stores/{storeId}
curl "https://public-api.dapi.digital/v1/stores/str_9f2c4a7b13d84e0fa6c5b8e21d47a903" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "id": "str_9f2c4a7b13d84e0fa6c5b8e21d47a903",
  "name": "Clicker Shop UK",
  "external_reference": "shop_uk_001",
  "archived": false,
  "created_at": "2026-09-02T12:00:00.000Z"
}

Update a store

PATCH/v1/stores/{storeId}

Credentials
An API key with the PRICING or FULL permission.
For
Designers
Operation id
v1_updateStore

Updates a store's name or external reference. Omitted fields are left unchanged; pass external_reference: null to clear it.

Path parameters

  • storeIdstringRequired

    The store to update.

Request body

  • namestring

    New name for this storefront.

  • external_referenceobject

    New external reference. Pass null to clear it. Omit to leave it unchanged.

Returns200 OK

The updated store. Returns the store object.

Responses

  • 200

    The updated store.

  • 400

    No updatable field was provided, or the body failed validation.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use store endpoints.

  • 404

    No store with this id exists for your account.

  • 409

    Another live store already uses this external_reference.

  • 429

    Rate limit exceeded.

Errors use the v1 error body.

PATCH/v1/stores/{storeId}
curl -X PATCH "https://public-api.dapi.digital/v1/stores/str_9f2c4a7b13d84e0fa6c5b8e21d47a903" \
  -H "x-api-key: $DAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Clicker Shop UK & IE",
  "external_reference": "shop_uk_002"
}'
Response
{
  "id": "str_9f2c4a7b13d84e0fa6c5b8e21d47a903",
  "name": "Clicker Shop UK",
  "external_reference": "shop_uk_001",
  "archived": false,
  "created_at": "2026-09-02T12:00:00.000Z"
}

Archive a store

DELETE/v1/stores/{storeId}

Credentials
An API key with the PRICING or FULL permission.
For
Designers
Operation id
v1_archiveStore

Archives a store. Its quotes and orders are kept and stay readable, but the store refuses new ones.

Stores are never hard-deleted, because orders reference them and that history has to survive a storefront closing. Archiving twice is safe and leaves the original archive date intact.

Path parameters

  • storeIdstringRequired

    The store to archive.

Returns200 OK

The archived store. Returns the store object.

Responses

  • 200

    The archived store.

  • 401

    API key is missing or invalid.

  • 403

    The API key does not have permission to use store endpoints.

  • 404

    No store with this id exists for your account.

  • 429

    Rate limit exceeded.

Errors use the v1 error body.

DELETE/v1/stores/{storeId}
curl -X DELETE "https://public-api.dapi.digital/v1/stores/str_9f2c4a7b13d84e0fa6c5b8e21d47a903" \
  -H "x-api-key: $DAPI_API_KEY"
Response
{
  "id": "str_9f2c4a7b13d84e0fa6c5b8e21d47a903",
  "name": "Clicker Shop UK",
  "external_reference": "shop_uk_001",
  "archived": false,
  "created_at": "2026-09-02T12:00:00.000Z"
}