Vendors

Vendor limits

GET read_products

Fetch vendor field limits and request limits.

Returns the validation limits clients need when building vendor forms and requests.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/vendors/limits \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/limits", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/vendors/limits",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "fields": {
      "description": {
        "max_length": 5000
      },
      "name": {
        "max_length": 100
      },
      "seo_description": {
        "max_length": 160
      },
      "seo_title": {
        "max_length": 70
      },
      "slug": {
        "max_length": 100
      }
    },
    "request_caps": {
      "bulk_create_max_count": 50,
      "bulk_delete_max_count": 200,
      "list_max_limit": 200,
      "max_per_store": 100000,
      "search_max_length": 200,
      "search_max_limit": 50
    },
    "resource_type": "vendor"
  },
  "success": true
}

List vendors

GET read_products

List vendors for the store.

Returns vendors with pagination, search, and sorting.

Query parameters

Name	Type	Description
`page`	`integer`	Page number. Example: `1`
`limit`	`integer`	Page size. Example: `20`
`search`	`string`	Search query. Example: `acme-supplies`
`sort_by`	`string`	Sort field from the Vendor list contract. Allowed values `nameproduct_countcreated_atupdated_at` Example: `name`
`sort_direction`	`string`	Sort direction from the Vendor list contract. Allowed values `ascdesc` Example: `asc`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/vendors?limit=20&page=1&search=acme-supplies&sort_by=name&sort_direction=asc \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors?limit=20&page=1&search=acme-supplies&sort_by=name&sort_direction=asc", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/vendors?limit=20&page=1&search=acme-supplies&sort_by=name&sort_direction=asc",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "pagination": {
      "limit": 20,
      "page": 1,
      "total": 1
    },
    "vendors": [
      {
        "created_at": "2026-06-09T12:00:00Z",
        "description": "Acme Supplies provides wholesale outdoor gear.",
        "id": 7,
        "image_cdn_url": "",
        "image_id": null,
        "image_url": "",
        "name": "Acme Supplies",
        "product_count": 12,
        "seo_description": "Shop products supplied by Acme Supplies.",
        "seo_title": "Acme Supplies",
        "slug": "acme-supplies",
        "store_id": "str_9f8a1c2b",
        "storefront_url": "https://store.example.com/vendor/acme-supplies",
        "template_handle": "default_vendor",
        "translations_updated_at": "2026-06-09T12:00:00Z",
        "updated_at": "2026-06-09T12:00:00Z"
      }
    ]
  },
  "success": true
}

Search vendors

GET read_products

Search vendors for picker-style suggestions.

Returns lightweight vendor suggestions by query. This endpoint is intended for pickers and simple selection UIs.

Query parameters

Name	Type	Description
`q`	`string`	Search query. Example: `acme`
`limit`	`integer`	Suggestion count. Example: `10`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

curl https://api-store.tringify.com/api/2025-01/vendors/search?limit=10&q=acme \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/search?limit=10&q=acme", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/vendors/search?limit=10&q=acme",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "vendors": [
      {
        "id": 7,
        "name": "Acme Supplies",
        "slug": "acme-supplies"
      }
    ]
  },
  "success": true
}

Get a vendor

GET read_products

Fetch one vendor by id.

Returns the vendor if it belongs to the token's store.

Path parameters

Name	Type	Description
`id` required	`integer`	Vendor id. Example: `7`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Errors

404 VENDOR_NOT_FOUND
Vendor does not exist in this store.

curl https://api-store.tringify.com/api/2025-01/vendors/7 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/7", {
  method: "GET",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api-store.tringify.com/api/2025-01/vendors/7",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "vendor": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Acme Supplies provides wholesale outdoor gear.",
      "id": 7,
      "image_cdn_url": "",
      "image_id": null,
      "image_url": "",
      "name": "Acme Supplies",
      "product_count": 12,
      "seo_description": "Shop products supplied by Acme Supplies.",
      "seo_title": "Acme Supplies",
      "slug": "acme-supplies",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/vendor/acme-supplies",
      "template_handle": "default_vendor",
      "translations_updated_at": "2026-06-09T12:00:00Z",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Creates a vendor. name is required. Omit slug to generate it from the name. A non-empty image_id must identify an uploaded image in this store and requires read_files; video, document, 3D-model, and site-asset ids are rejected.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name` required	`string`	Vendor name. Example: `Acme Supplies`
`slug`	`string`	Optional slug. Omit to generate from name. Example: `acme-supplies`
`description`	`string`	Optional plain-text description. Example: `Acme Supplies provides wholesale outdoor gear.`
`seo_title`	`string`	Optional SEO title. Example: `Acme Supplies`
`seo_description`	`string`	Optional SEO description. Example: `Shop products supplied by Acme Supplies.`
`image_id`	`string`	Optional Media-library upload image id. Video, document, 3D-model, and site-asset ids are invalid. Non-empty values require `read_files` access to the referenced file. Example: `f_8f2a1c2b9d4e`
`template_handle`	`string`	Template assignment. On create, omitting this field or sending an empty string assigns `default_vendor`. Use `default_vendor` for the default Vendor template, or pass an alternate Vendor template handle configured for the store. On update, omit `template_handle` to leave the assignment unchanged, use `default_vendor` to reset it to default, and do not send an empty string. Example: `default_vendor`

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 STORE_API_CREATE_REDIRECT_UNSUPPORTED
create_redirect is only supported when updating a vendor.
400 VENDOR_NAME_REQUIRED
Name is required.
400 VENDOR_NAME_INVALID_CHARS
Name contains unsupported control characters.
400 VENDOR_NAME_TOO_LONG
Name exceeds the maximum length.
400 VENDOR_DESCRIPTION_INVALID_CHARS
Description contains unsupported control characters.
400 VENDOR_DESCRIPTION_TOO_LONG
Description exceeds the maximum length.
400 VENDOR_SEO_TITLE_INVALID_CHARS
SEO title contains unsupported control characters.
400 VENDOR_SEO_TITLE_TOO_LONG
SEO title exceeds the maximum length.
400 VENDOR_SEO_DESCRIPTION_INVALID_CHARS
SEO description contains unsupported control characters.
400 VENDOR_SEO_DESCRIPTION_TOO_LONG
SEO description exceeds the maximum length.
400 VENDOR_SLUG_INVALID_FORMAT
Slug is not valid for Vendor URLs.
400 VENDOR_SLUG_TOO_LONG
Slug exceeds the maximum length.
400 TEMPLATE_HANDLE_INVALID
Template handle is not valid for Vendor templates.
400 TEMPLATE_HANDLE_NOT_FOUND
Template handle is not available for this store.
400 INVALID_INPUT
image_id is malformed, is not an image, or references a file outside the Media-library upload namespace.
403 STORE_ADMIN_TOKEN_RUNTIME_FORBIDDEN
A non-empty image_id requires read_files scope in addition to write_products.
404 NOT_FOUND
The supplied image does not exist in this store.
409 VENDOR_DUPLICATE
Name or slug already exists in this store.
400 VENDOR_SLUG_GENERATION_FAILED
A slug could not be generated from the supplied name.
400 VENDOR_UNIQUE_SLUG_GENERATION_FAILED
A unique generated slug could not be found; supply a slug explicitly.
400 VENDOR_LIMIT_REACHED
The store has reached its vendor limit.

curl -X POST https://api-store.tringify.com/api/2025-01/vendors \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "Acme Supplies provides wholesale outdoor gear.",
  "image_id": "f_8f2a1c2b9d4e",
  "name": "Acme Supplies",
  "seo_description": "Shop products supplied by Acme Supplies.",
  "seo_title": "Acme Supplies",
  "slug": "acme-supplies",
  "template_handle": "default_vendor"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "image_id": "f_8f2a1c2b9d4e",
    "name": "Acme Supplies",
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor"
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/vendors",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "description": "Acme Supplies provides wholesale outdoor gear.",
        "image_id": "f_8f2a1c2b9d4e",
        "name": "Acme Supplies",
        "seo_description": "Shop products supplied by Acme Supplies.",
        "seo_title": "Acme Supplies",
        "slug": "acme-supplies",
        "template_handle": "default_vendor",
    },
)
data = res.json()

Response

201

Sample response

{
  "data": {
    "vendor": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Acme Supplies provides wholesale outdoor gear.",
      "id": 7,
      "image_cdn_url": "",
      "image_id": null,
      "image_url": "",
      "name": "Acme Supplies",
      "product_count": 12,
      "seo_description": "Shop products supplied by Acme Supplies.",
      "seo_title": "Acme Supplies",
      "slug": "acme-supplies",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/vendor/acme-supplies",
      "template_handle": "default_vendor",
      "translations_updated_at": "2026-06-09T12:00:00Z",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Bulk create vendors

POST write_products

Create multiple vendors by name.

Creates multiple vendors from names. Slugs are generated server-side; existing names are skipped and reported in the response.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`names` required	`array<string>`	Vendor names to create. Example: `Acme Supplies`

Errors

400 VENDOR_BULK_NO_NAMES
No names were provided.
400 VENDOR_BULK_CREATE_TOO_MANY
Batch exceeds the Vendor bulk create cap.
409 VENDOR_BULK_DUPLICATE
One of the names in the batch was just created by another request.

curl -X POST https://api-store.tringify.com/api/2025-01/vendors/bulk-create \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "names": [
    "Acme Supplies"
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/bulk-create", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "names": [
      "Acme Supplies"
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/vendors/bulk-create",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "names": ["Acme Supplies"],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "created": [
      {
        "id": 7,
        "name": "Acme Supplies",
        "slug": "acme-supplies"
      }
    ],
    "errors": [],
    "row_errors": [],
    "skipped": [
      "Existing Vendor"
    ]
  },
  "success": true
}

Update a vendor

PUT write_products

Update a vendor.

Updates only the fields you provide. Empty description and SEO values clear those fields; an empty image_id clears the image. A non-empty image_id must identify an uploaded image in this store and requires read_files; video, document, 3D-model, and site-asset ids are rejected. When slug changes, create_redirect controls whether the previous URL redirects to the new one and defaults to true.

Path parameters

Name	Type	Description
`id` required	`integer`	Vendor id. Example: `7`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`name`	`string`	Vendor name. Example: `Acme Supplies`
`slug`	`string`	New slug. Omit to leave the current slug unchanged; an empty value is invalid. Example: `acme-supplies`
`description`	`string`	Optional plain-text description. Example: `Acme Supplies provides wholesale outdoor gear.`
`seo_title`	`string`	Optional SEO title. Example: `Acme Supplies`
`seo_description`	`string`	Optional SEO description. Example: `Shop products supplied by Acme Supplies.`
`image_id`	`string`	Optional Media-library upload image id. Video, document, 3D-model, and site-asset ids are invalid. Non-empty values require `read_files` access to the referenced file. Example: `f_8f2a1c2b9d4e`
`template_handle`	`string`	Template assignment. On create, omitting this field or sending an empty string assigns `default_vendor`. Use `default_vendor` for the default Vendor template, or pass an alternate Vendor template handle configured for the store. On update, omit `template_handle` to leave the assignment unchanged, use `default_vendor` to reset it to default, and do not send an empty string. Example: `default_vendor`
`create_redirect`	`boolean`	When slug changes, create a redirect from the previous slug. Example: `true`

Errors

400 STORE_API_INVALID_VENDOR_ID
Vendor id is invalid.
400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 VENDOR_NAME_REQUIRED
Name is required.
400 VENDOR_NAME_INVALID_CHARS
Name contains unsupported control characters.
400 VENDOR_NAME_TOO_LONG
Name exceeds the maximum length.
400 VENDOR_DESCRIPTION_INVALID_CHARS
Description contains unsupported control characters.
400 VENDOR_DESCRIPTION_TOO_LONG
Description exceeds the maximum length.
400 VENDOR_SEO_TITLE_INVALID_CHARS
SEO title contains unsupported control characters.
400 VENDOR_SEO_TITLE_TOO_LONG
SEO title exceeds the maximum length.
400 VENDOR_SEO_DESCRIPTION_INVALID_CHARS
SEO description contains unsupported control characters.
400 VENDOR_SEO_DESCRIPTION_TOO_LONG
SEO description exceeds the maximum length.
400 VENDOR_SLUG_INVALID_FORMAT
Slug is not valid for Vendor URLs.
400 VENDOR_SLUG_TOO_LONG
Slug exceeds the maximum length.
400 TEMPLATE_HANDLE_INVALID
Template handle is not valid for Vendor templates.
400 TEMPLATE_HANDLE_NOT_FOUND
Template handle is not available for this store.
400 INVALID_INPUT
image_id is malformed, is not an image, or references a file outside the Media-library upload namespace.
403 STORE_ADMIN_TOKEN_RUNTIME_FORBIDDEN
A non-empty image_id requires read_files scope in addition to write_products.
404 NOT_FOUND
The supplied image does not exist in this store.
409 VENDOR_DUPLICATE
Name or slug already exists in this store.
404 VENDOR_NOT_FOUND
Vendor does not exist in this store.
409 TRANSLATION_SOURCE_FIELD_HAS_TRANSLATIONS
Clear a field's translations before clearing its source value.

curl -X PUT https://api-store.tringify.com/api/2025-01/vendors/7 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "create_redirect": true,
  "description": "Acme Supplies provides wholesale outdoor gear.",
  "image_id": "f_8f2a1c2b9d4e",
  "name": "Acme Supplies",
  "seo_description": "Shop products supplied by Acme Supplies.",
  "seo_title": "Acme Supplies",
  "slug": "acme-supplies",
  "template_handle": "default_vendor"
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/7", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "create_redirect": true,
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "image_id": "f_8f2a1c2b9d4e",
    "name": "Acme Supplies",
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor"
  }),
});
const data = await res.json();

import requests

res = requests.put(
    "https://api-store.tringify.com/api/2025-01/vendors/7",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "create_redirect": True,
        "description": "Acme Supplies provides wholesale outdoor gear.",
        "image_id": "f_8f2a1c2b9d4e",
        "name": "Acme Supplies",
        "seo_description": "Shop products supplied by Acme Supplies.",
        "seo_title": "Acme Supplies",
        "slug": "acme-supplies",
        "template_handle": "default_vendor",
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "vendor": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Acme Supplies provides wholesale outdoor gear.",
      "id": 7,
      "image_cdn_url": "",
      "image_id": null,
      "image_url": "",
      "name": "Acme Supplies",
      "product_count": 12,
      "seo_description": "Shop products supplied by Acme Supplies.",
      "seo_title": "Acme Supplies",
      "slug": "acme-supplies",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/vendor/acme-supplies",
      "template_handle": "default_vendor",
      "translations_updated_at": "2026-06-09T12:00:00Z",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Delete a vendor

DELETE write_products

Delete a vendor.

Deletes a vendor. If dependent products, collection rules, or menu items require confirmation, retry with the returned confirmation token.

Path parameters

Name	Type	Description
`id` required	`integer`	Vendor id. Example: `7`

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`confirmed`	`boolean`	On a confirmation retry, set this to true and send the returned confirmation_token. Omit it on the first request.
`confirmation_token`	`string`	Token from the CONFIRMATION_REQUIRED response. Omit it on the first request and resend the exact same id selection when using it.

Errors

400 VENDOR_CONFIRMATION_INVALID
Confirmation token is missing, expired, or mismatched.
404 VENDOR_NOT_FOUND
Vendor does not exist in this store.
409 CONFIRMATION_REQUIRED
Delete requires confirmation because dependent records will be changed.

curl -X DELETE https://api-store.tringify.com/api/2025-01/vendors/7 \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN"

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/7", {
  method: "DELETE",
  headers: { "Authorization": "Bearer YOUR_STORE_API_TOKEN" },
});
const data = await res.json();

import requests

res = requests.delete(
    "https://api-store.tringify.com/api/2025-01/vendors/7",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "vendor": {
      "created_at": "2026-06-09T12:00:00Z",
      "description": "Acme Supplies provides wholesale outdoor gear.",
      "id": 7,
      "image_cdn_url": "",
      "image_id": null,
      "image_url": "",
      "name": "Acme Supplies",
      "product_count": 12,
      "seo_description": "Shop products supplied by Acme Supplies.",
      "seo_title": "Acme Supplies",
      "slug": "acme-supplies",
      "store_id": "str_9f8a1c2b",
      "storefront_url": "https://store.example.com/vendor/acme-supplies",
      "template_handle": "default_vendor",
      "translations_updated_at": "2026-06-09T12:00:00Z",
      "updated_at": "2026-06-09T12:00:00Z"
    }
  },
  "success": true
}

Bulk delete vendors

POST write_products

Delete multiple vendors.

Send store-scoped integer vendor ids in vendor_ids. The first request needs only that array. If products, collection rules, or menu items will be changed, the API returns CONFIRMATION_REQUIRED; retry the same ids with confirmed: true and its confirmation_token. The success response separates deleted ids from missing or concurrently changed ids in deleted and failed. All database changes for the ids reported as deleted commit together.

Headers

Name	Type	Description
`Authorization` required	`string`	Bearer Store API token.

Body parameters

Name	Type	Description
`vendor_ids` required	`array<integer>`	Store-scoped integer vendor ids to delete. Example: `[7, 11]`
`confirmed`	`boolean`	On a confirmation retry, set this to true and send the returned confirmation_token. Omit it on the first request.
`confirmation_token`	`string`	Token from the CONFIRMATION_REQUIRED response. Omit it on the first request and resend the exact same id selection when using it.

Errors

400 STORE_API_INVALID_REQUEST_BODY
Request body is not valid JSON.
400 VENDOR_BULK_NO_IDS
No vendor_ids were provided.
400 VENDOR_BULK_DELETE_TOO_MANY
Batch exceeds the Vendor bulk delete cap.
409 VENDOR_BULK_RACED
Dependencies changed while the bulk delete was running; the affected id is returned in failed.
400 VENDOR_CONFIRMATION_INVALID
Confirmation token is missing, expired, or mismatched.
404 VENDOR_NOT_FOUND
Vendor does not exist in this store.
409 CONFIRMATION_REQUIRED
Delete requires confirmation because dependent records will be changed.

curl -X POST https://api-store.tringify.com/api/2025-01/vendors/bulk-delete \
  -H "Authorization: Bearer YOUR_STORE_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "vendor_ids": [
    7,
    11
  ]
}'

const res = await fetch("https://api-store.tringify.com/api/2025-01/vendors/bulk-delete", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_STORE_API_TOKEN",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "vendor_ids": [
      7,
      11
    ]
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api-store.tringify.com/api/2025-01/vendors/bulk-delete",
    headers={"Authorization": "Bearer YOUR_STORE_API_TOKEN"},
    json={
        "vendor_ids": [7, 11],
    },
)
data = res.json()

Response

200

Sample response

{
  "data": {
    "deleted": [
      7
    ],
    "failed": [
      {
        "id": 11,
        "reason": "Vendor not found."
      }
    ]
  },
  "success": true
}

Field	Kind	Create	Update	Required	Translatable
`name`	text	Yes	Yes	create	Yes
`slug`	slug	Yes	Yes		Yes
`description`	textarea	Yes	Yes		Yes
`seo_title`	text	Yes	Yes		Yes
`seo_description`	textarea	Yes	Yes		Yes
`image_id`	image	Yes	Yes		No
`template_handle`	template	Yes	Yes		No
`create_redirect`	boolean	No	Yes		No
`product_count`	integer	No	No		No
`created_at`	datetime	No	No		No
`updated_at`	datetime	No	No		No
`storefront_url`	url	No	No	No	No

Vendor created

EVENT vendors/create write_products products:write

Fired when a vendor is created.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present
`vendor.name`	`string`	Can be removed/added via the Payload builder
`vendor.slug`	`string`	Can be removed/added via the Payload builder
`vendor.description`	`string`	Can be removed/added via the Payload builder
`vendor.seo_title`	`string`	Can be removed/added via the Payload builder
`vendor.seo_description`	`string`	Can be removed/added via the Payload builder
`vendor.image_id`	`string`	Can be removed/added via the Payload builder
`vendor.image_url`	`string`	Can be removed/added via the Payload builder
`vendor.image_cdn_url`	`string`	Can be removed/added via the Payload builder
`vendor.product_count`	`integer`	Can be removed/added via the Payload builder
`vendor.template_handle`	`string`	Can be removed/added via the Payload builder
`vendor.created_at`	`string`	Can be removed/added via the Payload builder
`vendor.updated_at`	`string`	Can be removed/added via the Payload builder
`vendor.translations_updated_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "vendor": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "",
    "image_id": null,
    "image_url": "",
    "name": "Acme Supplies",
    "product_count": 12,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": "2026-06-09T12:00:00Z",
    "updated_at": "2026-06-09T12:00:00Z"
  }
}

Vendor updated

EVENT vendors/update write_products products:write

Fired when a vendor is updated.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present
`vendor.name`	`string`	Can be removed/added via the Payload builder
`vendor.slug`	`string`	Can be removed/added via the Payload builder
`vendor.description`	`string`	Can be removed/added via the Payload builder
`vendor.seo_title`	`string`	Can be removed/added via the Payload builder
`vendor.seo_description`	`string`	Can be removed/added via the Payload builder
`vendor.image_id`	`string`	Can be removed/added via the Payload builder
`vendor.image_url`	`string`	Can be removed/added via the Payload builder
`vendor.image_cdn_url`	`string`	Can be removed/added via the Payload builder
`vendor.product_count`	`integer`	Can be removed/added via the Payload builder
`vendor.template_handle`	`string`	Can be removed/added via the Payload builder
`vendor.created_at`	`string`	Can be removed/added via the Payload builder
`vendor.updated_at`	`string`	Can be removed/added via the Payload builder
`vendor.translations_updated_at`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "vendor": {
    "created_at": "2026-06-09T12:00:00Z",
    "description": "Acme Supplies provides wholesale outdoor gear.",
    "id": 7,
    "image_cdn_url": "",
    "image_id": null,
    "image_url": "",
    "name": "Acme Supplies",
    "product_count": 12,
    "seo_description": "Shop products supplied by Acme Supplies.",
    "seo_title": "Acme Supplies",
    "slug": "acme-supplies",
    "template_handle": "default_vendor",
    "translations_updated_at": "2026-06-09T12:00:00Z",
    "updated_at": "2026-06-09T12:00:00Z"
  }
}

Vendor deleted

EVENT vendors/delete write_products products:write

Fired when a vendor is deleted.

Payload fields

Field	Type	Description
`vendor.id`	`integer`	Always present
`vendor.name`	`string`	Can be removed/added via the Payload builder
`vendor.slug`	`string`	Can be removed/added via the Payload builder

Payload shape

Sample payload

{
  "vendor": {
    "id": 7,
    "name": "Acme Supplies",
    "slug": "acme-supplies"
  }
}

Endpoints#

Headers

Query parameters

Headers

Query parameters

Headers

Path parameters

Headers

Errors

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Path parameters

Headers

Body parameters

Errors

Headers

Body parameters

Errors

Fields#

Webhook events#

Payload fields

Payload fields

Payload fields