Skip to content
biticaretdevelopers

Reference

App API routes

Every route under /oauth and /api/v1: its HTTP method, required scope and pagination support.

This page is generated from the source code: every route served under /oauth and /api/v1 is listed below. For request fields, response payloads and error codes, see the App API page. Paginated routes accept limit and page_info (Pagination).

/api/v1/billing

GET/api/v1/billing/credits

Scope needed
None
Paginated
No

Example request

bash
curl "https://<store>/api/v1/billing/credits" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/billing/credits

Scope needed
None
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/billing/credits" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/billing/plans

Scope needed
None
Paginated
No

Example request

bash
curl "https://<store>/api/v1/billing/plans" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/billing/subscriptions

Scope needed
None
Paginated
No

Example request

bash
curl "https://<store>/api/v1/billing/subscriptions" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/billing/subscriptions

Scope needed
None
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/billing/subscriptions" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/billing/subscriptions/{id}

Scope needed
None
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the subscriptions record.

Example request

bash
curl "https://<store>/api/v1/billing/subscriptions/{id}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/billing/subscriptions/{id}/cancel

Scope needed
None
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the subscriptions record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/billing/subscriptions/{id}/cancel" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/billing/subscriptions/{id}/usage_records

Scope needed
None
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the subscriptions record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/billing/subscriptions/{id}/usage_records" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/channels

POST/api/v1/channels

Scope needed
write_channels
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/channels" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/channels/{id}/orders

Scope needed
write_channels
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the channels record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/channels/{id}/orders" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/channels/{id}/products

Scope needed
write_channels
Paginated
Yes
Path parameter Type Required Description
id integer Yes The ID of the channels record.

Example request

bash
curl "https://<store>/api/v1/channels/{id}/products" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/channels/{id}/products/{productID}

Scope needed
write_channels
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the channels record.
productID integer Yes The ID of the products record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/channels/{id}/products/{productID}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/channels/{id}/products/{productID}

Scope needed
write_channels
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the channels record.
productID integer Yes The ID of the products record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/channels/{id}/products/{productID}" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/collections

GET/api/v1/collections

Scope needed
read_products
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/collections" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/collections/{id}

Scope needed
read_products
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the collections record.

Example request

bash
curl "https://<store>/api/v1/collections/{id}" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/companies

GET/api/v1/companies

Scope needed
read_companies
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/companies" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/companies

Scope needed
write_companies
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/companies" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/companies/{id}

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/companies/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/companies/{id}

Scope needed
read_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.

Example request

bash
curl "https://<store>/api/v1/companies/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/companies/{id}

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/companies/{id}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/companies/{id}/contacts

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/companies/{id}/contacts" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/companies/{id}/contacts/{customerID}

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.
customerID integer Yes The ID of the contacts record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/companies/{id}/contacts/{customerID}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/companies/{id}/contacts/{customerID}

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.
customerID integer Yes The ID of the contacts record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/companies/{id}/contacts/{customerID}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/companies/{id}/locations

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/companies/{id}/locations" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/companies/{id}/locations/{locationID}

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.
locationID integer Yes The ID of the locations record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/companies/{id}/locations/{locationID}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/companies/{id}/locations/{locationID}

Scope needed
write_companies
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the companies record.
locationID integer Yes The ID of the locations record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/companies/{id}/locations/{locationID}" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/customer_segments

GET/api/v1/customer_segments

Scope needed
read_customers
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/customer_segments" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/customer_segments/{id}

Scope needed
read_customers
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the customer_segments record.

Example request

bash
curl "https://<store>/api/v1/customer_segments/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/customer_segments/{id}/customers

Scope needed
read_customers
Paginated
Yes
Path parameter Type Required Description
id integer Yes The ID of the customer_segments record.

Example request

bash
curl "https://<store>/api/v1/customer_segments/{id}/customers" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/customers

GET/api/v1/customers

Scope needed
read_customers
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/customers" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/customers/{id}

Scope needed
read_customers
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the customers record.

Example request

bash
curl "https://<store>/api/v1/customers/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/customers/{id}

Scope needed
write_customers
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the customers record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/customers/{id}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/customers/{id}/marketing_consent

Scope needed
write_marketing_consent
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the customers record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/customers/{id}/marketing_consent" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/discount_codes

GET/api/v1/discount_codes

Scope needed
write_discounts
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/discount_codes" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/discount_codes

Scope needed
write_discounts
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/discount_codes" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/discount_codes/{id}

Scope needed
write_discounts
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the discount_codes record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/discount_codes/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/discount_codes/{id}

Scope needed
write_discounts
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the discount_codes record.

Example request

bash
curl "https://<store>/api/v1/discount_codes/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/discount_codes/{id}

Scope needed
write_discounts
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the discount_codes record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/discount_codes/{id}" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/draft_orders

GET/api/v1/draft_orders

Scope needed
read_draft_orders
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/draft_orders" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/draft_orders

Scope needed
write_draft_orders
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/draft_orders" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/draft_orders/{id}

Scope needed
write_draft_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the draft_orders record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/draft_orders/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/draft_orders/{id}

Scope needed
read_draft_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the draft_orders record.

Example request

bash
curl "https://<store>/api/v1/draft_orders/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/draft_orders/{id}

Scope needed
write_draft_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the draft_orders record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/draft_orders/{id}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/draft_orders/{id}/complete

Scope needed
write_draft_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the draft_orders record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/draft_orders/{id}/complete" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/draft_orders/{id}/send_invoice

Scope needed
write_draft_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the draft_orders record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/draft_orders/{id}/send_invoice" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/emails

POST/api/v1/emails

Scope needed
write_emails
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/emails" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/function_runs

GET/api/v1/function_runs

Scope needed
Checked per endpoint
Paginated
No

Example request

bash
curl "https://<store>/api/v1/function_runs" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/gift_cards

GET/api/v1/gift_cards

Scope needed
read_gift_cards
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/gift_cards" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/gift_cards

Scope needed
write_gift_cards
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/gift_cards" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/gift_cards/{id}

Scope needed
read_gift_cards
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the gift_cards record.

Example request

bash
curl "https://<store>/api/v1/gift_cards/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/gift_cards/{id}

Scope needed
write_gift_cards
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the gift_cards record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/gift_cards/{id}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/gift_cards/{id}/disable

Scope needed
write_gift_cards
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the gift_cards record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/gift_cards/{id}/disable" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/inventory_levels

GET/api/v1/inventory_levels

Scope needed
read_inventory
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/inventory_levels" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/inventory_levels

Scope needed
write_inventory
Paginated
No

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/inventory_levels" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/inventory_levels/adjust

Scope needed
write_inventory
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/inventory_levels/adjust" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/inventory_levels/history

Scope needed
read_inventory
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/inventory_levels/history" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/inventory_levels/move

Scope needed
write_inventory
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/inventory_levels/move" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/locations

GET/api/v1/locations

Scope needed
read_locations
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/locations" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/marketing

GET/api/v1/marketing/audience

Scope needed
read_marketing_audience
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/marketing/audience" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/metafields

DELETE/api/v1/metafields

Scope needed
Checked per endpoint
Paginated
No

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/metafields" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/metafields

Scope needed
Checked per endpoint
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/metafields" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/metafields

Scope needed
Checked per endpoint
Paginated
No

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/metafields" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/metaobject_definitions

GET/api/v1/metaobject_definitions

Scope needed
read_metaobjects
Paginated
No

Example request

bash
curl "https://<store>/api/v1/metaobject_definitions" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/metaobject_definitions

Scope needed
write_metaobjects
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/metaobject_definitions" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/metaobject_definitions/{id}

Scope needed
write_metaobjects
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the metaobject_definitions record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/metaobject_definitions/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/metaobject_definitions/{id}

Scope needed
read_metaobjects
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the metaobject_definitions record.

Example request

bash
curl "https://<store>/api/v1/metaobject_definitions/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/metaobject_definitions/{id}

Scope needed
write_metaobjects
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the metaobject_definitions record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/metaobject_definitions/{id}" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/metaobjects

GET/api/v1/metaobjects

Scope needed
read_metaobjects
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/metaobjects" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/metaobjects

Scope needed
write_metaobjects
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/metaobjects" \
  -H "Authorization: Bearer bt_app_…"

DELETE/api/v1/metaobjects/{id}

Scope needed
write_metaobjects
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the metaobjects record.

Example request

bash
curl -X DELETE \
  "https://<store>/api/v1/metaobjects/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/metaobjects/{id}

Scope needed
read_metaobjects
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the metaobjects record.

Example request

bash
curl "https://<store>/api/v1/metaobjects/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/metaobjects/{id}

Scope needed
write_metaobjects
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the metaobjects record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/metaobjects/{id}" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/orders

GET/api/v1/orders

Scope needed
read_orders
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/orders" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/orders/{id}

Scope needed
read_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl "https://<store>/api/v1/orders/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/orders/{id}

Scope needed
write_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/orders/{id}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/orders/{id}/cancel

Scope needed
write_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/orders/{id}/cancel" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/orders/{id}/capture

Scope needed
write_payments
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/orders/{id}/capture" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/orders/{id}/fulfillments

Scope needed
write_fulfillments
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/orders/{id}/fulfillments" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/orders/{id}/fulfillments/{fulfillmentID}

Scope needed
write_fulfillments
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.
fulfillmentID integer Yes The ID of the fulfillments record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/orders/{id}/fulfillments/{fulfillmentID}" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/orders/{id}/fulfillments/{fulfillmentID}/cancel

Scope needed
write_fulfillments
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.
fulfillmentID integer Yes The ID of the fulfillments record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/orders/{id}/fulfillments/{fulfillmentID}/cancel" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/orders/{id}/fulfillments/{fulfillmentID}/events

Scope needed
write_fulfillments
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.
fulfillmentID integer Yes The ID of the fulfillments record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/orders/{id}/fulfillments/{fulfillmentID}/events" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/orders/{id}/refunds

Scope needed
read_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl "https://<store>/api/v1/orders/{id}/refunds" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/orders/{id}/refunds

Scope needed
write_orders
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the orders record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/orders/{id}/refunds" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/payments-app

POST/api/v1/payments-app/configure

Scope needed
Checked per endpoint
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/payments-app/configure" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/pixels

GET/api/v1/pixels/{pixelID}/settings

Scope needed
write_pixels
Paginated
No
Path parameter Type Required Description
pixelID integer Yes The ID of the pixels record.

Example request

bash
curl "https://<store>/api/v1/pixels/{pixelID}/settings" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/pixels/{pixelID}/settings

Scope needed
write_pixels
Paginated
No
Path parameter Type Required Description
pixelID integer Yes The ID of the pixels record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/pixels/{pixelID}/settings" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/products

GET/api/v1/products

Scope needed
read_products
Paginated
Yes

Example request

bash
curl "https://<store>/api/v1/products" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/products

Scope needed
write_products
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/products" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/products/{id}

Scope needed
read_products
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the products record.

Example request

bash
curl "https://<store>/api/v1/products/{id}" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/products/{id}

Scope needed
write_products
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the products record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/products/{id}" \
  -H "Authorization: Bearer bt_app_…"

GET/api/v1/products/{id}/variants

Scope needed
read_products
Paginated
Yes
Path parameter Type Required Description
id integer Yes The ID of the products record.

Example request

bash
curl "https://<store>/api/v1/products/{id}/variants" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/shop

GET/api/v1/shop

Scope needed
None
Paginated
No

Example request

bash
curl "https://<store>/api/v1/shop" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/sms

POST/api/v1/sms

Scope needed
write_sms
Paginated
No

Example request

bash
curl -X POST \
  "https://<store>/api/v1/sms" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/sms/{id}/status

Scope needed
write_sms
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the sms record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/sms/{id}/status" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/translations

GET/api/v1/translations

Scope needed
read_translations
Paginated
No

Example request

bash
curl "https://<store>/api/v1/translations" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/translations

Scope needed
write_translations
Paginated
No

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/translations" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/variants

PUT/api/v1/variants/{id}/cost

Scope needed
write_products
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the variants record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/variants/{id}/cost" \
  -H "Authorization: Bearer bt_app_…"

PUT/api/v1/variants/{id}/inventory

Scope needed
write_inventory
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the variants record.

Example request

bash
curl -X PUT \
  "https://<store>/api/v1/variants/{id}/inventory" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/webhook_deliveries

GET/api/v1/webhook_deliveries

Scope needed
Checked per endpoint
Paginated
No

Example request

bash
curl "https://<store>/api/v1/webhook_deliveries" \
  -H "Authorization: Bearer bt_app_…"

POST/api/v1/webhook_deliveries/{id}/replay

Scope needed
Checked per endpoint
Paginated
No
Path parameter Type Required Description
id integer Yes The ID of the webhook_deliveries record.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/webhook_deliveries/{id}/replay" \
  -H "Authorization: Bearer bt_app_…"

/api/v1/{kind}

POST/api/v1/{kind}/{id}/{action}

Scope needed
Checked per endpoint
Paginated
No
Path parameter Type Required Description
kind string Yes Session kind: payment-sessions, refund-sessions, capture-sessions, void-sessions.
id string Yes The session ID.
action string Yes resolve or reject; for payment sessions, pending is also accepted.

Example request

bash
curl -X POST \
  "https://<store>/api/v1/{kind}/{id}/{action}" \
  -H "Authorization: Bearer bt_app_…"

/oauth

POST/oauth/access_token

Scope needed
Checked per endpoint
Paginated
No

GET/oauth/authorize

Scope needed
Checked per endpoint
Paginated
No

Scope needed: Every write scope implies the corresponding read scope for that resource. "None" means any valid installation access token is accepted. "Checked per endpoint" means the route does not require a static scope and validates the caller inside the handler itself (OAuth endpoints, metafields, webhook delivery and function run logs, and payment app session endpoints).