Get store metadata: name, description, domains, active languages, main_currency, country, plan_name, address and social links. Use it first to learn which languages (i18n keys) the store uses. HTTP: GET /store Required scope: any valid token API version: 2025-03

Get current usage and limit of the store's media storage (unstable API). HTTP: GET /store/media/quotas Required scope: read_products API version: unstable

List products with their variants, images and categories. Supports rich filters. HTTP: GET /products Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one product by ID, including variants, images, categories and attributes. HTTP: GET /products/{id} Required scope: read_products API version: 2025-03

Find the product owning a variant with the given SKU. HTTP: GET /products/sku/{sku} Required scope: read_products API version: 2025-03

Create a product (optionally with variants and images). Prices, SKU, weight and stock belong to variants. HTTP: POST /products Required scope: write_products API version: 2025-03

Update product metadata. Does NOT modify variants; use the variants tools for price/stock/SKU. HTTP: PUT /products/{id} Required scope: write_products API version: 2025-03

Permanently delete a product with all its variants and images. HTTP: DELETE /products/{id} Required scope: write_products API version: 2025-03

Bulk-update price, promotional price and inventory levels of many products/variants in one call. Body items: [{id: product_id, variants:[{id, price, promotional_price, inventory_levels:[{location_id, stock}]}]}]. Prefer this over per-variant calls to save rate limit. HTTP: PATCH /products/stock-price Required scope: write_products API version: 2025-03

List variants of a product. HTTP: GET /products/{product_id}/variants Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one variant. HTTP: GET /products/{product_id}/variants/{id} Required scope: read_products API version: 2025-03

Create a variant (max 1000 per product). HTTP: POST /products/{product_id}/variants Required scope: write_products API version: 2025-03

Update one variant (price, SKU, weight, stock...). HTTP: PUT /products/{product_id}/variants/{id} Required scope: write_products API version: 2025-03

Replace the full set of variants of a product in one call (array of variant objects). Costs rate limit proportional to variants/languages/inventory_levels (weighted token bucket). HTTP: PUT /products/{product_id}/variants Required scope: write_products API version: 2025-03

Partially update many existing variants of a product in one call (array of {id, ...fields}). Weighted token bucket applies. HTTP: PATCH /products/{product_id}/variants Required scope: write_products API version: 2025-03

Delete a variant. The only variant of a product cannot be deleted. HTTP: DELETE /products/{product_id}/variants/{id} Required scope: write_products API version: 2025-03

Set or adjust stock. action 'replace' sets an exact value (value null = infinite stock); 'variation' adds/subtracts a delta. Omit id to apply to all variants of the product. HTTP: POST /products/{product_id}/variants/stock Required scope: write_products API version: 2025-03

List images of a product. HTTP: GET /products/{product_id}/images Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one product image. HTTP: GET /products/{product_id}/images/{id} Required scope: read_products API version: 2025-03

Add an image from a public URL (src) or Base64 (attachment + filename). jpg/png/gif/webp, max 250 per product. HTTP: POST /products/{product_id}/images Required scope: write_products API version: 2025-03

Upload an image to the store repository before attaching it to a product. HTTP: POST /products/images Required scope: write_products API version: 2025-03

Update an image's position, alt text or source. HTTP: PUT /products/{product_id}/images/{id} Required scope: write_products API version: 2025-03

Delete a product image. HTTP: DELETE /products/{product_id}/images/{id} Required scope: write_products API version: 2025-03

List categories. HTTP: GET /categories Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one category. HTTP: GET /categories/{id} Required scope: read_products API version: 2025-03

Create a category (set parent for nesting). HTTP: POST /categories Required scope: write_products API version: 2025-03

Update a category. HTTP: PUT /categories/{id} Required scope: write_products API version: 2025-03

Delete a category. HTTP: DELETE /categories/{id} Required scope: write_products API version: 2025-03

Get a Kit/Combo product and the products/variants composing it. HTTP: GET /kits/{id} Required scope: read_products API version: 2025-03

List price tables (wholesale / B2B price lists). HTTP: GET /products/price-tables Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one price table. HTTP: GET /products/price-tables/{id} Required scope: read_products API version: 2025-03

Create a price table. HTTP: POST /products/price-tables Required scope: write_products API version: 2025-03

Update a price table. HTTP: PUT /products/price-tables/{id} Required scope: write_products API version: 2025-03

Delete a price table. HTTP: DELETE /products/price-tables/{id} Required scope: write_products API version: 2025-03

List categories assigned to a price table. HTTP: GET /products/price-tables/{table_id}/categories Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Assign categories to a price table. Body shape per the API reference. HTTP: POST /products/price-tables/{table_id}/categories Required scope: write_products API version: 2025-03

Update categories entries of a price table (e.g. prices). Body shape per the API reference. HTTP: PUT /products/price-tables/{table_id}/categories Required scope: write_products API version: 2025-03

Remove categories from a price table. Body shape per the API reference. HTTP: DELETE /products/price-tables/{table_id}/categories Required scope: write_products API version: 2025-03

List variants assigned to a price table. HTTP: GET /products/price-tables/{table_id}/variants Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Assign variants to a price table. Body shape per the API reference. HTTP: POST /products/price-tables/{table_id}/variants Required scope: write_products API version: 2025-03

Update variants entries of a price table (e.g. prices). Body shape per the API reference. HTTP: PUT /products/price-tables/{table_id}/variants Required scope: write_products API version: 2025-03

Remove variants from a price table. Body shape per the API reference. HTTP: DELETE /products/price-tables/{table_id}/variants Required scope: write_products API version: 2025-03

List customers assigned to a price table. HTTP: GET /products/price-tables/{table_id}/customers Required scope: read_products API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Assign customers to a price table. Body shape per the API reference. HTTP: POST /products/price-tables/{table_id}/customers Required scope: write_products API version: 2025-03

Remove customers from a price table. Body shape per the API reference. HTTP: DELETE /products/price-tables/{table_id}/customers Required scope: write_products API version: 2025-03

List orders. Hard cap: page * per_page must be <= 10000 — for deeper history slice by created_at/updated_at ranges or use since_id. HTTP: GET /orders Required scope: read_orders API version: 2025-03 (unstable if noted) Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one order. Note: products[].id values are 64-bit; they are returned as-is (treat as strings). HTTP: GET /orders/{id} Required scope: read_orders API version: 2025-03 (unstable if noted)

Create an order (e.g. for imports or manual sales). Check inventory_behaviour to control stock. HTTP: POST /orders Required scope: write_orders API version: 2025-03

Update an order's owner_note, status or gateway_link. HTTP: PUT /orders/{id} Required scope: write_orders API version: 2025-03

Close (archive) an open order. HTTP: POST /orders/{id}/close Required scope: write_orders API version: 2025-03

Re-open a closed order. HTTP: POST /orders/{id}/open Required scope: write_orders API version: 2025-03

Cancel an order. Irreversible; can email the buyer and restock inventory. HTTP: POST /orders/{id}/cancel Required scope: write_orders API version: 2025-03

Get the history of financial values of an edited order. HTTP: GET /orders/{id}/history/values Required scope: read_orders API version: 2025-03

Get the log of product/quantity edits applied to an order. HTTP: GET /orders/{id}/history/editions Required scope: read_orders API version: 2025-03

List subscriptions linked to an order. HTTP: GET /orders/{id}/subscriptions Required scope: read_orders API version: 2025-03

List invoices attached to an order. HTTP: GET /orders/{id}/invoices Required scope: read_orders API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Attach an invoice to an order. Body per the API reference. HTTP: POST /orders/{id}/invoices Required scope: write_orders API version: 2025-03

List draft orders. HTTP: GET /draft_orders Required scope: read_draft_orders API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get a draft order. HTTP: GET /draft_orders/{id} Required scope: read_draft_orders API version: 2025-03

Create a draft order. The response includes a checkout_url to share with the buyer. HTTP: POST /draft_orders Required scope: write_draft_orders API version: 2025-03

Update a draft order. HTTP: PUT /draft_orders/{id} Required scope: write_draft_orders API version: 2025-03

Convert a draft order into a real confirmed Order. HTTP: POST /draft_orders/{id}/confirm Required scope: write_draft_orders API version: 2025-03

Delete a draft order. HTTP: DELETE /draft_orders/{id} Required scope: write_draft_orders API version: 2025-03

List fulfillment orders of an order (modern way to manage packing, dispatch and tracking). HTTP: GET /orders/{order_id}/fulfillment-orders Required scope: read_fulfillment_orders API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one fulfillment order. HTTP: GET /orders/{order_id}/fulfillment-orders/{id} Required scope: read_fulfillment_orders API version: 2025-03

Update fulfillment status, tracking info and customer notification. HTTP: PATCH /orders/{order_id}/fulfillment-orders/{id} Required scope: write_fulfillment_orders API version: 2025-03

Delete a fulfillment order. HTTP: DELETE /orders/{order_id}/fulfillment-orders/{id} Required scope: write_fulfillment_orders API version: 2025-03

Add a tracking event to a fulfillment order. HTTP: POST /orders/{order_id}/fulfillment-orders/{id}/tracking-events Required scope: write_fulfillment_orders API version: 2025-03

Update a tracking event. HTTP: PUT /orders/{order_id}/fulfillment-orders/{id}/tracking-events/{event_id} Required scope: write_fulfillment_orders API version: 2025-03

Delete a tracking event. HTTP: DELETE /orders/{order_id}/fulfillment-orders/{id}/tracking-events/{event_id} Required scope: write_fulfillment_orders API version: 2025-03

Get the state and contents of an active cart. HTTP: GET /carts/{id} Required scope: read_orders API version: 2025-03

Remove one line item from an active cart. HTTP: DELETE /carts/{id}/line-items/{line_item_id} Required scope: write_orders API version: 2025-03

Remove a coupon applied to an active cart. HTTP: DELETE /carts/{id}/coupons/{coupon_id} Required scope: write_orders API version: 2025-03

List abandoned checkouts (abandoned > 6 hours ago, up to 30 days back). HTTP: GET /checkouts Required scope: read_orders API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one abandoned checkout. HTTP: GET /checkouts/{id} Required scope: read_orders API version: 2025-03

Attach a coupon to an abandoned checkout (recovery campaigns). HTTP: POST /checkouts/{id}/coupon Required scope: write_orders API version: 2025-03

List customers. HTTP: GET /customers Required scope: read_customers API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one customer. HTTP: GET /customers/{id} Required scope: read_customers API version: 2025-03

Create a customer. HTTP: POST /customers Required scope: write_customers API version: 2025-03

Update a customer. HTTP: PUT /customers/{id} Required scope: write_customers API version: 2025-03

Delete a customer. Only possible if the customer has no orders. HTTP: DELETE /customers/{id} Required scope: write_customers API version: 2025-03

List coupons. HTTP: GET /coupons Required scope: read_coupons API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one coupon. HTTP: GET /coupons/{id} Required scope: read_coupons API version: 2025-03

Create a discount coupon. HTTP: POST /coupons Required scope: write_coupons API version: 2025-03

Update a coupon. HTTP: PUT /coupons/{id} Required scope: write_coupons API version: 2025-03

Delete a coupon. HTTP: DELETE /coupons/{id} Required scope: write_coupons API version: 2025-03

List automatic promotions (2x1, 3x2, volume discounts...). HTTP: GET /promotions Required scope: read_discounts API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one promotion. HTTP: GET /promotions/{id} Required scope: read_discounts API version: 2025-03

Create an automatic cart/catalog promotion. Body per the Discount API reference. HTTP: POST /promotions Required scope: write_discounts API version: 2025-03

Delete a promotion. HTTP: DELETE /promotions/{id} Required scope: write_discounts API version: 2025-03

Register/replace the external callback used to compute dynamic discounts. HTTP: PUT /discounts/callbacks Required scope: write_discounts API version: 2025-03

Remove the registered discount callback. HTTP: DELETE /discounts/callbacks Required scope: write_discounts API version: 2025-03

List locations (branches / distribution centers). HTTP: GET /locations Required scope: read_locations API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one location. HTTP: GET /locations/{id} Required scope: read_locations API version: 2025-03

Create a location. HTTP: POST /locations Required scope: write_locations API version: 2025-03

Update a location. HTTP: PUT /locations/{id} Required scope: write_locations API version: 2025-03

Delete a location. HTTP: DELETE /locations/{id} Required scope: write_locations API version: 2025-03

Set the order in which locations are used to deduct stock. HTTP: PATCH /locations/priorities Required scope: write_locations API version: 2025-03

Mark a location as the default one. HTTP: PATCH /locations/{id}/chosen-as-default Required scope: write_locations API version: 2025-03

List stock levels of variants at one location. HTTP: GET /locations/{id}/inventory-levels Required scope: read_locations API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

List shipping carriers registered by the app. HTTP: GET /shipping_carriers Required scope: read_shipping API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one shipping carrier. HTTP: GET /shipping_carriers/{id} Required scope: read_shipping API version: 2025-03

Register a shipping carrier with a live-rate callback. HTTP: POST /shipping_carriers Required scope: write_shipping API version: 2025-03

Update a shipping carrier. HTTP: PUT /shipping_carriers/{id} Required scope: write_shipping API version: 2025-03

Delete a shipping carrier. HTTP: DELETE /shipping_carriers/{id} Required scope: write_shipping API version: 2025-03

List options of a shipping carrier. HTTP: GET /shipping_carriers/{carrier_id}/options Required scope: read_shipping API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one carrier option. HTTP: GET /shipping_carriers/{carrier_id}/options/{option_id} Required scope: read_shipping API version: 2025-03

Create a carrier option. Body per the API reference. HTTP: POST /shipping_carriers/{carrier_id}/options Required scope: write_shipping API version: 2025-03

Update a carrier option. HTTP: PUT /shipping_carriers/{carrier_id}/options/{option_id} Required scope: write_shipping API version: 2025-03

Delete a carrier option. HTTP: DELETE /shipping_carriers/{carrier_id}/options/{option_id} Required scope: write_shipping API version: 2025-03

List legacy fulfillment events of an order (prefer fulfillment orders). HTTP: GET /orders/{order_id}/fulfillments Required scope: read_shipping API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get a legacy fulfillment event. HTTP: GET /orders/{order_id}/fulfillments/{id} Required scope: read_shipping API version: 2025-03

Create a legacy fulfillment event (e.g. shipped with tracking). HTTP: POST /orders/{order_id}/fulfillments Required scope: write_shipping API version: 2025-03

Delete a legacy fulfillment event. HTTP: DELETE /orders/{order_id}/fulfillments/{id} Required scope: write_shipping API version: 2025-03

Create or replace conditional business rules that filter payment methods, carriers, locations or cart behaviour at checkout. HTTP: PUT /business_rules/integrations/{domain} Required scope: write_shipping (domain shipping) | read_payment_options (payments) | write_locations (location) | write_orders (cart) API version: 2025-03

List payment providers registered by the app. HTTP: GET /payment_providers Required scope: read_payments API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one payment provider. HTTP: GET /payment_providers/{id} Required scope: read_payments API version: 2025-03

Register a payment provider. HTTP: POST /payment_providers Required scope: write_payments API version: 2025-03

Update a payment provider. HTTP: PUT /payment_providers/{id} Required scope: write_payments API version: 2025-03

Delete a payment provider. HTTP: DELETE /payment_providers/{id} Required scope: write_payments API version: 2025-03

List the payment options available in the store. HTTP: GET /payment-options Required scope: read_payment_options API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

List the options of the app's payment providers. HTTP: GET /payment_providers/options Required scope: read_payments API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

List payment transactions of an order. HTTP: GET /orders/{order_id}/transactions Required scope: read_payments API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one transaction. HTTP: GET /orders/{order_id}/transactions/{id} Required scope: read_payments API version: 2025-03

Record a financial transaction (authorization, capture, charge, refund, void) on an order. HTTP: POST /orders/{order_id}/transactions Required scope: write_payments API version: 2025-03

Add a lifecycle event to an existing transaction. HTTP: POST /orders/{order_id}/transactions/{transaction_id}/events Required scope: write_payments API version: 2025-03

Open a dispute/chargeback on a transaction. HTTP: POST /orders/{order_id}/transactions/{transaction_id}/disputes Required scope: write_payments API version: 2025-03

Update a dispute (status, evidence...). HTTP: PUT /orders/{order_id}/transactions/{transaction_id}/disputes/{dispute_id} Required scope: write_payments API version: 2025-03

Get a dispute. HTTP: GET /orders/{order_id}/transactions/{transaction_id}/disputes/{dispute_id} Required scope: read_payments API version: 2025-03

List external fiscal invoices of an order (unstable API; per_page max 50). HTTP: GET /orders/{order_id}/invoices/external Required scope: read_orders API version: unstable Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get an external invoice by fiscal key. HTTP: GET /orders/{order_id}/invoices/external/{key} Required scope: read_orders API version: unstable

Attach an external fiscal invoice (NFe/CAE...) to an order (unstable API). HTTP: POST /orders/{order_id}/invoices/external Required scope: write_orders API version: unstable

Update an external invoice (unstable API). HTTP: PUT /orders/{order_id}/invoices/external/{key} Required scope: write_orders API version: unstable

Delete an external invoice (unstable API). HTTP: DELETE /orders/{order_id}/invoices/external/{key} Required scope: write_orders API version: unstable

Create an app billing plan. HTTP: POST /plans Required scope: write_plans API version: 2025-03

Update an app billing plan. HTTP: PATCH /plans/{plan_id} Required scope: write_plans API version: 2025-03

Delete an app billing plan. HTTP: DELETE /plans/{plan_id} Required scope: write_plans API version: 2025-03

Get the store's subscription(s) for an app service. HTTP: GET /concepts/app-cost/services/{service_id}/subscriptions Required scope: read_subscriptions API version: 2025-03

Update the store's subscription for an app service. HTTP: PATCH /concepts/app-cost/services/{service_id}/subscriptions Required scope: write_subscriptions API version: 2025-03

Create a one-off or usage charge for an app service. HTTP: POST /services/{service_id}/charges Required scope: write_charges API version: 2025-03

List store pages (about, FAQ, policies...). HTTP: GET /pages Required scope: read_content API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one page. HTTP: GET /pages/{pageID} Required scope: read_content API version: 2025-03

Create a page. HTTP: POST /pages Required scope: write_content API version: 2025-03

Update a page. HTTP: PUT /pages/{pageID} Required scope: write_content API version: 2025-03

Delete a page. HTTP: DELETE /pages/{pageID} Required scope: write_content API version: 2025-03

List blogs of the store. HTTP: GET /blogs Required scope: read_content API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

List posts of a blog. HTTP: GET /blogs/{blog_id}/posts Required scope: read_content API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

List transactional email templates. HTTP: GET /email-templates Required scope: read_email_templates API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one email template. HTTP: GET /email-templates/{templateID} Required scope: read_email_templates API version: 2025-03

Update an email template's subject and HTML. HTTP: PUT /email-templates/{templateID} Required scope: write_email_templates API version: 2025-03

List scripts associated with the store. HTTP: GET /scripts Required scope: none (any valid token) API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get a script association. HTTP: GET /scripts/{id} Required scope: none (any valid token) API version: 2025-03

Associate a Partner Portal script with the store. HTTP: POST /scripts Required scope: write_scripts API version: 2025-03

Update a store's script association/parameters. HTTP: PUT /scripts/{id} Required scope: write_scripts API version: 2025-03

Remove a script from the store. HTTP: DELETE /scripts/{id} Required scope: write_scripts API version: 2025-03

List metafields of a resource type, optionally filtered by owner/namespace/key/value. HTTP: GET /metafields/{owner_resource} Required scope: read_*/write_* matching owner_resource: products (Product, Product_Variant, Category) | content (Page) | orders (Order) | customers (Customer) API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one metafield. HTTP: GET /metafields/{id} Required scope: read_*/write_* matching owner_resource: products (Product, Product_Variant, Category) | content (Page) | orders (Order) | customers (Customer) API version: 2025-03

Create a metafield. HTTP: POST /metafields Required scope: read_*/write_* matching owner_resource: products (Product, Product_Variant, Category) | content (Page) | orders (Order) | customers (Customer) API version: 2025-03

Update a metafield. HTTP: PUT /metafields/{id} Required scope: read_*/write_* matching owner_resource: products (Product, Product_Variant, Category) | content (Page) | orders (Order) | customers (Customer) API version: 2025-03

Delete a metafield. HTTP: DELETE /metafields/{id} Required scope: read_*/write_* matching owner_resource: products (Product, Product_Variant, Category) | content (Page) | orders (Order) | customers (Customer) API version: 2025-03

Define a custom field for an entity. HTTP: POST /{entity}/custom-fields Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03

List custom field definitions of an entity. HTTP: GET /{entity}/custom-fields Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one custom field definition. HTTP: GET /{entity}/custom-fields/{custom_field_id} Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03

Update a custom field definition. HTTP: PUT /{entity}/custom-fields/{custom_field_id} Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03

Delete a custom field definition (and its values). HTTP: DELETE /{entity}/custom-fields/{custom_field_id} Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03

Get the custom field values of one entity instance (e.g. one product). HTTP: GET /{entity}/{entity_id}/custom-fields Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03

List entity instances that have a value for a custom field. HTTP: GET /{entity}/custom-fields/{custom_field_id}/owners Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Set custom field values on one entity instance. HTTP: PUT /{entity}/{entity_id}/custom-fields/values Required scope: read_products/write_products (categories, products, products/variants) | read_customers/write_customers (customers) | read_orders/write_orders (orders) API version: 2025-03

Create a custom field definition (unstable API). HTTP: POST /{entity}/custom-fields Required scope: read_products/write_products API version: unstable

List custom field definitions (unstable API). HTTP: GET /{entity}/custom-fields Required scope: read_products/write_products API version: unstable Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get a custom field definition by namespace/slug (unstable API). HTTP: GET /{entity}/custom-fields/{namespace}/{slug} Required scope: read_products/write_products API version: unstable

Delete a custom field definition (unstable API). HTTP: DELETE /{entity}/custom-fields/{namespace}/{slug} Required scope: read_products/write_products API version: unstable

List capabilities of a custom field definition (unstable API). HTTP: GET /{entity}/custom-fields/{namespace}/{slug}/capabilities Required scope: read_products/write_products API version: unstable

Add a capability to a custom field definition (unstable API). HTTP: POST /{entity}/custom-fields/{namespace}/{slug}/capabilities Required scope: read_products/write_products API version: unstable

Remove a capability from a custom field definition (unstable API). HTTP: DELETE /{entity}/custom-fields/{namespace}/{slug}/capabilities Required scope: read_products/write_products API version: unstable

Create a custom object definition (unstable API). HTTP: POST /custom-objects Required scope: read_products/write_products API version: unstable

List custom object definitions (unstable API). HTTP: GET /custom-objects Required scope: read_products/write_products API version: unstable Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get a custom object definition (unstable API). HTTP: GET /custom-objects/{namespace}/{slug} Required scope: read_products/write_products API version: unstable

Update a custom object definition (unstable API). HTTP: PUT /custom-objects/{namespace}/{slug} Required scope: read_products/write_products API version: unstable

Delete a custom object definition (unstable API). HTTP: DELETE /custom-objects/{namespace}/{slug} Required scope: read_products/write_products API version: unstable

Create an entry in a custom object (unstable API). HTTP: POST /custom-objects/{namespace}/{slug}/entries Required scope: read_products/write_products API version: unstable

List entries of a custom object (unstable API). HTTP: GET /custom-objects/{namespace}/{slug}/entries Required scope: read_products/write_products API version: unstable Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one custom object entry (unstable API). HTTP: GET /custom-objects/{namespace}/{slug}/entries/{entrySlug} Required scope: read_products/write_products API version: unstable

Update a custom object entry (unstable API). HTTP: PUT /custom-objects/{namespace}/{slug}/entries/{entrySlug} Required scope: read_products/write_products API version: unstable

Delete a custom object entry (unstable API). HTTP: DELETE /custom-objects/{namespace}/{slug}/entries/{entrySlug} Required scope: read_products/write_products API version: unstable

List webhooks registered by the app. HTTP: GET /webhooks Required scope: scope of the event's entity (none for app/* and GDPR events) API version: 2025-03 Returns {count, page, per_page, total?, has_more, next_page?, items[]}.

Get one webhook. HTTP: GET /webhooks/{id} Required scope: scope of the event's entity API version: 2025-03

Subscribe an HTTPS URL to a store event. HTTP: POST /webhooks Required scope: scope of the event's entity (none for app/* and GDPR events) API version: 2025-03

Change a webhook's URL or event. HTTP: PUT /webhooks/{id} Required scope: scope of the event's entity API version: 2025-03

Delete a webhook. HTTP: DELETE /webhooks/{id} Required scope: scope of the event's entity API version: 2025-03

Exchange the temporary OAuth 'code' (received on the app's redirect URL as ?code=...) for the permanent access_token. The response includes access_token, token_type, scope (granted scopes) and user_id — which is the store_id to use as TIENDANUBE_STORE_ID. Tokens do not expire unless the app is uninstalled or the token is rotated. The code is single-use and short-lived. Requires client credentials: pass client_id/client_secret or set TIENDANUBE_CLIENT_ID / TIENDANUBE_CLIENT_SECRET. Does not need a store access token. HTTP: POST https://www.tiendanube.com/apps/authorize/token (or nuvemshop.com.br).