Skip to content

Developers

API reference

This is the complete reference of the RapBooster platform API, generated from the same OpenAPI document as @rapbooster/sdk. Each endpoint lists its key scope, parameters, request body, responses and schemas, with curl, JavaScript and Python samples. Paste a test key to send a real request from this page.

128 endpoints · version 1

Reference

Endpoints

Kept on this page only, never saved. Test keys only: a publishable test key works from an allowed origin (http://localhost on test keys).

Store API

GET/api/v1/public/v1/store#

The store: name, legal and support details, checkout and shipping settings

Stablepublishable or secret key with storefront

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
POST/api/v1/public/v1/store/auth/apple#

Sign in with an Apple ID token

Stablepublishable or secret key with storefront

Body application/json StoreApiAppleSignInDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/auth/apple" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"id_token":"string"}'
Paste a test key above first.
POST/api/v1/public/v1/store/auth/google#

Sign in with a Google ID token

Stablepublishable or secret key with storefront

Body application/json StoreApiGoogleSignInDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/auth/google" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"id_token":"string"}'
Paste a test key above first.
POST/api/v1/public/v1/store/auth/logout#

End the session of a refresh token

Stablepublishable or secret key with storefront

Body application/json StoreApiRefreshDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/auth/logout" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"refresh_token":"string"}'
Paste a test key above first.
POST/api/v1/public/v1/store/auth/otp#

Send a sign-in code to a phone

Stablepublishable or secret key with storefront

Body application/json StoreApiOtpRequestDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/auth/otp" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+919876543210"}'
Paste a test key above first.
POST/api/v1/public/v1/store/auth/otp/verify#

Check the code: signs the buyer in (or up)

Stablepublishable or secret key with storefrontX-Buyer-Token

With the X-Buyer-Token of a buyer who signed in with Google or Apple, the proven phone is linked to that buyer.

Body application/json StoreApiOtpVerifyDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/auth/otp/verify" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","phone":"string","request_id":"string","terms_accepted":true}'
Paste a test key above first.
POST/api/v1/public/v1/store/auth/refresh#

Swap a refresh token for a new pair (the old one stops working)

Stablepublishable or secret key with storefront

Body application/json StoreApiRefreshDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/auth/refresh" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"refresh_token":"string"}'
Paste a test key above first.
GET/api/v1/public/v1/store/buyers/{id}#

A buyer (secret key with store:write)

Stablepublishable or secret key with storefront

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/buyers/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
PUT/api/v1/public/v1/store/buyers/{id}/groups#

Set a buyer's groups (offer eligibility, e.g. patron)

Stablepublishable or secret key with storefront

Lowercase slugs, at most 10; the list replaces the buyer's groups.

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json StoreApiBuyerGroupsDto

Try it and code samples
curl -X PUT "https://api.rapbooster.com/api/v1/public/v1/store/buyers/{id}/groups" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"groups":["patron"]}'
Paste a test key above first.
POST/api/v1/public/v1/store/carts#

Start a cart (attached to the buyer when signed in)

Stablepublishable or secret key with storefrontX-Buyer-Token

Body application/json StoreApiCartCreateDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/carts" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
GET/api/v1/public/v1/store/carts/{cartId}#

A cart, priced now

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/carts/{cartId}/attach#

Attach a guest cart to the signed-in buyer (merged into their open cart)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring
Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}/attach" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
DELETE/api/v1/public/v1/store/carts/{cartId}/coupon#

Remove the coupon

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring
Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}/coupon" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
POST/api/v1/public/v1/store/carts/{cartId}/coupon#

Apply a coupon code (422 COUPON_INVALID with details.reason)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring

Body application/json StoreApiCouponDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}/coupon" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"NAMKEEN10"}'
Paste a test key above first.
PUT/api/v1/public/v1/store/carts/{cartId}/delivery#

Set the delivery address or PIN code (shipping fee, ETA)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring

Body application/json StoreApiCartDeliveryDto

Try it and code samples
curl -X PUT "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}/delivery" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
PUT/api/v1/public/v1/store/carts/{cartId}/gift#

Mark the order a gift, with a message (≤ 300)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring

Body application/json StoreApiCartGiftDto

Try it and code samples
curl -X PUT "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}/gift" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"is_gift":true}'
Paste a test key above first.
PUT/api/v1/public/v1/store/carts/{cartId}/lines#

Replace the cart's lines

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
cartId requiredpathstring

Body application/json StoreApiCartLinesDto

Try it and code samples
curl -X PUT "https://api.rapbooster.com/api/v1/public/v1/store/carts/{cartId}/lines" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"lines":[{}]}'
Paste a test key above first.
GET/api/v1/public/v1/store/categories#

The store's categories

Stablepublishable or secret key with storefront

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/categories" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
POST/api/v1/public/v1/store/checkout#

Place the order: Razorpay order to pay in-page, or trade credit

Stablepublishable or secret key with storefrontX-Buyer-TokenIdempotency-Key required

Parameters
NameInTypeAbout
Idempotency-Key requiredheaderstringUnique per checkout attempt.

Body application/json StoreApiCheckoutDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/checkout" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"address_id":"string","cart_id":"string","channel":"web","consent":{"terms":true},"payment_method":"razorpay"}'
Paste a test key above first.
POST/api/v1/public/v1/store/checkout/{number}/confirm#

Confirm the in-page Razorpay payment (signature check)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
number requiredpathstring

Body application/json StoreApiPaymentConfirmDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/checkout/{number}/confirm" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"razorpay_order_id":"string","razorpay_payment_id":"string","razorpay_signature":"string"}'
Paste a test key above first.
GET/api/v1/public/v1/store/feeds/merchant.xml#

Google Merchant Center feed (RSS 2.0) of the visible products

Stablepublishable or secret key with storefront

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/feeds/merchant.xml" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
DELETE/api/v1/public/v1/store/me#

Erase the buyer's account (DPDP); orders keep their tax records

Stablepublishable or secret key with storefrontX-Buyer-Token

Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/store/me" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
GET/api/v1/public/v1/store/me#

The signed-in buyer

Stablepublishable or secret key with storefrontX-Buyer-Token

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
PATCH/api/v1/public/v1/store/me#

Change the buyer's name, email or consents

Stablepublishable or secret key with storefrontX-Buyer-Token

Body application/json StoreApiBuyerUpdateDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/public/v1/store/me" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
GET/api/v1/public/v1/store/me/addresses#

The buyer's addresses

Stablepublishable or secret key with storefrontX-Buyer-Token

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/addresses" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/addresses#

Add an address

Stablepublishable or secret key with storefrontX-Buyer-Token

Body application/json StoreApiAddressInputDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/addresses" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"city":"string","line1":"string","name":"string","postal_code":"334001","state":"string"}'
Paste a test key above first.
DELETE/api/v1/public/v1/store/me/addresses/{id}#

Delete an address

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/store/me/addresses/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
PATCH/api/v1/public/v1/store/me/addresses/{id}#

Change an address

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json StoreApiAddressUpdateDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/public/v1/store/me/addresses/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
GET/api/v1/public/v1/store/me/claims#

The buyer's claims, newest first

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/claims" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/devices#

Register an app install for push (order updates; offers when opted in)

Stablepublishable or secret key with storefrontX-Buyer-Token

Body application/json StoreApiDeviceDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/devices" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expo_push_token":"string","offers_opt_in":true,"platform":"ios"}'
Paste a test key above first.
DELETE/api/v1/public/v1/store/me/devices/{token}#

Forget an app install

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
token requiredpathstring
Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/store/me/devices/{token}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
POST/api/v1/public/v1/store/me/export#

Email the buyer a JSON export of their data within 24 h (once a day)

Stablepublishable or secret key with storefrontX-Buyer-Token

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/export" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
GET/api/v1/public/v1/store/me/orders#

The buyer's orders, newest first

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
statusquery"awaiting_payment" | "paid" | "packed" | "shipped" | "delivered" | "cancelled" | "refunded" | "partially_refunded"
sort_byquery"placed_at" | "total_minor"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/orders" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
GET/api/v1/public/v1/store/me/orders/{number}#

One order with its shipments, claims and invoice

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
number requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/orders/{number}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/orders/{number}/claims#

Report a damaged, wrong or missing item (409 CLAIM_WINDOW_CLOSED after 48 h)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
number requiredpathstring

Body application/json StoreApiClaimCreateDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/orders/{number}/claims" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"kind":"damaged","lines":[{}],"upload_ids":["string"]}'
Paste a test key above first.
GET/api/v1/public/v1/store/me/orders/{number}/invoice#

A signed link (10 minutes) to the order's GST invoice PDF

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
number requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/orders/{number}/invoice" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/orders/{number}/reorder#

Put the order's items in the buyer's cart again

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
number requiredpathstring
Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/orders/{number}/reorder" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
GET/api/v1/public/v1/store/me/reviews#

The buyer's reviews

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/reviews" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/reviews#

Review a delivered product (status pending until moderated)

Stablepublishable or secret key with storefrontX-Buyer-Token

Only a product of the buyer's own delivered order (403 REVIEW_NOT_ALLOWED), once per order and product (409 REVIEW_EXISTS); photos are the buyer's review uploads (400 REVIEW_UPLOAD_INVALID). Title and body are plain text.

Body application/json StoreApiReviewCreateDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/reviews" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"order_number":"string","product_id":"string","rating":1}'
Paste a test key above first.
GET/api/v1/public/v1/store/me/subscriptions#

The buyer's subscriptions

Stablepublishable or secret key with storefrontX-Buyer-Token

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/subscriptions#

Subscribe (box: interval, lines, address; plan: plan_code); returns the Razorpay ids

Stablepublishable or secret key with storefrontX-Buyer-TokenIdempotency-Key required

Parameters
NameInTypeAbout
Idempotency-Key requiredheaderstringUnique per attempt.

Body application/json StoreApiSubscriptionCreateDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
PATCH/api/v1/public/v1/store/me/subscriptions/{id}#

Change a box's interval, lines or address

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json StoreApiSubscriptionUpdateDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
POST/api/v1/public/v1/store/me/subscriptions/{id}/cancel#

Cancel a subscription

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions/{id}/cancel" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
POST/api/v1/public/v1/store/me/subscriptions/{id}/pause#

Pause a subscription

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions/{id}/pause" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
POST/api/v1/public/v1/store/me/subscriptions/{id}/resume#

Resume a paused subscription

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions/{id}/resume" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
POST/api/v1/public/v1/store/me/subscriptions/{id}/skip#

Skip the next delivery

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/subscriptions/{id}/skip" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
GET/api/v1/public/v1/store/me/trade#

The buyer's trade account (404 when they never applied)

Stablepublishable or secret key with storefrontX-Buyer-Token

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/trade" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/trade/apply#

Apply for a trade account with a GSTIN

Stablepublishable or secret key with storefrontX-Buyer-Token

The GSTIN must pass the format and mod-36 check and name the address's state (400 TRADE_GSTIN_INVALID, details.reason). A second application while one is open is 409 TRADE_ALREADY_APPLIED; after a rejection the buyer may apply again.

Body application/json StoreApiTradeApplyDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/trade/apply" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"address_id":"string","business_name":"string","business_type":"retailer","gstin":"string"}'
Paste a test key above first.
GET/api/v1/public/v1/store/me/trade/ledger#

The trade account's ledger: invoices, payments, credit notes

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/trade/ledger" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
POST/api/v1/public/v1/store/me/uploads#

Upload a photo for a claim or a review (jpeg / png / webp, at most 5 MB)

Stablepublishable or secret key with storefrontX-Buyer-Token

Body multipart/form-data StoreApiUploadFormDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/store/me/uploads" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
GET/api/v1/public/v1/store/me/wishlist#

The buyer's wishlist

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/me/wishlist" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
DELETE/api/v1/public/v1/store/me/wishlist/{productId}#

Remove a product from the wishlist

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
productId requiredpathstring
Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/store/me/wishlist/{productId}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
PUT/api/v1/public/v1/store/me/wishlist/{productId}#

Add a product to the wishlist

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
productId requiredpathstring
Try it and code samples
curl -X PUT "https://api.rapbooster.com/api/v1/public/v1/store/me/wishlist/{productId}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
GET/api/v1/public/v1/store/policies/{kind}#

One policy page (refund, shipping, terms, privacy, returns)

Stablepublishable or secret key with storefront

Parameters
NameInTypeAbout
kind requiredpath"refund" | "shipping" | "terms" | "privacy" | "returns"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/policies/{kind}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
GET/api/v1/public/v1/store/products#

Visible products (q, category, sort_by, in_stock, updated_since; page, limit ≤ 100)

Stablepublishable or secret key with storefront

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
categoryquerystringA category slug.
sort_byquery"featured" | "price_asc" | "price_desc" | "newest" | "rating"
in_stockqueryboolean
updated_sincequerystring (date-time)Only products changed since (sitemaps, sync).
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/products" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
GET/api/v1/public/v1/store/products/{slug}#

One product with its variants (an approved trade buyer sees trade prices)

Stablepublishable or secret key with storefrontX-Buyer-Token

Parameters
NameInTypeAbout
slug requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/products/{slug}" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY" \
  -H "X-Buyer-Token: $BUYER_TOKEN"
Paste a test key above first.
GET/api/v1/public/v1/store/products/{slug}/reviews#

A product's published reviews (rating filter; page, limit)

Stablepublishable or secret key with storefront

Parameters
NameInTypeAbout
slug requiredpathstring
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
ratingquerynumber
sort_byquery"created_at" | "rating"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/products/{slug}/reviews" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
GET/api/v1/public/v1/store/shipping/quote#

Is the PIN code served, the fee, free-above and the ETA

Stablepublishable or secret key with storefront

With cart_id the fee and ETA are for that cart (its goods total and weight); else for weight_g (or the store's default weight) and the base fee. 422 PINCODE_NOT_SERVICEABLE when no courier serves it.

Parameters
NameInTypeAbout
pincode requiredquerystring
cart_idquerystring
weight_gquerynumber
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/shipping/quote" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.
GET/api/v1/public/v1/store/subscription-plans#

What a buyer may subscribe to: box intervals and recurring catalogue prices

Stablepublishable or secret key with storefront

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/store/subscription-plans" \
  -H "Authorization: Bearer $RAPBOOSTER_PUBLISHABLE_KEY"
Paste a test key above first.

Contacts

GET/api/v1/public/v1/marketing/contacts#

List people (q, group_id; sort_by, sort; page, limit)

Stable

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
group_idquerystringOnly people in this group.
sort_byquery"name" | "email" | "phone" | "country_code" | "created_at" | "updated_at"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/marketing/contacts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/public/v1/marketing/contacts#

Add a person: a known email or phone returns that person (`existing: true`)

Stable

Body application/json PublicContactWriteDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/marketing/contacts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
GET/api/v1/public/v1/marketing/contacts/{id}#

Get a person

Stable

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/marketing/contacts/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
PATCH/api/v1/public/v1/marketing/contacts/{id}#

Update a person (null clears a field; group_ids replaces groups)

Stable

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json PublicContactWriteDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/public/v1/marketing/contacts/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.

Leads

GET/api/v1/public/v1/crm/leads#

List leads (q, status; sort_by, sort; page, limit)

Stable

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
statusquerystringA lead status name from the workspace's list (Leads settings › Statuses), any case.
sort_byquery"name" | "status" | "created_at" | "updated_at"Default: created_at, newest first.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/crm/leads" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/public/v1/crm/leads#

Create a lead (owned by the key's creator)

Stable

Body application/json PublicCreateLeadDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/crm/leads" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'
Paste a test key above first.
GET/api/v1/public/v1/crm/leads/{id}#

Get a lead

Stable

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/crm/leads/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
PATCH/api/v1/public/v1/crm/leads/{id}#

Update a lead's name, mobile, email, status or location (city, state, country_code)

Stable

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json PublicUpdateLeadDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/public/v1/crm/leads/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.

Messages

GET/api/v1/public/v1/inbox/messages/{channel}/{id}#

A sent message's delivery status

Stable

Parameters
NameInTypeAbout
channel requiredpath"whatsapp" | "email"
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/inbox/messages/{channel}/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/public/v1/inbox/messages/email#

Send one email from a connection (default: the system one)

Stable

Body application/json PublicSendEmailDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/inbox/messages/email" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"subject":"string","text":"string","to":"string"}'
Paste a test key above first.
POST/api/v1/public/v1/inbox/messages/whatsapp#

Send an approved WhatsApp template to a number

Stable

From phone_number_id or the campaign default number; the key's creator must have access to that number. Delivery updates arrive as message.status webhooks.

Body application/json PublicSendWhatsappDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/inbox/messages/whatsapp" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"template_id":"string","to":"+919876543210"}'
Paste a test key above first.

Webhooks

GET/api/v1/public/v1/webhook-endpoints#

List webhook endpoints

Stable

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/webhook-endpoints" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/public/v1/webhook-endpoints#

Add an endpoint (https): its signing secret is in this response only

Stable

Body application/json CreateWebhookEndpointDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/webhook-endpoints" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"events":["lead.created"],"url":"https://example.com/hooks/rapbooster"}'
Paste a test key above first.
DELETE/api/v1/public/v1/webhook-endpoints/{id}#

Delete an endpoint

Stable

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/webhook-endpoints/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
PATCH/api/v1/public/v1/webhook-endpoints/{id}#

Change an endpoint's URL or events, or turn it off and on

Stable

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json UpdateWebhookEndpointDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/public/v1/webhook-endpoints/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.

Billing - Invoices

GET/api/v1/billing/invoices#

List quotes, proformas and tax invoices (filters, q = number or buyer)

Betascope billing:read

Own + team (RP26) unless the role has Everyone (billing:sales-reach-all): documents credited to the caller or below them, else created by them. With leadId (the lead page) every document of the lead.

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
doc_typequery"QUOTE" | "PROFORMA" | "TAX_INVOICE"
statusquery"DRAFT" | "ISSUED" | "PARTIALLY_PAID" | "PAID" | "CANCELLED" | "EXPIRED" | "CONVERTED" | "ACCEPTED" | "DECLINED" | "CHANGES_REQUESTED" | "AWAITING_APPROVAL"
lead_idquerystring
fromquerystringCreated at or after (ISO date).
toquerystringCreated before (ISO date).
needs_attentionquerybooleanOnly documents that are overpaid or have a paid line the catalogue refused.
creditedquerystringOnly documents credited to this sales member (credited_user_id). Narrows inside the caller's own / team scope (plan 16, SPF18).
unpaidquerybooleanOnly documents waiting for payment: issued or partly paid (true).
sort_byquery"created_at" | "issued_at" | "number" | "customer" | "status" | "expires_at" | "total_minor"Field to order by. Unrecognised values fall back to this endpoint default. Default created_at (newest first). customer is the billing name.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/invoices" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/invoices/{id}#

One document with its lines

Betascope billing:read

Opening a quote a buyer answered clears its response_unseen (the sidebar badge, B23); this response still carries response_unseen: true.

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/invoices/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/invoices/credit-notes#

List credit notes (optionally for one invoice)

Betascope billing:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
invoice_idquerystring
sort_byquery"issued_at" | "number" | "status" | "total_minor"Field to order by. Unrecognised values fall back to this endpoint default. Default issued_at (newest first).
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/invoices/credit-notes" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/invoices/credit-notes/{id}#

One credit note with its lines

Betascope billing:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/invoices/credit-notes/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Billing - Offers

GET/api/v1/billing/offers#

Offers with their uses, revenue and discount cost (q = name or code)

Betascope billing:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
statusquery"active" | "paused" | "archived"Default: every status but archived.
kindquery"percent" | "flat" | "free_shipping" | "bxgy" | "tiered"
channelquery"store" | "app" | "billing" | "pos" | "plan_checkout" | "quote" | "pay_link"
sort_byquery"name" | "kind" | "status" | "starts_at" | "ends_at" | "created_at" | "uses" | "discount" | "revenue"Field to order by. Unrecognised values fall back to this endpoint default. Default created_at (newest first).
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/offers" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/offers/{id}#

One offer

Betascope billing:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/offers/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/offers/{id}/codes#

The offer's codes (q = part of a code; batch_id = one bulk batch)

Betascope billing:read

Parameters
NameInTypeAbout
id requiredpathstring
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
batch_idquerystring
sort_byquery"created_at"Field to order by. Unrecognised values fall back to this endpoint default. Newest first.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/offers/{id}/codes" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/offers/{id}/redemptions#

Where the offer was used, newest first (reversed ones carry reversed_at)

Betascope billing:read

Parameters
NameInTypeAbout
id requiredpathstring
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"created_at"Field to order by. Unrecognised values fall back to this endpoint default. Newest first.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/offers/{id}/redemptions" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/billing/offers/{id}/report#

The offer's report: uses, revenue, discount cost, per channel and per day (30 days)

Betascope billing:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/billing/offers/{id}/report" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Contact Groups

GET/api/v1/marketing/audience/groups#

List groups (the Contacts home table)

Betascope marketing:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
workspace_user_idquerystringRestrict to lists created by a user.
sort_byquery"name" | "totalContacts" | "createdAt" | "updatedAt"Field to order by. Unrecognised values fall back to this endpoint default.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/marketing/audience/groups" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/marketing/audience/groups/{id}#

Get a group (metadata + fields + usage)

Betascope marketing:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/marketing/audience/groups/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Contacts

GET/api/v1/marketing/audience/contacts#

All contacts (searched, filtered, sorted)

Betascope marketing:read

Every person; filters narrow it: group_id, tag_id, segment_id, suppressed, has_consent, has_phone, has_email.

Parameters
NameInTypeAbout
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"name" | "email" | "phone" | "country_code" | "created_at" | "updated_at"Field to sort by.
orderquery"ASC" | "DESC"Sort direction.
group_idquerystringOnly members of this group.
tag_idquerystringOnly people with this tag.
segment_idquerystringOnly people matching this saved segment.
suppressedquery"whatsapp" | "email" | "any"Only people suppressed on this channel (the Unsubscribed view).
has_consentquerybooleantrue: with a consent record; false: without.
has_phonequeryboolean
has_emailqueryboolean
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/marketing/audience/contacts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/marketing/audience/contacts/{id}#

Get a contact

Betascope marketing:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/marketing/audience/contacts/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Leads - Leads

GET/api/v1/crm/leads#

List leads (newest first by default; q, status_id, type, view filters; sortBy). Scoped to the caller's own / team leads, except that an exact phone or email in q finds any lead (LT119); leads of a type the caller lacks the key of never show (R36-45)

Betascope crm:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"name" | "status" | "created_at" | "updated_at" | "last_activity_at" | "next_followup_at" | "owner_changed_at"Field to order by. Unrecognised values fall back to this endpoint default. Default: created_at (newest first); the NEWLY_ASSIGNED / GRABBED views: owner_changed_at (oldest first).
status_idquerystringA lead status id (GET leads/lead-statuses).
vipquerybooleanDeprecated (R36-45): use type. true = type=vip, false = every type but VIP. Removed in the next release.
typequeryLeadType[]R36-45: only leads of these types (repeat the param or comma-separate). Types hidden from the caller never show either way.
viewqueryLeadViewA ready-made filter. Views over invoices, tickets or catalogue sales return nothing to a caller who can't read that app.
ownerquerystring[]Only leads these users own (assigned_user_id; repeat the param or comma-separate); none adds the leads nobody owns. Narrows inside the caller's lead scope, never widens it (plan 16, SPF18; plan 21, YP84).
stagequeryLeadStageOnly leads the data currently puts at this stage (negotiation for Performance).
openquerybooleanOnly leads in an open status category (true): not won, lost or given up.
pendingquery"demo" | "manager_call"Leads with work waiting on pending_for: demo (a scheduled demo or meeting ahead) or manager_call (a pending manager request asked of them). Needs pending_for.
pending_forquerystringThe member pending is about. Required with pending, 400 otherwise.
external_account_idquerystringExact match on external_account_id.
sourcequerystring[]crm_lead_source ids (any of).
interestquerystring[]Interested in items, as <item_type>:<item_id> (any of), e.g. saas-tools:12 or custom:3.
cityquerystring[]City of the default billing detail (any of).
statequerystring[]State of the default billing detail (any of).
tagquerystring[]crm_lead_contact_tag ids: leads with a person tagged with any of them.
lead_tagquerystring[]crm_lead_tag ids (GET leads/lead-tags): leads tagged with any of them (OC11).
created_fromquerystringCreated on or after this day (workspace timezone).
created_toquerystringCreated on or before this day.
activity_fromquerystringLast activity on or after this day.
activity_toquerystringLast activity on or before this day.
followupquery"overdue" | "today" | "week" | "none"Pending follow-up: overdue, due today, due within 7 days, or none.
demoquery"scheduled" | "done" | "no_show" | "rescheduled" | "cancelled" | "none"A demo with this status, or none: no demo at all.
billed_minqueryintegerBilled at least this much (minor units). Needs Sales access.
billed_maxqueryintegerBilled at most this much (minor units).
due_minqueryintegerUnpaid at least this much (minor units). Needs Sales access.
due_maxqueryintegerUnpaid at most this much (minor units).
renewal_productquerystring[]Renewal items by product (plan 30 RV1), any of: <item_type> (desktop-tools, saas-tools, domain-tlds, hosting-plans, services, custom for free-text lines) or <item_type>:<item_id>. On a renewal view only the items it lists count. Needs Sales access.
renewal_ends_fromquerystringA renewal item ends on or after this day (workspace timezone, RV1).
renewal_ends_toquerystring… on or before this day.
sold_throughquerystringR36-45: only the customers sold through this Reseller lead (their sold_through). Not stored in saved views.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/crm/leads" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/crm/leads/{id}#

Get a lead with its default billing detail and header fields. Any member with leads:read may open any lead (LT119)

Betascope crm:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/crm/leads/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/crm/leads/counts#

How many leads are in each status and each sidebar view

Betascope crm:read

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/crm/leads/counts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Leads - Settings

GET/api/v1/crm/leads/lead-statuses#

The workspace's lead statuses, in its order (removed ones on request)

Betascope crm:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"sort" | "name" | "created_at"Field to order by. Unrecognised values fall back to this endpoint default. Default: sort (the workspace's order).
include_archivedquerybooleanInclude removed (archived) statuses.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/crm/leads/lead-statuses" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Orders

GET/api/v1/orders#

List goods orders (status, lead, q = order number, from/to = placed)

Betascope orders:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
statusquerystringThe row's status value.
lead_idquerystring
stagequery"to_pack" | "ready_to_ship" | "in_transit" | "delivered" | "issues" | "returns"The sidebar's lists: to pack, ready to ship, in transit, delivered, issues, returns.
payment_modequery"PREPAID" | "COD"
fromquerystringPlaced at or after this instant (ISO 8601).
toquerystringPlaced before this instant (ISO 8601, exclusive).
sort_byquery"created_at" | "order_number" | "status" | "delivered_at"Field to order by. Unrecognised values fall back to this endpoint default. Default created_at (newest placed first).
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/orders" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/orders/{id}#

An order with its lines and shipments

Betascope orders:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/orders/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/orders/summary#

Overview and sidebar counts: to ship, shipped in 7 days, delivered, cancelled, to pack, ready to ship, in transit, issues, returns, COD to collect

Betascope orders:read

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/orders/summary" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Site API - CRM

POST/api/v1/public/v1/crm/enquiries#

Send a site form (contact, service, corporate gifting, trade, franchise, careers)

Stable

One lead per phone: a new one in the Enquiries pool, or the phone's existing lead (its owner gets a follow-up). Tagged per kind. With a publishable key: reCAPTCHA token required (captcha_token or X-Recaptcha-Token, 403 CAPTCHA_FAILED), 5 an hour per IP and 3 per phone (429 ENQUIRY_RATE_LIMITED), and no lead id in the answer.

Body application/json SiteApiEnquiryDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/crm/enquiries" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"consent":true,"kind":"contact","message":"string","name":"string","phone":"+919876543210"}'
Paste a test key above first.

Site API - HRMS

POST/api/v1/public/v1/hrms/applications#

Apply to an open role (CV as a PDF, at most 5 MB)

Stable

Needs verified_token from applications/otp/verify for the same phone (403 PHONE_NOT_VERIFIED; single use). The CV is checked by its bytes (400 CV_NOT_PDF, CV_TOO_LARGE, CV_REQUIRED). The applicant appears in HRMS › Recruitment with the CV; a second application by the same email to the same role answers the first one (created false).

Body multipart/form-data SiteApiApplicationFormDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/hrms/applications" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
POST/api/v1/public/v1/hrms/applications/otp#

Send a code to the applicant's phone (careers form)

Stable

Body application/json SiteApiApplyOtpDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/hrms/applications/otp" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"phone":"+919876543210"}'
Paste a test key above first.
POST/api/v1/public/v1/hrms/applications/otp/verify#

Check the code: answers a single-use phone-verified token (30 minutes)

Stable

Body application/json SiteApiApplyOtpVerifyDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/hrms/applications/otp/verify" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"code":"string","phone":"string","request_id":"string"}'
Paste a test key above first.
GET/api/v1/public/v1/hrms/jobs#

Open roles, newest first, with the JobPosting fields

Stable

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/hrms/jobs" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/public/v1/hrms/jobs/{slug}#

One open role

Stable

The slug ends with the role's id; an old slug of a renamed role still answers (compare slug to redirect). Closed, draft or unknown: 404 JOB_NOT_FOUND.

Parameters
NameInTypeAbout
slug requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/hrms/jobs/{slug}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Site API - Marketing

GET/api/v1/public/v1/marketing/campaigns#

Campaigns with their status and counts

Stable

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
statusquery"draft" | "scheduled" | "running" | "paused" | "completed" | "failed" | "cancelled"
sort_byquery"name" | "created_at" | "scheduled_at"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/marketing/campaigns" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
DELETE/api/v1/public/v1/marketing/subscriptions#

Opt a person out of an Audience group

Stable

Answers the same whether or not the person was in it.

Body application/json SiteApiUnsubscribeDto

Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/public/v1/marketing/subscriptions" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"group_id":"string"}'
Paste a test key above first.
POST/api/v1/public/v1/marketing/subscriptions#

Opt a person in to an Audience group, with the consent they gave

Stable

A known phone or email is that person (added to the group); else a new contact. Consent source, time and IP are stamped on the contact. 404 GROUP_NOT_FOUND.

Body application/json SiteApiSubscribeDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/public/v1/marketing/subscriptions" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"consent_text":"string","group_id":"string"}'
Paste a test key above first.
GET/api/v1/public/v1/marketing/templates#

Approved WhatsApp templates and ready email templates

Stable

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
channelquery"whatsapp" | "email"
sort_byquery"name" | "updated_at"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/marketing/templates" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Site API - Workspace

GET/api/v1/public/v1/workspace/profile#

Company facts: legal and brand name, CIN, GSTIN, address, logo, socials, hours

Stable

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/public/v1/workspace/profile" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Social

GET/api/v1/social/accounts#

Connected accounts (with health) and the plan's Social accounts allowance

Betascope marketing:read

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/social/accounts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/social/inbox#

Inbox threads (paged; filter by network, kind, status (default open), account, assignee)

Betascope inbox:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"last_message_at" | "created_at"Field to order by. Unrecognised values fall back to this endpoint default.
networkquery"facebook" | "instagram" | "linkedin" | "gbp" | "whatsapp_status"[]
kindquery"comment" | "dm" | "review"[]
statusquery"open" | "done" | "hidden"[]Default open.
account_idquerystring
assignedquerystringme, unassigned, or a member's user id.
post_idquerystringPlan 37: only the threads on one of our posts (social_post.id, e.g. its comments).
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/social/inbox" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/social/inbox/{id}#

One thread with its messages (oldest first, 500 at most)

Betascope inbox:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/social/inbox/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/social/posts#

Posts (paged; filter by status, account and a time range; sort by time)

Betascope marketing:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"scheduled_at" | "published_at" | "created_at" | "updated_at"Field to order by. Unrecognised values fall back to this endpoint default.
statusquery"draft" | "awaiting_approval" | "scheduled" | "publishing" | "published" | "partly_failed" | "failed" | "cancelled"[]One or several, comma-separated.
account_idquerystring
fromquerystring (date-time)
toquerystring (date-time)
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/social/posts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/social/posts#

Save a new draft

Betascope marketing:write

Body application/json SocialPostInputDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/social/posts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
GET/api/v1/social/posts/{id}#

One post with its accounts' states

Betascope marketing:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/social/posts/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/social/posts/{id}/schedule#

Schedule (a time, the next queue slot, or now), or send for approval

Betascope marketing:write

With Posts need approval on, a member without Publish directly sends it for approval (awaiting_approval: true); so does every call made with an API key (keys have no publish scope). 400 SOCIAL_POST_INVALID (details.problems), SOCIAL_NO_TARGETS, SOCIAL_SCHEDULE_IN_PAST; 409 SOCIAL_ACCOUNT_UNAVAILABLE, SOCIAL_QUEUE_FULL.

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json SocialScheduleDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/social/posts/{id}/schedule" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"mode":"at"}'
Paste a test key above first.

Store

GET/api/v1/store/items#

The store's items (paged; sort by sort_order, name or created_at; item_type + item_id for one catalogue item)

Betascope store:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"sort_order" | "name" | "created_at"Field to order by. Unrecognised values fall back to this endpoint default.
item_typequery"products" | "services"With item_id: the store item of one catalogue item (the item editor's Store tab).
item_idquerystringThe catalogue product or service id (with item_type).
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/items" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
POST/api/v1/store/items#

Add catalogue items to the store (up to 100 at once)

Betascope store:write

Each must be ACTIVE: 400 STORE_ITEM_INVALID; already on the store: 409 STORE_ITEM_DUPLICATE. Services are added Enquire-only.

Body application/json AddStoreItemsDto

Try it and code samples
curl -X POST "https://api.rapbooster.com/api/v1/store/items" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"items":[{}]}'
Paste a test key above first.
DELETE/api/v1/store/items/{id}#

Take an item off the store (the catalogue item stays)

Betascope store:write

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X DELETE "https://api.rapbooster.com/api/v1/store/items/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
Paste a test key above first.
PATCH/api/v1/store/items/{id}#

Show / hide, action, per-item delivery, order, featured

Betascope store:write

Parameters
NameInTypeAbout
id requiredpathstring

Body application/json UpdateStoreItemDto

Try it and code samples
curl -X PATCH "https://api.rapbooster.com/api/v1/store/items/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{}'
Paste a test key above first.
GET/api/v1/store/orders#

Store orders, newest first (search: buyer, number, phone)

Betascope store:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"created_at" | "total_minor" | "buyer_name" | "status"Field to order by. Unrecognised values fall back to this endpoint default.
statusquery"placed" | "awaiting_payment" | "paid" | "cancelled"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/orders" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/store/orders/{id}#

One store order, with its payments and shipping

Betascope store:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/orders/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/store/settings#

The store's settings (defaults until first saved)

Betascope store:read

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/settings" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Store - Sync

GET/api/v1/store/sync/conflicts#

Sync conflicts (default open; paged; sort by created_at or field)

Betascope store:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"created_at" | "field"Field to order by. Unrecognised values fall back to this endpoint default.
connection_idquerystring
statusquery"open" | "resolved" | "dismissed"
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/sync/conflicts" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/store/sync/connections#

The workspace's sync connections (paged; sort by created_at, display_name, last_run_at)

Betascope store:read

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"created_at" | "display_name" | "last_run_at"Field to order by. Unrecognised values fall back to this endpoint default.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/sync/connections" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/store/sync/connections/{id}#

One sync connection

Betascope store:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/sync/connections/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/store/sync/connections/{id}/runs#

A connection's run log (paged, newest first; sort by started_at)

Betascope store:read

Parameters
NameInTypeAbout
id requiredpathstring
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
sort_byquery"started_at"Field to order by. Unrecognised values fall back to this endpoint default.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/sync/connections/{id}/runs" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/store/sync/runs/{id}#

One run with its report (what a dry run would change)

Betascope store:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/store/sync/runs/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Support

GET/api/v1/support/categories#

List ticket categories

Betascope support:read

Active first, by sort order.

Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/support/categories" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/support/tickets#

List tickets

Betascope support:read

Most recent activity first by default.

Parameters
NameInTypeAbout
idquerystringSnowflake ID
qquerystringSearch Query
pagequeryinteger
limitqueryinteger
sortquery"ASC" | "DESC"Sort direction. Defaults per endpoint — usually DESC.
statusquery"AWAITING_SUPPORT" | "AWAITING_CUSTOMER" | "ON_HOLD" | "RESOLVED" | "CLOSED"
open_onlyquerybooleanEverything not RESOLVED or CLOSED — the working queue.
priorityquery"LOW" | "NORMAL" | "HIGH" | "URGENT"
category_idquerystring
assignedquerystringme, none, or a member's user id.
lead_idquerystring
sourcequery"MANUAL" | "WHATSAPP" | "EMAIL" | "PRODUCT"
unansweredquerybooleanNobody has replied publicly yet.
conversation_idquerystringTickets from this WhatsApp conversation.
wal_chat_idquerystringPlan 29: tickets from this linked WhatsApp chat.
slaquery"late"late: breaching SLA now (the Breaching SLA view): not RESOLVED or CLOSED, and a first-reply or resolve target missed. Matches nothing while SLA is off.
sort_byquery"last_message_at" | "created_at" | "updated_at" | "priority" | "status" | "subject" | "ticket_number"Field to order by. Unrecognised values fall back to this endpoint default. Default: most recent activity first.
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/support/tickets" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.
GET/api/v1/support/tickets/{id}#

Read a ticket and its whole thread, internal notes included

Betascope support:read

Parameters
NameInTypeAbout
id requiredpathstring
Try it and code samples
curl -X GET "https://api.rapbooster.com/api/v1/support/tickets/{id}" \
  -H "Authorization: Bearer $RAPBOOSTER_KEY"
Paste a test key above first.

Schemas

AddStoreItemsDto object
AddStoreItemsDto fields
FieldTypeAbout
items requiredStoreItemRefDto[]
CatalogueOrderItemDto object
CatalogueOrderItemDto fields
FieldTypeAbout
cancelled_atstring (date-time) | nullIts line was refunded.
id requiredstring
packed requirednumberIn a parcel not returned to sender.
price_id requiredstring
product_id requiredstring
product_name requiredstring
qty requirednumber
restocked requirednumberOf returned, put back on the shelf.
returnable requirednumberSent and not returned yet.
returned requirednumber
sent requirednumberLeft the warehouse.
skustring | null
source_idstring | nullThe invoice line it came from.
tax_inclusive requiredboolean
tax_rate requirednumber
to_ship requirednumberStill to put in a parcel.
unit_price_minor requirednumberInteger minor units (paise / cents).
variant_name requiredstring
CatalogueProductOrderDetailDto object
CatalogueProductOrderDetailDto fields
FieldTypeAbout
cancelled_atstring (date-time) | null
cod_approval_request_idstring | nullCOD: the approval request the payment waits on (LT109).
cod_collected_atstring (date-time) | nullCOD: when the cash was collected.
cod_collected_minornumber | nullCOD: cash collected, minor units.
cod_payment_idstring | nullCOD: the payment recorded.
created_at requiredstring (date-time)
created_bystring | nullWho entered a manual order.
currency requiredstring
delivered_atstring (date-time) | null
id requiredstring
invoice_idstring | nullThe tax invoice the order was paid on (list and GET only).
invoice_numberstring | null
items requiredCatalogueOrderItemDto[]
leadCatalogueSaleLeadDto | nullOn list rows only (one batched lookup); null if the lead is gone.
lead_id requiredstring
order_number requiredstring
origin_invoice_idstring | nullThe proforma or direct tax invoice the order holds the goods lines of (one order per invoice); absent on older orders and manual ones.
payment_mode required"PREPAID" | "COD"COD: cash on delivery (YP153).
returns requiredOrderReturnDto[]
ship_citystring | null
ship_country_codestring | null
ship_line1string | null
ship_line2string | null
ship_namestring | null
ship_phonestring | null
ship_postal_codestring | null
ship_statestring | null
shipments requiredCatalogueShipmentDto[]
shipped_atstring (date-time) | nullWhen the first parcel left (its shipment's shipped_at); null until then.
source_id requiredstringThe invoice line it came from.
source_type required"INVOICE_ITEM" | "TRIAL" | "MANUAL" | "FREE" | "TEAM"
status required"CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELLED" | "RETURNED"
updated_at requiredstring (date-time)
CatalogueProductOrderDto object
CatalogueProductOrderDto fields
FieldTypeAbout
cancelled_atstring (date-time) | null
cod_approval_request_idstring | nullCOD: the approval request the payment waits on (LT109).
cod_collected_atstring (date-time) | nullCOD: when the cash was collected.
cod_collected_minornumber | nullCOD: cash collected, minor units.
cod_payment_idstring | nullCOD: the payment recorded.
created_at requiredstring (date-time)
created_bystring | nullWho entered a manual order.
currency requiredstring
delivered_atstring (date-time) | null
id requiredstring
invoice_idstring | nullThe tax invoice the order was paid on (list and GET only).
invoice_numberstring | null
leadCatalogueSaleLeadDto | nullOn list rows only (one batched lookup); null if the lead is gone.
lead_id requiredstring
order_number requiredstring
origin_invoice_idstring | nullThe proforma or direct tax invoice the order holds the goods lines of (one order per invoice); absent on older orders and manual ones.
payment_mode required"PREPAID" | "COD"COD: cash on delivery (YP153).
ship_citystring | null
ship_country_codestring | null
ship_line1string | null
ship_line2string | null
ship_namestring | null
ship_phonestring | null
ship_postal_codestring | null
ship_statestring | null
shipped_atstring (date-time) | nullWhen the first parcel left (its shipment's shipped_at); null until then.
source_id requiredstringThe invoice line it came from.
source_type required"INVOICE_ITEM" | "TRIAL" | "MANUAL" | "FREE" | "TEAM"
status required"CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELLED" | "RETURNED"
updated_at requiredstring (date-time)
CatalogueSaleLeadDto object
CatalogueSaleLeadDto fields
FieldTypeAbout
emailstring | null
id requiredstring
mobilestring | null
name requiredstring
CatalogueShipmentDto object
CatalogueShipmentDto fields
FieldTypeAbout
carrier requiredstring
created_at requiredstring (date-time)
delivered_atstring (date-time) | null
eta_onstring | nullYYYY-MM-DD
id requiredstring
items requiredOrderItemQtyViewDto[]What the parcel holds; empty on older parcels, which hold the whole order.
label_urlstring | nullThe courier label PDF.
last_event_atstring (date-time) | null
out_for_delivery_atstring (date-time) | null
providerstring | nullshiprocket / sandbox; null by hand.
provider_order_idstring | null
provider_shipment_idstring | null
shipped_atstring (date-time) | null
status required"PENDING" | "IN_TRANSIT" | "DELIVERED" | "RETURNED"
tracking_nostring | null
tracking_sent_atstring (date-time) | nullTracking link last sent.
tracking_sent_via"WHATSAPP" | "EMAIL" | null
tracking_urlstring | null
ContactDto object
ContactDto fields
FieldTypeAbout
consent_atstring (date-time) | null
consent_ipstring | null
consent_sourcestring | null
country_codestring | nullBare calling code, e.g. 91.
created_at requiredstring (date-time)
custom_fields requiredContactFieldValueDto[]
emailstring | null
groups requiredContactGroupRefDto[]
id requiredstring
is_valid requiredboolean
namestring | null
phonestring | nullNational number.
phone_e164string | null+<code><number> (N4.10).
suppressions requiredContactSuppressionsDtoWhen the person went on each channel's suppression list (N4.7).
tags requiredContactTagRefDto[]
updated_at requiredstring (date-time)
ContactFieldValueDto object
ContactFieldValueDto fields
FieldTypeAbout
field_definition_id requiredstring
value requiredstring
ContactGroupDto object
ContactGroupDto fields
FieldTypeAbout
country_codestring | null
created_at requiredstring (date-time)
created_by_name requiredstringCreator's name, or 'Unknown User'.
custom_field_definitions requiredCustomFieldDefinitionFlatResponseDto[]
descriptionstring | null
emojistring | null
fields_count requirednumberLibrary fields the group shows (the 4 built-in ones not counted).
id requiredstring
name requiredstring
total_contacts requirednumber
updated_at requiredstring (date-time)
used_in requiredGroupUsageDto
workspace_user_id requiredstringCreator (central user id).
ContactGroupRefDto object
ContactGroupRefDto fields
FieldTypeAbout
id requiredstring
name requiredstring
ContactSuppressionsDto object
ContactSuppressionsDto fields
FieldTypeAbout
emailstring (date-time)
smsstring (date-time)
voicestring (date-time)
whatsappstring (date-time)
ContactTagRefDto object
ContactTagRefDto fields
FieldTypeAbout
colorstring | null
id requiredstring
name requiredstring
CreateWebhookEndpointDto object
CreateWebhookEndpointDto fields
FieldTypeAbout
events requiredstring[]Event names from GET webhook-events (e.g. lead.created, lead.updated, message.status).
url requiredstring
CreatedWebhookEndpointDto object
CreatedWebhookEndpointDto fields
FieldTypeAbout
created_at requiredstring (date-time)
disabled_atstring (date-time) | null
disabled_reason"failing" | "manual" | null
events requiredstring[]Event names from GET webhook-events (e.g. lead.created, lead.updated, message.status).
failing_sincestring (date-time) | nullFailing without a success since then; 3 days of it turn the endpoint off.
failure_count requirednumberFailed attempts since the last success.
id requiredstring
is_enabled requiredboolean
last_delivered_atstring (date-time) | null
last_failure_atstring (date-time) | null
previous_secret_expires_atstring (date-time) | nullAfter a rotation: the old secret also signs until then.
secret requiredstringThe signing secret (whsec_…), shown only in this response. Each delivery carries X-RapBooster-Signature: t=<unix>,v1=<hex HMAC-SHA256 of "<t>.<raw body>">.
url requiredstring
CreditNoteDto object
CreditNoteDto fields
FieldTypeAbout
cess_minor requirednumberPlan 32: the lines' compensation cess (in total_minor).
cgst_minor requirednumber
credit_given_minornumberPlan 29 CB4: the customer credit it made (minor units); 0 = the money was kept. Absent on a credit note issued before that release with nothing backfilled.
currency requiredstring
custom_fieldsSalesCustomFieldValueViewDto[]N6.11 document fields.
einvoiceInvoiceEinvoiceDto
id requiredstring
igst_minor requirednumber
invoice_id requiredstring
issued_at requiredstring
items requiredCreditNoteItemDto[]
number requiredstring
reason requiredstring
refund_errorstring
refund_minor requirednumber
refund_status required"NONE" | "PENDING" | "REFUNDED" | "FAILED"
sgst_minor requirednumber
status required"ISSUED" | "CANCELLED"
tax_minor requirednumber
taxable_minor requirednumber
total_minor requirednumber
CreditNoteItemDto object
CreditNoteItemDto fields
FieldTypeAbout
cess_minor requirednumberCompensation cess credited.
cgst_minor requirednumber
description requiredstring
id requiredstring
igst_minor requirednumber
invoice_item_idstring
item_type_labelstringPB4: the credited line's catalogue type and period; absent on free text.
qty requirednumber
sgst_minor requirednumber
tax_category required"taxable" | "nil" | "exempt" | "non_gst"Plan 32: the credited line's GST category.
tax_minor requirednumber
tax_namestringSimple tax: the credited line's named rate.
taxable_minor requirednumber
total_minor requirednumber
CreditNoteSummaryDto object
CreditNoteSummaryDto fields
FieldTypeAbout
cgst_minor requirednumber
credit_given_minornumberPlan 29 CB4: the customer credit it made (minor units); 0 = the money was kept. Absent on a credit note issued before that release with nothing backfilled.
currency requiredstring
id requiredstring
igst_minor requirednumber
invoice_id requiredstring
issued_at requiredstring
number requiredstring
reason requiredstring
refund_errorstring
refund_minor requirednumber
refund_status required"NONE" | "PENDING" | "REFUNDED" | "FAILED"
sgst_minor requirednumber
status required"ISSUED" | "CANCELLED"
tax_minor requirednumber
taxable_minor requirednumber
total_minor requirednumber
CustomFieldDefinitionFlatResponseDto object
CustomFieldDefinitionFlatResponseDto fields
FieldTypeAbout
id requiredstring
is_required requiredboolean
is_system requiredboolean
key requiredstring
label requiredstring
order requirednumber
placeholderstring | null
system_namestring | null
type requiredstring
ErrorResponseDto object
ErrorResponseDto fields
FieldTypeAbout
code requiredstringMachine-readable error code (e.g. UNAUTHORIZED, NOT_FOUND).
correlation_idstringRequest correlation id, echoed for tracing.
detailsstring[] | objectExtra context — for validation failures, the list of field errors.
message requiredstringHuman-readable error message.
path requiredstringRequest path that produced the error.
timestamp requiredstringISO-8601 timestamp of when the error was produced.
FieldRuleDto object
FieldRuleDto fields
FieldTypeAbout
direction required"off" | "to_remote" | "from_remote" | "two_way"The Meta catalogue takes off or to_remote only.
winner required"ask" | "local" | "remote"Two-way only, when both sides changed: ask opens a conflict (default), else that side wins.
FieldRulesDto object
FieldRulesDto fields
FieldTypeAbout
description requiredFieldRuleDto
name requiredFieldRuleDto
price requiredFieldRuleDto
sku requiredFieldRuleDto
stock requiredFieldRuleDtoStock always moves as deltas (each side's sales are kept).
GroupUsageDto object
GroupUsageDto fields
FieldTypeAbout
campaigns requirednumber
drips requirednumber
email_campaigns requirednumber
email_sequences requirednumber
total requirednumber
InvoiceAcceptanceDto object
InvoiceAcceptanceDto fields
FieldTypeAbout
action required"ACCEPT" | "DECLINE" | "REQUEST_CHANGES"
created_at requiredstring
document_hash requiredstringsha256 of the document as shown.
full_name requiredstringThe typed full name (the signature).
id requiredstring
ipstring
notestringDecline reason or the changes asked for.
proforma_idstringThe proforma an Accept & pay created.
user_agentstring
InvoiceBuyerDto object
InvoiceBuyerDto fields
FieldTypeAbout
address_line1string
address_line2string
billing_name requiredstring
citystring
country_codestring
emailstring
gstinstring
lead_name requiredstring
phonestring
postal_codestring
statestring
InvoiceDiscountCheckDto object
InvoiceDiscountCheckDto fields
FieldTypeAbout
above_cap requiredboolean
approval_pendingbooleanA discount request on this document or an ancestor awaits a decision.
approved_pctnumberThe highest discount %, approved (billing.sales.discount_over_cap) on this document or an ancestor.
blocked requiredbooleanIssuing is refused (409 INVOICES_DISCOUNT_ABOVE_CAP) until the discount is approved.
cap_pct requirednumberThe creator's cap, % (empty = 0).
pct requirednumberLine + document discounts (+ the incl.-tax switch, PB5) ÷ gross, %.
price_override_minor requirednumberDI-2: what catalogue lines priced below the catalogue took off (qty × difference), minor units; counted in pct against the catalogue gross.
tax_switch_minor requirednumberPB5: what switching catalogue lines from plus tax to incl. tax took off, minor units.
InvoiceDiscountViewDto object
InvoiceDiscountViewDto fields
FieldTypeAbout
type required"PERCENT" | "AMOUNT"
value requirednumber
InvoiceDto object
InvoiceDto fields
FieldTypeAbout
allow_part_payment requiredbooleanB15: the pay link accepts part of what's due.
amended_atstringR36-14 (GST): a tax invoice whose billing details changed after the month it was paid (approved); the GST report lists it as amended (GSTR-1). Absent = never.
amount_due_minor requirednumber
amount_paid_minor requirednumber
asked_price_minornumberProformas from the lead wizard: the price the buyer asked for, minor units (LT54), shown next to the quoted total.
auto_issuedbooleanPlan 31 (PR-DA1): issued by the approval of its discount request, not by hand. Absent = false.
auto_source"renewal" | "recurring" | "system"P35-26: what raised it: renewal (the renewal sweep), recurring (a schedule), system (a checkout, purchase or plan change). Absent = a member.
billing_edit"direct" | "approval"R36-14, issued / paid tax invoices: changing the billing details applies now (direct: in the month it was paid, or issued if unpaid) or needs approval and is listed as amended in GSTR-1 (approval: an earlier month). Absent on other documents or with an e-invoice IRN.
billing_idstring
buyer requiredInvoiceBuyerDto
cancelled_atstring
cess_minor requirednumberPlan 32: the lines' compensation cess (in total_minor, not in tax_minor).
cgst_minor requirednumber
child_idstringThe newest document created from this one (proforma, then tax invoice).
created_at requiredstring
credited_minornumberTax invoices: the total of its issued credit notes (taken off what is due).
credited_user_idstringPlan 7 L10: the sales member credited (the chain root's); absent = uncredited.
currency requiredstring
custom_fieldsSalesCustomFieldValueViewDto[]N6.11 document fields.
delete_pendingbooleanP35-25, lists only: a delete of this quote / proforma waits for approval. Absent = none (the document view uses pending_change).
discountInvoiceDiscountViewDto
discount_checkInvoiceDiscountCheckDtoDrafts: the discount-cap check issuing will run (plan 7 L10).
discount_minor requirednumber
doc_type required"QUOTE" | "PROFORMA" | "TAX_INVOICE"
einvoiceInvoiceEinvoiceDto
exchange_ratenumberF14: base currency per 1 unit of currency; absent when it is the base.
exchange_rate_source"FEED" | "MANUAL"
expires_atstring
id requiredstring
igst_minor requirednumber
import_source"tally"RX-D55: tally when the Tally import made it (out of GSTR-1 by default, never exported back).
is_auto requiredbooleanP35-26: a proforma no member raised (a renewal, a recurring schedule's run or another job); the lists show "Auto".
is_imported requiredbooleanF20: brought in by an import (never sent from here).
issued_atstring
items requiredInvoiceItemDto[]
last_sent_atstring
lead_id requiredstring
lead_typeLeadTypeR36-45: the buyer lead's type, for the VIP / VVIP badge (document header; plan 37: the list rows too). Absent without a lead.
min_part_percent requirednumberLeast part payment, % of what's due (0 = any amount).
needs_attention requiredbooleanOverpaid, or a paid line the catalogue refused.
notesstring
numberstring
overpaid_minor requirednumberPaid beyond the total (flagged, never auto-refunded).
owner_change_pendingbooleanP35-30: a change of this sale's owner waits for approval (on any document of the sale). Absent when none.
paid_atstring
parent_idstring
pay_gateway"RAZORPAY" | "STRIPE" | "PAYTM" | "CCAVENUE"A7.10.3: the gateway override; absent = the workspace default.
pay_link requiredstringThe public pay/view link (V10).
payment_mode required"PREPAID" | "COD"Plan 21 (YP153): COD opens the goods order at issue; cash recorded on delivery.
payment_pendingbooleanP35-8: a payment recorded on this document waits for approval (billing.payments.entry). R36-12: more parts may still be recorded, together at most what is due. Absent when none.
pending_changeInvoicePendingChangeDtoIssued documents: a change waiting for approval; the document is unchanged until it is approved. Absent when none.
pending_payments_minornumberR36-12: what the payments waiting for approval would settle (cash + customer TDS), minor units. Absent when none wait.
place_of_supplystringGST documents: the buyer's state, e.g. "Rajasthan (08)".
place_of_supply_unknownbooleanGST document whose buyer state is unknown: it was charged as intra-state.
port_codestring
reminders requiredInvoiceReminderDto[]Proformas: payment reminders, newest first.
reminders_paused requiredbooleanB31: payment reminders paused for this document.
response_unseen requiredbooleanB23: a buyer answered and no member had opened it yet.
responses requiredInvoiceAcceptanceDto[]Quotes: the buyer's responses, newest first.
reverse_charge requiredbooleanPlan 32 (RX-D29): "Reverse charge applies": no output tax charged, the buyer pays it.
revisable requiredbooleanR36-14: an issued quote (issued, accepted, declined, changes requested, expired) or an issued proforma with nothing paid: PUT with revise: true saves a new revision.
revised_atstringR36-14: when the last revision was saved. Absent = never.
revision requirednumberR36-14: 1 as first issued; each revision of an issued quote / proforma adds one.
round_off requiredboolean
round_off_minor requirednumber
seller requiredInvoiceSellerViewDto
send_pendingbooleanPlan 31 (PR-DA1): auto-issued and never sent; the requester sends it. Absent = false.
sgst_minor requirednumber
shipping_bill_datestringYYYY-MM-DD.
shipping_bill_nostring
status required"DRAFT" | "ISSUED" | "PARTIALLY_PAID" | "PAID" | "CANCELLED" | "EXPIRED" | "CONVERTED" | "ACCEPTED" | "DECLINED" | "CHANGES_REQUESTED" | "AWAITING_APPROVAL"
subtotal_minor requirednumber
supply_type required"DOMESTIC" | "EXPORT_WPAY" | "EXPORT_WOPAY" | "SEZ_WP" | "SEZ_WOP"
tax_minor requirednumber
tax_mode required"GST_INTRA" | "GST_INTER" | "EXPORT" | "NONE" | "SIMPLE"
tax_registration_idstringF10: absent on documents from before registrations.
taxable_minor requirednumber
termsstring
total_minor requirednumber
updated_at requiredstring
InvoiceEinvoiceDto object
InvoiceEinvoiceDto fields
FieldTypeAbout
ack_datestring
ack_nostring
ewb_datestring
ewb_nostringe-way bill number.
ewb_valid_tillstring
imported_at requiredstring
irnstringInvoice reference number (IRN).
signed_qrstringRX-10: the IRP's signed QR (a JWT), printed on the PDF once acked; absent before the ack.
InvoiceItemDto object
InvoiceItemDto fields
FieldTypeAbout
billing_periodstring
catalogue_tax_inclusivebooleanPB5: the catalogue price's own incl.-tax setting (absent on free text and older lines).
catalogue_unit_price_minornumberDI-2: the catalogue's unit price when the line was saved (catalogue lines); unit_price_minor below it counts against the discount cap. Absent on free-text lines and older rows.
cess_minor requirednumberCompensation cess charged (in total_minor, not tax_minor).
cess_rate_bp requirednumberCompensation cess, basis points (100 = 1%).
cgst_minor requirednumber
credited_qtynumberTax invoices (plan 34, Q2): quantity already credited by issued credit notes; a new credit note may take at most qty − credited_qty of this line. Absent = none credited.
custom_fieldsSalesCustomFieldValueViewDto[]N6.11 line fields.
description requiredstring
discountInvoiceDiscountViewDto
discount_minor requirednumberLine discount plus its share of the invoice discount.
domain_namestring
fulfilment_attempted_atstring
fulfilment_errorstringWhy the catalogue refused this paid line (retry it).
fulfilment_idstring
fulfilment_typestring
hsn_sacstring
id requiredstring
igst_minor requirednumber
item_idstring
item_typestring
item_type_labelstringPB3: catalogue type + billing period, saved with the line; absent on free text.
kind required"CATALOGUE" | "CUSTOM"
position requirednumber
price_idstring
price_kindstring
qty requirednumber
renewal_fulfilment_idstring
renewal_fulfilment_typestring
renewal_of_item_idstringRV3: the paid invoice line this one renews.
renewal_root_item_idstringRV3: the first line of this line's renewal chain.
sgst_minor requirednumber
tax_category required"taxable" | "nil" | "exempt" | "non_gst"Plan 32 (RX-D29): the line's GST category.
tax_inclusive requiredboolean
tax_minor requirednumber
tax_namestringSimple tax: the named rate.
tax_rate requirednumber
taxable_minor requirednumber
total_minor requirednumber
unitstringUQC (NOS, KGS, …).
unit_price_minor requirednumber
validityInvoiceItemValidityDtoPlan 30 RV2 (custom lines).
variant_namestring
InvoiceItemValidityDto object
InvoiceItemValidityDto fields
FieldTypeAbout
countnumberdays / months only.
end requiredstringThe day the validity runs out (YYYY-MM-DD): start + period.
period required"monthly" | "quarterly" | "half_yearly" | "yearly" | "days" | "months"
start requiredstringFirst day (YYYY-MM-DD).
InvoicePendingChangeDto object
InvoicePendingChangeDto fields
FieldTypeAbout
kind required"cancel" | "terms" | "tax_invoice" | "credit_note" | "billing" | "delete"cancel (cancel the quote / proforma), terms (part-payment terms or gateway), tax_invoice (issue the tax invoice now), credit_note, billing (billing details after a payment, BD1) or delete (delete the quote / proforma, P35-25).
request_id requiredstringThe billing.sales.invoice approval request it waits in.
InvoiceReminderDto object
InvoiceReminderDto fields
FieldTypeAbout
channel required"EMAIL" | "WHATSAPP"
errorstringWhy it didn't go out.
id requiredstring
offset_days requirednumberDays from the due date; negative = before.
sent_at requiredstring
InvoiceSellerViewDto object
InvoiceSellerViewDto fields
FieldTypeAbout
addressstring
country_codestring
display_namestringBusiness profile trade name (N6.5); absent: print name.
emailstring
gstinstringThe tax ID (a GSTIN, or what tax_id_label names).
lut_fystring
lut_numberstringF12: the LUT a without-payment export was issued under.
name requiredstring
phonestring
statestring
tax_id_labelstringThe tax ID's label ("GSTIN", "VAT No."); also the buyer's.
tax_system"INDIA_GST" | "SIMPLE"Absent on older documents: INDIA_GST.
websitestring
InvoiceSummaryDto object
InvoiceSummaryDto fields
FieldTypeAbout
allow_part_payment requiredbooleanB15: the pay link accepts part of what's due.
amended_atstringR36-14 (GST): a tax invoice whose billing details changed after the month it was paid (approved); the GST report lists it as amended (GSTR-1). Absent = never.
amount_due_minor requirednumber
amount_paid_minor requirednumber
auto_source"renewal" | "recurring" | "system"P35-26: what raised it: renewal (the renewal sweep), recurring (a schedule), system (a checkout, purchase or plan change). Absent = a member.
billing_idstring
buyer requiredInvoiceBuyerDto
cancelled_atstring
cgst_minor requirednumber
created_at requiredstring
credited_user_idstringPlan 7 L10: the sales member credited (the chain root's); absent = uncredited.
currency requiredstring
delete_pendingbooleanP35-25, lists only: a delete of this quote / proforma waits for approval. Absent = none (the document view uses pending_change).
discountInvoiceDiscountViewDto
discount_minor requirednumber
doc_type required"QUOTE" | "PROFORMA" | "TAX_INVOICE"
exchange_ratenumberF14: base currency per 1 unit of currency; absent when it is the base.
exchange_rate_source"FEED" | "MANUAL"
expires_atstring
id requiredstring
igst_minor requirednumber
import_source"tally"RX-D55: tally when the Tally import made it (out of GSTR-1 by default, never exported back).
is_auto requiredbooleanP35-26: a proforma no member raised (a renewal, a recurring schedule's run or another job); the lists show "Auto".
is_imported requiredbooleanF20: brought in by an import (never sent from here).
issued_atstring
last_sent_atstring
lead_id requiredstring
lead_typeLeadTypeR36-45: the buyer lead's type, for the VIP / VVIP badge (document header; plan 37: the list rows too). Absent without a lead.
min_part_percent requirednumberLeast part payment, % of what's due (0 = any amount).
needs_attention requiredbooleanOverpaid, or a paid line the catalogue refused.
notesstring
numberstring
overpaid_minor requirednumberPaid beyond the total (flagged, never auto-refunded).
paid_atstring
parent_idstring
pay_gateway"RAZORPAY" | "STRIPE" | "PAYTM" | "CCAVENUE"A7.10.3: the gateway override; absent = the workspace default.
pay_link requiredstringThe public pay/view link (V10).
payment_mode required"PREPAID" | "COD"Plan 21 (YP153): COD opens the goods order at issue; cash recorded on delivery.
place_of_supplystringGST documents: the buyer's state, e.g. "Rajasthan (08)".
place_of_supply_unknownbooleanGST document whose buyer state is unknown: it was charged as intra-state.
port_codestring
reminders_paused requiredbooleanB31: payment reminders paused for this document.
response_unseen requiredbooleanB23: a buyer answered and no member had opened it yet.
reverse_charge requiredbooleanPlan 32 (RX-D29): "Reverse charge applies": no output tax charged, the buyer pays it.
revisable requiredbooleanR36-14: an issued quote (issued, accepted, declined, changes requested, expired) or an issued proforma with nothing paid: PUT with revise: true saves a new revision.
revised_atstringR36-14: when the last revision was saved. Absent = never.
revision requirednumberR36-14: 1 as first issued; each revision of an issued quote / proforma adds one.
round_off requiredboolean
round_off_minor requirednumber
seller requiredInvoiceSellerViewDto
sgst_minor requirednumber
shipping_bill_datestringYYYY-MM-DD.
shipping_bill_nostring
status required"DRAFT" | "ISSUED" | "PARTIALLY_PAID" | "PAID" | "CANCELLED" | "EXPIRED" | "CONVERTED" | "ACCEPTED" | "DECLINED" | "CHANGES_REQUESTED" | "AWAITING_APPROVAL"
subtotal_minor requirednumber
supply_type required"DOMESTIC" | "EXPORT_WPAY" | "EXPORT_WOPAY" | "SEZ_WP" | "SEZ_WOP"
tax_minor requirednumber
tax_mode required"GST_INTRA" | "GST_INTER" | "EXPORT" | "NONE" | "SIMPLE"
tax_registration_idstringF10: absent on documents from before registrations.
taxable_minor requirednumber
termsstring
total_minor requirednumber
updated_at requiredstring
LeadBillingDto object
LeadBillingDto fields
FieldTypeAbout
address_line1string | null
address_line2string | null
billing_name requiredstring
citystring | null
country_codestring | null
created_at requiredstring (date-time)
emailstring | null
gstinstring | null
id requiredstring
is_default requiredbooleanWhether this is the lead's default.
labelstring | null
lead_id requiredstring
phonestring | null
postal_codestring | null
statestring | null
updated_at requiredstring (date-time)
LeadCountDto object
LeadCountDto fields
FieldTypeAbout
count requirednumber
key requiredstring
LeadCountsDto object
LeadCountsDto fields
FieldTypeAbout
pending_approvals requirednumberAlways 0: approvals moved to Tasks (A7.16.10). Deprecated (API-37), removed in a later release.
stalebooleanTrue when a fresh count timed out and these are the last cached numbers (plan 30 ST14).
statuses requiredLeadCountDto[]One per live lead status; key is the crm_lead_status id (LT12).
total requirednumber
treasure_box requirednumberLeads in the treasure box (everyone sees the whole box).
views requiredLeadCountDto[]One per view the caller may see (LeadView keys).
LeadDetailDto object
LeadDetailDto fields
FieldTypeAbout
active_itemsintegerBI1: catalogue items bought on the lead's paid / part-paid tax invoices that are still live (the header's "N active" chip; records section purchased_items).
assigned_user_idstring | nullOwner (central user id).
assignee_namestring | null
citystring | nullPlan 31: the lead's city.
country_codestring | nullISO-3166 alpha-2.
created_at requiredstring (date-time)
created_bystring | nullCentral user id.
customerboolean | nullHas an active sale: the Customer badge (LT15). Lists and the lead page.
default_billingLeadBillingDto | null
default_billing_id requiredstring
detail_change_request_idstring | nullSet when the edit changed an existing mobile / email without crm.edit_contact_details: that part waits in this crm.contact_detail_change request; the rest was saved.
emailstring | null
external_account_deleted_atstring (date-time) | nullMaster tenant only: when the linked workspace was deleted (SA-17).
external_account_idstring | null
given_upLeadGivenUpDto | nullSet while the latest owner change is a give-up with no follow-up since (LT17).
id requiredstring
in_reachbooleanP35-8: the caller may change this lead (PM5 reach). Outside reach the lead page offers only what stays open (sends, pins, demos, Grab, comments, a new follow-up).
interest_namesstring[]Leads list only (R36-16): the lead's Interested in names (catalogue items and custom values).
interests requiredLeadInterestDto[]Interested in (LT16, R36-16).
is_vip requiredbooleanDeprecated (R36-45): type is vip or vvip. Removed in the next release.
last_activity_atstring (date-time) | nullLists only: the latest note, call, email, chat, follow-up or status change.
mobilestring | null
name requiredstring
next_followup_atstring (date-time) | nullLists only: the soonest pending follow-up.
next_followup_idstring | nullNewly assigned / Grabbed lists only (plan 29 N): the soonest pending follow-up's id.
owner_change_from_namestring | nullThat previous owner's name.
owner_change_from_user_idstring | nullGrabbed list: the previous owner (central user id); absent = nobody (a given-up lead from the treasure box).
owner_change_kind"ASSIGN" | "GRAB" | "HANDOVER" | nullNewly assigned / Grabbed lists only: how it got its owner (absent = created already owned).
owner_changed_atstring (date-time) | nullNewly assigned / Grabbed lists only: when the lead got its current owner (the latest owner change, else its creation).
poolLeadPool | nullPlan 7: the unowned pool it waits in (Enquiries / Phone contacts); absent once owned.
pool_entered_atstring (date-time) | nullWhen it entered the pool.
pool_uploaded_bystring | nullPhone contacts: the member whose mobile uploaded it (central user id).
previous_owner_namestring | nullTheir name ("Name · left" for a released member); with previous_owner_user_id.
previous_owner_sincestring (date-time) | nullPRR37: when the handover happened ("from Aarav Sharma on 22 Oct"); with previous_owner_user_id.
previous_owner_untilstring (date-time) | nullUntil when both names show (30 days after the handover).
previous_owner_user_idstring | nullPlan 22 (ML3): the owner before a handover (central user id), only while previous_owner_until is ahead.
primary_contactLeadPrimaryContactDto | nullThe contact flagged primary; absent = none (the lead's own mobile / email apply).
ratingnumber | null1–5, from the latest follow-up (LT38).
signup_stepstring | nullMaster only (W2g): the last sign-up step (phone_entered, otp_verified, profile_filled, workspace_created, trial_started, paid).
sold_throughLeadSoldThroughDto | nullR36-45: the Reseller lead this customer was sold through.
source_idstring | nullPlan 7: where the lead came from.
stageLeadStage | nullThe pipeline stage, worked out from the lead's data (LT13, LT105).
stage_source"created" | "contact_logged" | "trial_active" | "proforma_sent" | "sale" | nullWhat put the lead in its stage (LT13).
statestring | nullThe lead's state (an Indian state's name when country_code is IN).
statusLeadStatusRefDto | nullThe lead's status (LT12); absent only for a lead not migrated yet.
type requiredLeadTypeR36-45: Standard, Reseller, Affiliate, VIP or VVIP (Reseller / Affiliate only in RapBooster's own workspace). A lead of a type whose key the caller lacks is never returned.
updated_at requiredstring (date-time)
LeadDto object
LeadDto fields
FieldTypeAbout
assigned_user_idstring | nullOwner (central user id).
assignee_namestring | null
citystring | nullPlan 31: the lead's city.
country_codestring | nullISO-3166 alpha-2.
created_at requiredstring (date-time)
created_bystring | nullCentral user id.
customerboolean | nullHas an active sale: the Customer badge (LT15). Lists and the lead page.
default_billing_id requiredstring
emailstring | null
external_account_deleted_atstring (date-time) | nullMaster tenant only: when the linked workspace was deleted (SA-17).
external_account_idstring | null
id requiredstring
interest_namesstring[]Leads list only (R36-16): the lead's Interested in names (catalogue items and custom values).
is_vip requiredbooleanDeprecated (R36-45): type is vip or vvip. Removed in the next release.
last_activity_atstring (date-time) | nullLists only: the latest note, call, email, chat, follow-up or status change.
mobilestring | null
name requiredstring
next_followup_atstring (date-time) | nullLists only: the soonest pending follow-up.
next_followup_idstring | nullNewly assigned / Grabbed lists only (plan 29 N): the soonest pending follow-up's id.
owner_change_from_namestring | nullThat previous owner's name.
owner_change_from_user_idstring | nullGrabbed list: the previous owner (central user id); absent = nobody (a given-up lead from the treasure box).
owner_change_kind"ASSIGN" | "GRAB" | "HANDOVER" | nullNewly assigned / Grabbed lists only: how it got its owner (absent = created already owned).
owner_changed_atstring (date-time) | nullNewly assigned / Grabbed lists only: when the lead got its current owner (the latest owner change, else its creation).
poolLeadPool | nullPlan 7: the unowned pool it waits in (Enquiries / Phone contacts); absent once owned.
pool_entered_atstring (date-time) | nullWhen it entered the pool.
pool_uploaded_bystring | nullPhone contacts: the member whose mobile uploaded it (central user id).
previous_owner_namestring | nullTheir name ("Name · left" for a released member); with previous_owner_user_id.
previous_owner_sincestring (date-time) | nullPRR37: when the handover happened ("from Aarav Sharma on 22 Oct"); with previous_owner_user_id.
previous_owner_untilstring (date-time) | nullUntil when both names show (30 days after the handover).
previous_owner_user_idstring | nullPlan 22 (ML3): the owner before a handover (central user id), only while previous_owner_until is ahead.
primary_contactLeadPrimaryContactDto | nullThe contact flagged primary; absent = none (the lead's own mobile / email apply).
ratingnumber | null1–5, from the latest follow-up (LT38).
signup_stepstring | nullMaster only (W2g): the last sign-up step (phone_entered, otp_verified, profile_filled, workspace_created, trial_started, paid).
sold_throughLeadSoldThroughDto | nullR36-45: the Reseller lead this customer was sold through.
source_idstring | nullPlan 7: where the lead came from.
stageLeadStage | nullThe pipeline stage, worked out from the lead's data (LT13, LT105).
statestring | nullThe lead's state (an Indian state's name when country_code is IN).
statusLeadStatusRefDto | nullThe lead's status (LT12); absent only for a lead not migrated yet.
type requiredLeadTypeR36-45: Standard, Reseller, Affiliate, VIP or VVIP (Reseller / Affiliate only in RapBooster's own workspace). A lead of a type whose key the caller lacks is never returned.
updated_at requiredstring (date-time)
LeadGivenUpDto object
LeadGivenUpDto fields
FieldTypeAbout
at requiredstring (date-time)
bystring | nullWho gave it up (central user id).
notestring | null
reasonstring | null
LeadInterestDto object
LeadInterestDto fields
FieldTypeAbout
item_id requiredstring
item_type required"services" | "desktop-tools" | "saas-tools" | "products" | "domain-tlds" | "hosting-plans" | "custom"A catalogue item type key (desktop-tools, services, …) or custom (a CRM settings value).
namestring | nullAbsent once the item is deleted.
LeadPool "ENQUIRY" | "PHONE_CONTACT"

Plan 7: the unowned pool it waits in (Enquiries / Phone contacts); absent once owned.

LeadPrimaryContactDto object
LeadPrimaryContactDto fields
FieldTypeAbout
emailstring | null
id requiredstring
mobilestring | null
name requiredstring
LeadSoldThroughDto object
LeadSoldThroughDto fields
FieldTypeAbout
id requiredstring
namestring | nullNull when the reseller lead is gone.
LeadStage "new" | "contacted" | "trial" | "negotiation" | "customer"
LeadStatusCategory "open" | "won" | "lost" | "given_up"
LeadStatusDto object
LeadStatusDto fields
FieldTypeAbout
archived_atstring (date-time) | null
category requiredLeadStatusCategory
colorstring | null
created_at requiredstring (date-time)
id requiredstring
is_category_default requiredboolean
is_default requiredboolean
is_stage_default requiredboolean
lead_count requirednumberLeads on this status now.
name requiredstring
sort requirednumber
stageLeadStage | null
updated_at requiredstring (date-time)
LeadStatusRefDto object
LeadStatusRefDto fields
FieldTypeAbout
category requiredLeadStatusCategory
colorstring | null
id requiredstring
name requiredstring
stageLeadStage | null
LeadType "standard" | "reseller" | "affiliate" | "vip" | "vvip"

R36-45: Standard, Reseller, Affiliate, VIP or VVIP (Reseller / Affiliate only in RapBooster's own workspace). A lead of a type whose key the caller lacks is never returned.

LeadView "FOLLOWUPS_DUE" | "UNANSWERED_WHATSAPP" | "MISSED_CALLS" | "UNASSIGNED" | "MONEY_OWED" | "OPEN_TICKETS" | "NEW_THIS_WEEK" | "GOING_QUIET" | "RENEWALS_DUE" | "CUSTOMERS" | "DEMO_SCHEDULED" | "DEMO_TODAY" | "DEMO_OUTCOME_DUE" | "DEMO_DONE" | "NO_SHOW" | "FOLLOWUP_TODAY" | "OVERDUE" | "UNTOUCHED" | "HOT" | "QUOTE_SENT" | "ON_TRIAL" | "WON_THIS_MONTH" | "LOST_THIS_MONTH" | "NEWLY_ASSIGNED" | "GRABBED" | "RENEWALS_EXPIRING" | "RENEWALS_EXPIRED" | "RENEWED"
OfferChannelReportDto object
OfferChannelReportDto fields
FieldTypeAbout
channel required"store" | "app" | "billing" | "pos" | "plan_checkout" | "quote" | "pay_link"
discount_minor requirednumber
revenue_minor requirednumber
uses requirednumber
OfferCodeDto object
OfferCodeDto fields
FieldTypeAbout
batch_idstring
code requiredstring
created_at requiredstring (date-time)
disabled_atstring (date-time)
id requiredstring
single_use requiredboolean
used_count requirednumber
OfferDayReportDto object
OfferDayReportDto fields
FieldTypeAbout
day requiredstring (date)
discount_minor requirednumber
uses requirednumber
OfferDto object
OfferDto fields
FieldTypeAbout
auto_apply requiredboolean
channels required"store" | "app" | "billing" | "pos" | "plan_checkout" | "quote" | "pay_link"[]
codes requirednumber
combinable requiredboolean
config requiredobject
created_at requiredstring (date-time)
discount_minor requirednumber
eligibility requiredobject
ends_atstring (date-time)
id requiredstring
kind required"percent" | "flat" | "free_shipping" | "bxgy" | "tiered"
min_order_minornumber
name requiredstring
per_customer_limitnumber
public_codestring
revenue_minor requirednumber
reversed requirednumber
starts_atstring (date-time)
state required"live" | "scheduled" | "ended" | "paused" | "archived"
status required"active" | "paused" | "archived"
summary requiredstringWhat the offer gives, e.g. "Buy 2 get 1 free".
targets requiredobject
total_limitnumber
uses requirednumber
OfferRedemptionDto object
OfferRedemptionDto fields
FieldTypeAbout
buyer_idstring
channel required"store" | "app" | "billing" | "pos" | "plan_checkout" | "quote" | "pay_link"
codestring
created_at requiredstring (date-time)
discount_minor requirednumber
document_idstring
document_typestring
id requiredstring
lead_idstring
offer_id requiredstring
reversed_atstring (date-time)
store_order_idstring
OfferReportDto object
OfferReportDto fields
FieldTypeAbout
by_channel requiredOfferChannelReportDto[]
by_day requiredOfferDayReportDto[]
discount_minor requirednumber
offer_id requiredstring
revenue_minor requirednumber
reversed requirednumber
uses requirednumber
OrderItemQtyViewDto object
OrderItemQtyViewDto fields
FieldTypeAbout
order_item_id requiredstring
qty requirednumber
OrderReturnDto object
OrderReturnDto fields
FieldTypeAbout
created_at requiredstring (date-time)
created_bystring | null
id requiredstring
items requiredOrderItemQtyViewDto[]
reasonstring | null
restock requiredboolean
OrdersSummaryDto object
OrdersSummaryDto fields
FieldTypeAbout
cancelled requirednumber
cod_to_collect requirednumberCOD orders whose cash is not recorded yet.
delivered requirednumber
in_transit requirednumberSidebar: a parcel on its way.
issues requirednumberSidebar: cancelled, a parcel returned to sender, or COD cash not recorded.
ready_to_ship requirednumberSidebar: a parcel packed, not left yet.
returns requirednumberSidebar: returned, or with a return recorded.
shipped_last7_days requirednumberOrders with a parcel that left in the last 7 days.
to_pack requirednumberSidebar: open, with something to pack and no parcel waiting.
to_ship requirednumberCONFIRMED: paid, not sent yet.
PageMetaDto object
PageMetaDto fields
FieldTypeAbout
has_next_page requiredboolean
has_previous_page requiredboolean
limit requirednumber
page requirednumber
total_items requirednumber
total_pages requirednumber
PublicContactDto object
PublicContactDto fields
FieldTypeAbout
country_codestring | null
created_at requiredstring (date-time)
emailstring | null
existingbooleanOn create: true when the email or phone was known.
groups requiredPublicContactGroupDto[]
id requiredstring
namestring | null
phonestring | null
updated_at requiredstring (date-time)
PublicContactGroupDto object
PublicContactGroupDto fields
FieldTypeAbout
id requiredstring
name requiredstring
PublicContactWriteDto object
PublicContactWriteDto fields
FieldTypeAbout
country_codestring | null
emailstring | null
group_idsstring[]Groups to put the person in (on update: exactly these).
namestring | null
phonestring | nullWith its calling code (+91…), or give country_code.
PublicCreateLeadDto object
PublicCreateLeadDto fields
FieldTypeAbout
citystring | null
contact_namestring | nullThe lead's first contact person (LP12). Default: the lead's name.
country_codestring | nullISO-3166 alpha-2.
emailstring | null
mobilestring | null
name requiredstring
source_idstring | nullA lead source id.
statestring | nullAn Indian state's name when country_code is IN, free text otherwise.
statusstringA lead status name from the workspace's list (Leads settings › Statuses), any case. Default: the workspace's default status.
PublicLeadDto object
PublicLeadDto fields
FieldTypeAbout
assigned_user_idstring | null
citystring | null
country_codestring | nullISO-3166 alpha-2.
created_at requiredstring (date-time)
emailstring | null
id requiredstring
mobilestring | null
name requiredstring
source_idstring | null
statestring | null
statusstring | nullThe status's name.
status_category"open" | "won" | "lost" | "given_up" | nullWhat the status means: open, won, lost or given up.
updated_at requiredstring (date-time)
PublicMessageDto object
PublicMessageDto fields
FieldTypeAbout
channel required"whatsapp" | "email"
delivered_atstring (date-time) | null
errorstring | null
id requiredstringWhatsApp: Meta's message id; email: ours.
number_idstringWhatsApp send only: the number it went from.
sender"official" | "linked"WhatsApp send only: which sender carried it.
sent_atstring (date-time) | null
status requiredstringsent, or queued on a linked number's paced queue.
testbooleanTrue on a test key's dry-run send: nothing was sent and no credits were used.
PublicSendEmailDto object
PublicSendEmailDto fields
FieldTypeAbout
connection_idstring | nullDefault: the system one.
htmlstring | nullDefault: text as HTML.
subject requiredstring
text requiredstringPlain-text body.
to requiredstring
PublicSendWhatsappDto object
PublicSendWhatsappDto fields
FieldTypeAbout
channel"official" | "linked" | "auto"official: Meta's number (default). linked: a linked number, which sends the template's text version. auto: the sender rule set for the API purpose in WhatsApp settings.
languagestring | null
number_idstring | nullThe number to send from: Meta's phone-number id, or a linked number's id with channel linked / auto. Replaces phone_number_id.
paramsRecord<string, string>Template variables by position (1, 2, …) or name.
phone_number_idstring | nullMeta's phone-number id to send from (default: the campaign default).
template_id requiredstringThe approved template's Meta id.
to requiredstring
PublicUpdateLeadDto object
PublicUpdateLeadDto fields
FieldTypeAbout
citystring | null
country_codestring | nullISO-3166 alpha-2.
emailstring | null
mobilestring | null
namestring
statestring | nullAn Indian state's name when country_code is IN, free text otherwise.
statusstringA lead status name from the workspace's list (Leads settings › Statuses), any case.
SalesCustomFieldValueViewDto object
SalesCustomFieldValueViewDto fields
FieldTypeAbout
key requiredstring
label requiredstring
value requiredstring
SiteApiAddressDto object
SiteApiAddressDto fields
FieldTypeAbout
citystring | null
country_codestring | null
linestring | null
pincodestring | null
statestring | null
SiteApiApplicationDto object
SiteApiApplicationDto fields
FieldTypeAbout
application_id requiredstring
created requiredbooleanFalse when this email already applied to the job.
SiteApiApplicationFormDto object
SiteApiApplicationFormDto fields
FieldTypeAbout
cv requiredstring (binary)PDF, at most 5 MB.
email requiredstring
job_slug requiredstring
name requiredstring
phone requiredstring
portfolio_urlstring
verified_token requiredstringFrom hrms/applications/otp/verify.
SiteApiApplyOtpDto object
SiteApiApplyOtpDto fields
FieldTypeAbout
phone requiredstring
SiteApiApplyOtpSentDto object
SiteApiApplyOtpSentDto fields
FieldTypeAbout
expires_in requirednumberSeconds.
request_id requiredstring
resend_in requirednumberSeconds before a resend.
SiteApiApplyOtpVerifyDto object
SiteApiApplyOtpVerifyDto fields
FieldTypeAbout
code requiredstring
phone requiredstring
request_id requiredstring
SiteApiCampaignDto object
SiteApiCampaignDto fields
FieldTypeAbout
completed_atstring (date-time) | null
created_at requiredstring (date-time)
id requiredstring
name requiredstring
scheduled_atstring (date-time) | null
started_atstring (date-time) | null
stats requiredSiteApiCampaignStatsDto
status requiredstring
type requiredstring
SiteApiCampaignStatsDto object
SiteApiCampaignStatsDto fields
FieldTypeAbout
failed requirednumber
sent requirednumber
total requirednumber
SiteApiEnquiryDto object
SiteApiEnquiryDto fields
FieldTypeAbout
captcha_tokenstringreCAPTCHA token; required with a publishable key.
companystring
consent requiredtrueThe visitor agreed to be contacted.
emailstring
kind required"contact" | "service" | "corporate_gifting" | "trade" | "franchise" | "careers"
message requiredstring
name requiredstring
phone requiredstring
quantitynumberUnits asked for (corporate gifting, trade).
servicestringThe service asked about (kind service).
source_urlstringThe page the form was sent from.
tagsstring[]Extra lead tags (≤ 10, ≤ 40 chars each).
websitestringHoneypot: leave empty. A filled one is answered like a success and nothing is saved.
SiteApiEnquiryReceivedDto object
SiteApiEnquiryReceivedDto fields
FieldTypeAbout
createdbooleanSecret keys only: false when an existing lead took it.
lead_idstringSecret keys only: the lead it landed on.
received requiredtrue
SiteApiJobDto object
SiteApiJobDto fields
FieldTypeAbout
batchstring | null
date_postedstring | nullISO date-time the role was opened.
departmentstring | null
description_html requiredstringEscaped HTML (paragraphs, line breaks).
employment_typestring | null
employment_type_labelstring | null
internship requiredboolean
locationstring | null
salary_rangeSiteApiSalaryRangeDto | null
slug requiredstring
title requiredstring
valid_throughstring | null
SiteApiPhoneVerifiedDto object
SiteApiPhoneVerifiedDto fields
FieldTypeAbout
expires_in requirednumberSeconds (30 minutes).
verified_token requiredstringSend as verified_token with the application; single use.
SiteApiSalaryRangeDto object
SiteApiSalaryRangeDto fields
FieldTypeAbout
currency requiredstring
max_minornumber | null
min_minornumber | null
unit required"MONTH" | "YEAR" | "HOUR"
SiteApiSubscribeDto object
SiteApiSubscribeDto fields
FieldTypeAbout
consent_ipstringThe visitor's IP (the site's server forwards it).
consent_text requiredstringThe exact consent line the visitor agreed to.
emailstring
group_id requiredstringMarketing › Audience group id.
namestring
phonestring
source_urlstring
SiteApiSubscriptionDto object
SiteApiSubscriptionDto fields
FieldTypeAbout
contact_idstringThe Audience contact; absent when none matched (opt-out).
group_id requiredstring
subscribed requiredboolean
SiteApiSupportDayDto object
SiteApiSupportDayDto fields
FieldTypeAbout
closesstring | null
day required"sun" | "mon" | "tue" | "wed" | "thu" | "fri" | "sat"
opensstring | nullNull: closed.
SiteApiSupportHoursDto object
SiteApiSupportHoursDto fields
FieldTypeAbout
days requiredSiteApiSupportDayDto[]
time_zone requiredstring
SiteApiTemplateDto object
SiteApiTemplateDto fields
FieldTypeAbout
body requiredstring
categorystring | null
channel required"whatsapp" | "email"
id requiredstring
languagestring | null
name requiredstring
status requiredstring
subjectstring | null
updated_at requiredstring (date-time)
SiteApiUnsubscribeDto object
SiteApiUnsubscribeDto fields
FieldTypeAbout
emailstring
group_id requiredstring
phonestring
SiteApiWorkspaceProfileDto object
SiteApiWorkspaceProfileDto fields
FieldTypeAbout
address requiredSiteApiAddressDto
brand_namestring | nullBrand / trading name.
cinstring | null
emailstring | null
founded_yearnumber | nullNot stored in RapBooster yet: always null (the site keeps its own).
gstinstring | nullGSTIN (India GST registrations only).
legal_namestring | nullRegistered (legal) name.
logo_urlstring | null
phonestring | null
socials requiredRecord<string, string>Network → profile URL (brand kit).
support_hoursSiteApiSupportHoursDto | null
tax_idstring | null
tax_id_labelstring | null
websitestring | null
SocialAccountDto object
SocialAccountDto fields
FieldTypeAbout
avatar_urlstring | null
connected_at requiredstring (date-time)
connected_bystring | null
external_id requiredstring
handlestring | null
id requiredstring
is_sandbox requiredboolean
last_errorstring | null
last_post_atstring (date-time) | null
name requiredstring
network required"facebook" | "instagram" | "linkedin" | "gbp" | "whatsapp_status"
paused_by_plan requiredbooleanPaused because the plan has fewer Social accounts.
scopes requiredstring[]
status required"connected" | "reconnect_needed" | "disconnected"
token_expires_atstring (date-time) | null
SocialAccountsDto object
SocialAccountsDto fields
FieldTypeAbout
allowance requiredSocialAllowanceDto
items requiredSocialAccountDto[]
SocialAllowanceDto object
SocialAllowanceDto fields
FieldTypeAbout
limit requirednumberWhat the plan allows (5 per Social unit).
used requirednumberAccounts counted now.
SocialMessageDto object
SocialMessageDto fields
FieldTypeAbout
author_namestring | null
body requiredstring
direction required"in" | "out"
id requiredstring
is_hidden requiredboolean
sent_at requiredstring (date-time)
sent_bystring | null
SocialPostDto object
SocialPostDto fields
FieldTypeAbout
approval_request_idstring | null
approved_bystring | null
body requiredstring
created_at requiredstring (date-time)
created_bystring | null
id requiredstring
link_urlstring | null
media_file_ids requiredstring[]
published_atstring (date-time) | null
rappy_draftstring | null
rappy_promptstring | null
rejection_notestring | nullThe approver's reason for sending it back.
scheduled_atstring (date-time) | null
status required"draft" | "awaiting_approval" | "scheduled" | "publishing" | "published" | "partly_failed" | "failed" | "cancelled"
targets requiredSocialPostTargetDto[]
updated_at requiredstring (date-time)
SocialPostInputDto object
SocialPostInputDto fields
FieldTypeAbout
bodystring
link_urlstring | null
media_file_idsstring[]Uploaded file ids (Files, app social), in order.
rappy_draftstring | nullSUG-25: what Rappy wrote, before the member's edit.
rappy_promptstring | nullSUG-25: what Rappy was asked.
targetsSocialPostTargetInputDto[]
SocialPostTargetDto object
SocialPostTargetDto fields
FieldTypeAbout
account_id requiredstring
account_name requiredstring
attempts requirednumber
body_overridestring | null
errorstring | nullWhy it failed (last attempt).
external_urlstring | null
id requiredstring
network required"facebook" | "instagram" | "linkedin" | "gbp" | "whatsapp_status"
options requiredSocialTargetOptionsDto
published_atstring (date-time) | null
status required"draft" | "scheduled" | "publishing" | "published" | "failed" | "cancelled"
SocialPostTargetInputDto object
SocialPostTargetInputDto fields
FieldTypeAbout
account_id requiredstring
body_overridestring | nullThis account's own text; null = the post's.
optionsSocialTargetOptionsDto
SocialScheduleDto object
SocialScheduleDto fields
FieldTypeAbout
atstring (date-time)Required with mode: at.
mode required"at" | "queue" | "now"at a time, the next free queue slot, or now.
SocialScheduleResultDto object
SocialScheduleResultDto fields
FieldTypeAbout
approval_request_idstring | null
approved_bystring | null
awaiting_approval requiredbooleanSent for approval rather than scheduled.
body requiredstring
created_at requiredstring (date-time)
created_bystring | null
id requiredstring
link_urlstring | null
media_file_ids requiredstring[]
published_atstring (date-time) | null
rappy_draftstring | null
rappy_promptstring | null
rejection_notestring | nullThe approver's reason for sending it back.
scheduled_atstring (date-time) | null
status required"draft" | "awaiting_approval" | "scheduled" | "publishing" | "published" | "partly_failed" | "failed" | "cancelled"
targets requiredSocialPostTargetDto[]
updated_at requiredstring (date-time)
SocialTargetOptionsDto object
SocialTargetOptionsDto fields
FieldTypeAbout
first_commentstringPosted as the first comment (Facebook, Instagram, LinkedIn).
gbp_coupon_codestring
gbp_cta_type"book" | "order" | "shop" | "learn_more" | "sign_up" | "call"
gbp_cta_urlstring
gbp_endstring (date)Event / offer end (GBP).
gbp_startstring (date)Event / offer start (GBP).
gbp_titlestringEvent or offer title (GBP).
gbp_type"standard" | "event" | "offer"
ig_format"feed" | "reel" | "story"Instagram: feed (a carousel with several media), reel or story.
SocialThreadDetailDto object
SocialThreadDetailDto fields
FieldTypeAbout
messages requiredSocialMessageDto[]
thread requiredSocialThreadDto
SocialThreadDto object
SocialThreadDto fields
FieldTypeAbout
account_id requiredstring
account_name requiredstring
assigned_tostring | null
author_handlestring | null
author_namestring | null
can_hide requiredboolean
can_reply requiredboolean
id requiredstring
kind required"comment" | "dm" | "review"
last_direction"in" | "out" | null
last_inbound_atstring (date-time) | null
last_message_at requiredstring (date-time)
lead_idstring | null
network required"facebook" | "instagram" | "linkedin" | "gbp" | "whatsapp_status"
post_target_idstring | null
ratingnumber | nullReviews: 1–5 stars.
reply_blocked_reason"window_closed" | "account_unavailable" | null
snippetstring | null
status required"open" | "done" | "hidden"
unread_count requirednumber
StoreApiAddressDto object
StoreApiAddressDto fields
FieldTypeAbout
city requiredstring
country_code requiredstring
gstinstring | null
id requiredstring
is_default requiredboolean
labelstring | null
landmarkstring | null
line1 requiredstring
line2string | null
name requiredstring
phonestring | null
postal_code requiredstring
state requiredstring
state_codestring | null
StoreApiAddressInputDto object
StoreApiAddressInputDto fields
FieldTypeAbout
city requiredstring
country_codestring
gstinstring
is_defaultboolean
labelstring
landmarkstring
line1 requiredstring
line2string
name requiredstring
phonestring
postal_code requiredstring
state requiredstring
state_codestring
StoreApiAddressUpdateDto object
StoreApiAddressUpdateDto fields
FieldTypeAbout
citystring
country_codestring
gstinstring
is_defaultboolean
labelstring
landmarkstring
line1string
line2string
namestring
phonestring
postal_codestring
statestring
state_codestring
StoreApiAppleSignInDto object
StoreApiAppleSignInDto fields
FieldTypeAbout
id_token requiredstring
namestring
noncestring
StoreApiBuyerDto object
StoreApiBuyerDto fields
FieldTypeAbout
consents requiredStoreApiConsentsDto
created_at requiredstring (date-time)
emailstring | null
groups requiredstring[]
id requiredstring
namestring | null
phonestring | null
sign_in requiredStoreApiSignInMethodsDto
tradeStoreApiBuyerTradeDto | null
StoreApiBuyerGroupsDto object
StoreApiBuyerGroupsDto fields
FieldTypeAbout
groups requiredstring[]
StoreApiBuyerSessionDto object
StoreApiBuyerSessionDto fields
FieldTypeAbout
access_token requiredstring
buyer requiredStoreApiBuyerDto
expires_in requirednumberSeconds (15 min).
is_new requiredboolean
refresh_expires_in requirednumberSeconds (30 days).
refresh_token requiredstring
StoreApiBuyerTradeDto object
StoreApiBuyerTradeDto fields
FieldTypeAbout
status required"applied" | "approved" | "rejected" | "suspended"
tierstring | null
StoreApiBuyerUpdateDto object
StoreApiBuyerUpdateDto fields
FieldTypeAbout
consentsStoreApiConsentInputDto
emailstring
namestring
StoreApiCartCreateDto object
StoreApiCartCreateDto fields
FieldTypeAbout
linesStoreApiCartLineInputDto[]
StoreApiCartDeliveryDto object
StoreApiCartDeliveryDto fields
FieldTypeAbout
address_idstring
pincodestring
StoreApiCartDto object
StoreApiCartDto fields
FieldTypeAbout
coupon_codestring | null
coupon_errorStoreApiCouponErrorDto | null
currency requiredstring
deliveryStoreApiDeliveryInfoDto | null
discounts requiredStoreApiDiscountDto[]
expires_at requiredstring (date-time)
free_delivery_gap_minornumber | nullHow much more to add for free delivery.
gift requiredStoreApiGiftDto
id requiredstring
lines requiredStoreApiCartLineDto[]
pincodestring | null
problems requiredstring[]
ready requiredbooleanTrue when checkout may start.
shipping_minor requirednumber
subtotal_minor requirednumber
tax_minor requirednumber
total_minor requirednumber
StoreApiCartGiftDto object
StoreApiCartGiftDto fields
FieldTypeAbout
is_gift requiredboolean
messagestring
StoreApiCartLineDto object
StoreApiCartLineDto fields
FieldTypeAbout
image_urlstring | null
line_total_minor requirednumber
mrp_minornumber | null
name requiredstring
price_id requiredstring
problemstring | nullout_of_stock, price_changed, moq_not_met, unavailable.
product_slug requiredstring
qty requirednumber
stock_state required"in_stock" | "low" | "out"
unit_price_minor requirednumber
variant_namestring | null
StoreApiCartLineInputDto object
StoreApiCartLineInputDto fields
FieldTypeAbout
price_id requiredstring
qty requirednumber
StoreApiCartLinesDto object
StoreApiCartLinesDto fields
FieldTypeAbout
lines requiredStoreApiCartLineInputDto[]Replaces every line.
StoreApiCategoryDto object
StoreApiCategoryDto fields
FieldTypeAbout
id requiredstring
image_urlstring | null
name requiredstring
parent_idstring | null
product_count requirednumber
slug requiredstring
StoreApiCheckoutConfigDto object
StoreApiCheckoutConfigDto fields
FieldTypeAbout
auth_methods requiredstring[]
captcha_required requiredboolean
google_client_ids requiredstring[]
payment_methods requiredstring[]
razorpay_key_idstring | null
StoreApiCheckoutConsentDto object
StoreApiCheckoutConsentDto fields
FieldTypeAbout
terms requiredtrue
StoreApiCheckoutDto object
StoreApiCheckoutDto fields
FieldTypeAbout
address_id requiredstring
bill_address_idstring
cart_id requiredstring
channel required"web" | "app"
consent requiredStoreApiCheckoutConsentDto
gstinstring
metadataRecord<string, string>At most 20 string keys, 1 KB; echoed in the order webhooks.
payment_method required"razorpay" | "credit"
StoreApiCheckoutResultDto object
StoreApiCheckoutResultDto fields
FieldTypeAbout
creditStoreApiCreditTermsDto | null
currency requiredstring
order_number requiredstring
payment_method required"razorpay" | "credit"
razorpayStoreApiRazorpayOrderDto | null
status required"awaiting_payment" | "paid" | "packed" | "shipped" | "delivered" | "cancelled" | "refunded" | "partially_refunded"
total_minor requirednumber
StoreApiClaimCreateDto object
StoreApiClaimCreateDto fields
FieldTypeAbout
kind required"damaged" | "wrong_item" | "missing"
lines requiredStoreApiCartLineInputDto[]
notestring
upload_ids requiredstring[]upload_ids (purpose claim): a photo is required.
StoreApiClaimDto object
StoreApiClaimDto fields
FieldTypeAbout
created_at requiredstring (date-time)
id requiredstring
kind required"damaged" | "wrong_item" | "missing"
notestring | null
order_number requiredstring
photo_urls requiredstring[]
refund_minornumber | null
resolved_atstring (date-time) | null
status required"open" | "replaced" | "refunded" | "rejected"
StoreApiComponentDto object
StoreApiComponentDto fields
FieldTypeAbout
name requiredstring
qty requirednumber
StoreApiConsentInputDto object
StoreApiConsentInputDto fields
FieldTypeAbout
offers_emailboolean
offers_pushboolean
offers_whatsappboolean
order_whatsappboolean
StoreApiConsentStateDto object
StoreApiConsentStateDto fields
FieldTypeAbout
atstring (date-time) | null
on requiredboolean
StoreApiConsentsDto object
StoreApiConsentsDto fields
FieldTypeAbout
offers_email requiredStoreApiConsentStateDto
offers_push requiredStoreApiConsentStateDto
offers_whatsapp requiredStoreApiConsentStateDto
order_whatsapp requiredStoreApiConsentStateDto
StoreApiCouponDto object
StoreApiCouponDto fields
FieldTypeAbout
code requiredstring
StoreApiCouponErrorDto object
StoreApiCouponErrorDto fields
FieldTypeAbout
code requiredstring
reason required"expired" | "min_order" | "not_eligible" | "used" | "unknown"
StoreApiCreditTermsDto object
StoreApiCreditTermsDto fields
FieldTypeAbout
due_on requiredstringYYYY-MM-DD
StoreApiDeliveryInfoDto object
StoreApiDeliveryInfoDto fields
FieldTypeAbout
eta_fromstring | null
eta_tostring | null
serviceable requiredboolean
StoreApiDeviceDto object
StoreApiDeviceDto fields
FieldTypeAbout
expo_push_token requiredstring
offers_opt_in requiredboolean
platform required"ios" | "android" | "web"
StoreApiDiscountDto object
StoreApiDiscountDto fields
FieldTypeAbout
amount_minor requirednumber
codestring | null
kind required"percent" | "flat" | "free_shipping" | "bxgy" | "tiered"
label requiredstring
offer_id requiredstring
StoreApiFoodInfoDto object
StoreApiFoodInfoDto fields
FieldTypeAbout
allergens requiredstring[]
fssai_licencestring | null
ingredientsstring | null
label_notestring | null
makerStoreApiMakerDto | null
may_contain requiredstring[]
nutrition_per100gStoreApiNutritionDto | null
origin_countrystring | null
shelf_life_daysnumber | null
storagestring | null
veg requiredboolean
StoreApiGiftDto object
StoreApiGiftDto fields
FieldTypeAbout
is_gift requiredboolean
messagestring | null
StoreApiGoogleSignInDto object
StoreApiGoogleSignInDto fields
FieldTypeAbout
id_token requiredstring
StoreApiGrievanceOfficerDto object
StoreApiGrievanceOfficerDto fields
FieldTypeAbout
emailstring | null
namestring | null
phonestring | null
StoreApiInfoDto object
StoreApiInfoDto fields
FieldTypeAbout
accentstring | null
checkout requiredStoreApiCheckoutConfigDto
currency requiredstring
legal requiredStoreApiLegalDto
logo_urlstring | null
name requiredstring
policies requiredStoreApiPolicyRefDto[]
shipping requiredStoreApiShippingConfigDto
slug requiredstring
support requiredStoreApiSupportDto
taglinestring | null
StoreApiInvoiceLinkDto object
StoreApiInvoiceLinkDto fields
FieldTypeAbout
expires_at requiredstring (date-time)
number requiredstring
url requiredstringSigned, 10 minutes.
StoreApiInvoiceRefDto object
StoreApiInvoiceRefDto fields
FieldTypeAbout
available requiredboolean
number requiredstring
StoreApiLedgerEntryDto object
StoreApiLedgerEntryDto fields
FieldTypeAbout
balance_minor requirednumber
credit_minor requirednumber
date requiredstringYYYY-MM-DD
debit_minor requirednumber
due_onstring | null
kind required"invoice" | "payment" | "credit_note"
number requiredstring
StoreApiLegalDto object
StoreApiLegalDto fields
FieldTypeAbout
addressstring | null
fssai_licencestring | nullFSSAI licence (food sellers).
grievance_officer requiredStoreApiGrievanceOfficerDto
gstinstring | null
seller_name requiredstring
StoreApiMakerDto object
StoreApiMakerDto fields
FieldTypeAbout
addressstring | null
name requiredstring
StoreApiNutritionDto object
StoreApiNutritionDto fields
FieldTypeAbout
added_sugar_gnumber | null
carbs_gnumber | null
energy_kcalnumber | null
fat_gnumber | null
protein_gnumber | null
sat_fat_gnumber | null
sodium_mgnumber | null
sugar_gnumber | null
trans_fat_gnumber | null
StoreApiOrderAddressDto object
StoreApiOrderAddressDto fields
FieldTypeAbout
city requiredstring
country_code requiredstring
line1 requiredstring
line2string | null
name requiredstring
phonestring | null
postal_code requiredstring
state requiredstring
StoreApiOrderDto object
StoreApiOrderDto fields
FieldTypeAbout
bill_addressStoreApiOrderAddressDto | null
can_reorder requiredboolean
can_review requiredstring[]Product ids the buyer may review.
claim_window_ends_atstring (date-time) | null
claims requiredStoreApiClaimDto[]
currency requiredstring
delivered_atstring (date-time) | null
discounts requiredStoreApiDiscountDto[]
gift requiredStoreApiGiftDto
gstinstring | null
invoiceStoreApiInvoiceRefDto | null
lines requiredStoreApiOrderLineDto[]
metadataRecord<string, string> | null
number requiredstring
paid_atstring (date-time) | null
payment requiredStoreApiOrderPaymentDto
placed_at requiredstring (date-time)
ship_address requiredStoreApiOrderAddressDto
shipments requiredStoreApiShipmentDto[]
shipping_minor requirednumber
status required"awaiting_payment" | "paid" | "packed" | "shipped" | "delivered" | "cancelled" | "refunded" | "partially_refunded"
subtotal_minor requirednumber
tax_lines requiredStoreApiTaxLineDto[]
total_minor requirednumber
StoreApiOrderLineDto object
StoreApiOrderLineDto fields
FieldTypeAbout
image_urlstring | null
line_total_minor requirednumber
name requiredstring
price_id requiredstring
product_id requiredstring
product_slugstring | null
qty requirednumber
unit_price_minor requirednumber
variant_namestring | null
StoreApiOrderPaymentDto object
StoreApiOrderPaymentDto fields
FieldTypeAbout
due_onstring | null
method required"razorpay" | "credit"
status required"pending" | "paid" | "refunded" | "partially_refunded" | "due"
StoreApiOrderSummaryDto object
StoreApiOrderSummaryDto fields
FieldTypeAbout
currency requiredstring
first_image_urlstring | null
item_count requirednumber
number requiredstring
placed_at requiredstring (date-time)
status required"awaiting_payment" | "paid" | "packed" | "shipped" | "delivered" | "cancelled" | "refunded" | "partially_refunded"
total_minor requirednumber
StoreApiOtpRequestDto object
StoreApiOtpRequestDto fields
FieldTypeAbout
captcha_tokenstringreCAPTCHA token when the store requires it.
phone requiredstring
StoreApiOtpRequestedDto object
StoreApiOtpRequestedDto fields
FieldTypeAbout
expires_in requirednumberSeconds.
request_id requiredstring
resend_in requirednumberSeconds before a resend is allowed.
StoreApiOtpVerifyDto object
StoreApiOtpVerifyDto fields
FieldTypeAbout
code requiredstring
marketing_consentboolean
namestring
phone requiredstring
request_id requiredstring
terms_accepted requiredtrue
StoreApiPaymentConfirmDto object
StoreApiPaymentConfirmDto fields
FieldTypeAbout
razorpay_order_id requiredstring
razorpay_payment_id requiredstring
razorpay_signature requiredstring
StoreApiPolicyDto object
StoreApiPolicyDto fields
FieldTypeAbout
html requiredstring
kind required"refund" | "shipping" | "terms" | "privacy" | "returns"
title requiredstring
updated_atstring (date-time) | null
StoreApiPolicyRefDto object
StoreApiPolicyRefDto fields
FieldTypeAbout
kind required"refund" | "shipping" | "terms" | "privacy" | "returns"
title requiredstring
StoreApiProductDto object
StoreApiProductDto fields
FieldTypeAbout
category_slugs requiredstring[]
components requiredStoreApiComponentDto[]
currency requiredstring
description_html requiredstring
foodStoreApiFoodInfoDto | null
from_price_minor requirednumber
id requiredstring
image_urlstring | null
image_urls requiredstring[]
is_featured requiredboolean
kind required"product" | "combo"
mrp_minornumber | null
name requiredstring
rating requiredStoreApiRatingDto
related requiredStoreApiProductSummaryDto[]
requires_shipping requiredboolean
seo requiredStoreApiSeoDto
short_descriptionstring | null
slug requiredstring
stock_state required"in_stock" | "low" | "out"
updated_at requiredstring (date-time)
variants requiredStoreApiVariantDto[]
StoreApiProductSummaryDto object
StoreApiProductSummaryDto fields
FieldTypeAbout
category_slugs requiredstring[]
currency requiredstring
from_price_minor requirednumber
id requiredstring
image_urlstring | null
is_featured requiredboolean
kind required"product" | "combo"
mrp_minornumber | null
name requiredstring
rating requiredStoreApiRatingDto
requires_shipping requiredboolean
short_descriptionstring | null
slug requiredstring
stock_state required"in_stock" | "low" | "out"
updated_at requiredstring (date-time)
StoreApiRatingDto object
StoreApiRatingDto fields
FieldTypeAbout
avg requirednumber
count requirednumber
StoreApiRatingSummaryDto object
StoreApiRatingSummaryDto fields
FieldTypeAbout
avg requirednumberAverage of the published ratings, one decimal; 0 with none.
by_star requiredRecord<string, integer>Published reviews per star, keys 1..5.
count requirednumber
StoreApiRazorpayOrderDto object
StoreApiRazorpayOrderDto fields
FieldTypeAbout
amount requirednumber
currency requiredstring
description requiredstring
key_id requiredstring
name requiredstring
order_id requiredstring
prefill requiredStoreApiRazorpayPrefillDto
StoreApiRazorpayPrefillDto object
StoreApiRazorpayPrefillDto fields
FieldTypeAbout
contactstring | null
emailstring | null
namestring | null
StoreApiRazorpaySubscriptionDto object
StoreApiRazorpaySubscriptionDto fields
FieldTypeAbout
key_id requiredstring
subscription_id requiredstring
StoreApiRefreshDto object
StoreApiRefreshDto fields
FieldTypeAbout
refresh_token requiredstring
StoreApiReviewCreateDto object
StoreApiReviewCreateDto fields
FieldTypeAbout
bodystring
order_number requiredstring
product_id requiredstring
rating requirednumber
titlestring
upload_idsstring[]upload_ids from POST me/uploads (purpose review).
StoreApiReviewDto object
StoreApiReviewDto fields
FieldTypeAbout
author_name requiredstringFirst name and initial.
bodystring | null
created_at requiredstring (date-time)
id requiredstring
photo_urls requiredstring[]
product_id requiredstring
rating requirednumber
replystring | null
status required"pending" | "published" | "rejected"
titlestring | null
verified requiredboolean
StoreApiReviewPageMetaDto object
StoreApiReviewPageMetaDto fields
FieldTypeAbout
has_next_page requiredboolean
has_previous_page requiredboolean
limit requirednumber
page requirednumber
summary requiredStoreApiRatingSummaryDto
total_items requirednumber
total_pages requirednumber
StoreApiSeoDto object
StoreApiSeoDto fields
FieldTypeAbout
canonical_path requiredstring
description requiredstring
title requiredstring
StoreApiShipmentDto object
StoreApiShipmentDto fields
FieldTypeAbout
awbstring | null
courierstring | null
eta_onstring | null
events requiredStoreApiShipmentEventDto[]
status requiredstring
tracking_urlstring | null
StoreApiShipmentEventDto object
StoreApiShipmentEventDto fields
FieldTypeAbout
at requiredstring (date-time)
locationstring | null
status requiredstring
StoreApiShippingConfigDto object
StoreApiShippingConfigDto fields
FieldTypeAbout
fee_minor requirednumber
free_above_minornumber | null
StoreApiShippingQuoteDto object
StoreApiShippingQuoteDto fields
FieldTypeAbout
courierstring | null
eta_fromstring | nullYYYY-MM-DD
eta_tostring | nullYYYY-MM-DD
fee_minor requirednumber
free_above_minornumber | null
pincode requiredstring
serviceable requiredboolean
StoreApiSignInMethodsDto object
StoreApiSignInMethodsDto fields
FieldTypeAbout
apple requiredboolean
google requiredboolean
phone requiredboolean
StoreApiSubscriptionCreateDto object
StoreApiSubscriptionCreateDto fields
FieldTypeAbout
address_idstring
interval"monthly" | "bimonthly" | "yearly"Box subscriptions.
linesStoreApiCartLineInputDto[]
plan_codestringPlan subscriptions: a code from GET subscription-plans.
StoreApiSubscriptionDto object
StoreApiSubscriptionDto fields
FieldTypeAbout
addressStoreApiAddressDto | null
discount_pct requirednumber
id requiredstring
interval required"monthly" | "bimonthly" | "yearly"
kind required"box" | "plan"
lines requiredStoreApiOrderLineDto[]
next_charge_atstring (date-time) | null
plan_codestring | null
razorpayStoreApiRazorpaySubscriptionDto | nullOn create.
skip_next requiredboolean
status required"created" | "active" | "paused" | "cancelled" | "halted"
total_minor requirednumber
StoreApiSubscriptionPlanDto object
StoreApiSubscriptionPlanDto fields
FieldTypeAbout
code requiredstring
discount_pct requirednumber
interval required"monthly" | "bimonthly" | "yearly"
kind required"box" | "plan"
label requiredstring
price_minornumber | null
StoreApiSubscriptionUpdateDto object
StoreApiSubscriptionUpdateDto fields
FieldTypeAbout
address_idstring
interval"monthly" | "bimonthly" | "yearly"
linesStoreApiCartLineInputDto[]
StoreApiSupportDto object
StoreApiSupportDto fields
FieldTypeAbout
emailstring | null
hoursstring | null
phonestring | null
whatsappstring | null
StoreApiTaxLineDto object
StoreApiTaxLineDto fields
FieldTypeAbout
cgst_minor requirednumber
igst_minor requirednumber
rate requirednumber
sgst_minor requirednumber
taxable_minor requirednumber
StoreApiTradeAccountDto object
StoreApiTradeAccountDto fields
FieldTypeAbout
available_credit_minor requirednumber
business_name requiredstring
credit_days requirednumber
credit_limit_minor requirednumber
gstin requiredstring
outstanding_minor requirednumber
status required"applied" | "approved" | "rejected" | "suspended"
tierstring | null
StoreApiTradeApplyDto object
StoreApiTradeApplyDto fields
FieldTypeAbout
address_id requiredstring
business_name requiredstring
business_type requiredstring
gstin requiredstring
StoreApiUploadDto object
StoreApiUploadDto fields
FieldTypeAbout
upload_id requiredstring
url requiredstring
StoreApiUploadFormDto object
StoreApiUploadFormDto fields
FieldTypeAbout
file requiredstring (binary)jpeg / png / webp, at most 5 MB.
purpose required"claim" | "review"
StoreApiVariantDto object
StoreApiVariantDto fields
FieldTypeAbout
carton_qtynumber | null
hsnstring | null
max_qtynumber | null
min_cartonsnumber | null
min_qty requirednumber
mrp_minornumber | null
name requiredstring
net_weight_gnumber | null
price_id requiredstring
price_list requiredstringretail or the trade tier.
price_per100g_minornumber | null
skustring | null
stock_state required"in_stock" | "low" | "out"
tax_inclusive requiredboolean
tax_rate requirednumber
unit_price_minor requirednumberThe trade price for an approved trade buyer, else retail.
StoreBuyerAddressDto object
StoreBuyerAddressDto fields
FieldTypeAbout
citystring
country_codestring
line1string
line2string
postal_codestring
statestring
StoreBuyerShipmentDto object
StoreBuyerShipmentDto fields
FieldTypeAbout
carrier requiredstring
delivered_atstring (date-time)
shipped_atstring (date-time)
tracking_nostring
tracking_urlstring
StoreGrievanceOfficerDto object
StoreGrievanceOfficerDto fields
FieldTypeAbout
emailstring
namestring
phonestring
StoreItemDto object
StoreItemDto fields
FieldTypeAbout
action required"buy" | "enquire" | "default"
catalogue_active requiredbooleanFalse when the catalogue item is not ACTIVE: hidden from buyers.
created_at requiredstring (date-time)
delivery_charge_minorinteger
effective_action required"buy" | "enquire"
from_price_minorinteger
id requiredstring
is_featured requiredboolean
is_visible requiredboolean
item_id requiredstring
item_type required"products" | "services"
name requiredstring
sort_order requiredinteger
stock required"in_stock" | "low_stock" | "out_of_stock"
StoreItemRefDto object
StoreItemRefDto fields
FieldTypeAbout
item_id requiredstringThe catalogue product or service id.
item_type required"products" | "services"
StoreItemsAddedDto object
StoreItemsAddedDto fields
FieldTypeAbout
items requiredStoreItemDto[]
StoreOrderDetailDto object
StoreOrderDetailDto fields
FieldTypeAbout
bill_addressStoreBuyerAddressDto
buyer_emailstring
buyer_gstinstring
buyer_idstringThe store buyer (Store API orders).
buyer_name requiredstring
buyer_phonestring
cancelled_atstring (date-time)
catalogue_order_idstringThe Orders app's order.
channel required"web" | "app" | "api" | "shop"Where it was placed (shop = the hosted shop).
created_at requiredstring (date-time)
credit_due_onstringTrade credit: the day the invoice falls due (YYYY-MM-DD).
currency requiredstring
delivery_minor requiredinteger
discount_minor requiredinteger
fulfilmentStoreOrderFulfilmentDtoAbsent until the Orders app's goods order opens (COD at checkout, online once paid).
gift_messagestring
goods_minor requiredinteger
id requiredstring
invoice_idstringThe Sales document (proforma, then tax invoice).
is_gift requiredboolean
lead_idstringThe lead (CRM).
lines requiredStoreOrderLineDto[]
metadataRecord<string, string>
numberstring
paid_atstring (date-time)
paymentStoreOrderPaymentDtoAbsent when the Sales document could not be read.
payment_mode required"online" | "cod" | "credit"
place_of_supplystring
ship_address requiredStoreBuyerAddressDto
status required"placed" | "awaiting_payment" | "paid" | "cancelled"
total_minor requiredinteger
StoreOrderDto object
StoreOrderDto fields
FieldTypeAbout
buyer_emailstring
buyer_idstringThe store buyer (Store API orders).
buyer_name requiredstring
buyer_phonestring
catalogue_order_idstringThe Orders app's order.
channel required"web" | "app" | "api" | "shop"Where it was placed (shop = the hosted shop).
created_at requiredstring (date-time)
currency requiredstring
delivery_minor requiredinteger
goods_minor requiredinteger
id requiredstring
invoice_idstringThe Sales document (proforma, then tax invoice).
is_gift requiredboolean
lead_idstringThe lead (CRM).
lines requiredStoreOrderLineDto[]
numberstring
paid_atstring (date-time)
payment_mode required"online" | "cod" | "credit"
place_of_supplystring
status required"placed" | "awaiting_payment" | "paid" | "cancelled"
total_minor requiredinteger
StoreOrderFulfilmentDto object
StoreOrderFulfilmentDto fields
FieldTypeAbout
cancelled_atstring (date-time)
delivered_atstring (date-time)
order_id requiredstringThe Orders app's order (ship, deliver and cancel happen there).
order_number requiredstring
shipments requiredStoreBuyerShipmentDto[]
status required"CONFIRMED" | "SHIPPED" | "DELIVERED" | "CANCELLED" | "RETURNED"
StoreOrderLineDto object
StoreOrderLineDto fields
FieldTypeAbout
name requiredstring
qty requiredinteger
unit_price_minor requiredinteger
variant_name requiredstring
StoreOrderPaymentDto object
StoreOrderPaymentDto fields
FieldTypeAbout
amount_due_minor requiredinteger
amount_paid_minor requiredinteger
document_idstringThe document that takes the money now (its tax invoice once converted).
document_numberstring
receipts requiredStoreOrderReceiptDto[]
StoreOrderReceiptDto object
StoreOrderReceiptDto fields
FieldTypeAbout
amount_minor requiredinteger
currency requiredstring
id requiredstring
kind required"PAYMENT" | "REFUND"
method required"RAZORPAY" | "STRIPE" | "PAYTM" | "CCAVENUE" | "MANUAL" | "ADVANCE"The gateway that took it, MANUAL (recorded by a member) or ADVANCE (applied).
paid_at requiredstring (date-time)
referencestringThe gateway's payment id, else the member's reference (UTR, refund id).
StoreRemovedDto object
StoreRemovedDto fields
FieldTypeAbout
id requiredstring
StoreSettingsDto object
StoreSettingsDto fields
FieldTypeAbout
accent_colorstring
apple_audiences requiredstring[]
auth_methods required"phone_otp" | "google" | "apple"[]
business_profile_idstring
cod_enabled requiredboolean
contact_emailstring
contact_phonestring
currency requiredstringThe workspace's selling currency (Sales settings).
default_action required"buy" | "enquire"
delivery_flat_minor requiredinteger
delivery_free_above_minorinteger
delivery_mode required"flat" | "per_item" | "free"
delivery_sac requiredstring
delivery_tax_rate requirednumber
display_namestring
fssai_licencestring
gateway_configured requiredbooleanWhether a payment gateway is ready (online payment may be switched on).
google_client_ids requiredstring[]
grievance_contactstring
grievance_officerStoreGrievanceOfficerDto
logo_file_idstring
marketing_consent_textstring
online_enabled requiredboolean
policy_privacystring
policy_refundstring
policy_shippingstring
policy_termsstring
require_captcha requiredboolean
support_hoursstring
taglinestring
whatsapp_numberstring
SupportCategoryDto object
SupportCategoryDto fields
FieldTypeAbout
created_at requiredstring (date-time)
id requiredstring
is_active requiredboolean
name requiredstring
sort_order requirednumber
updated_at requiredstring (date-time)
SupportCategoryRefDto object
SupportCategoryRefDto fields
FieldTypeAbout
id requiredstring
name requiredstring
SupportEmailReplyStateDto object
SupportEmailReplyStateDto fields
FieldTypeAbout
can_reply requiredboolean
from_emailstring | nullReplies are sent from this address.
reason"paused" | "no_access" | "missing" | nullWhy not: the connection is paused, the member has no access to it, or it is gone.
SupportLeadRefDto object
SupportLeadRefDto fields
FieldTypeAbout
emailstring | null
id requiredstring
mobilestring | null
name requiredstring
SupportTicketAttachmentDto object
SupportTicketAttachmentDto fields
FieldTypeAbout
file_id requiredstring
file_name requiredstring
mime_type requiredstring
size_bytes requiredstring
urlstring | nullShort-lived download URL; absent when storage couldn't sign it.
SupportTicketDto object
SupportTicketDto fields
FieldTypeAbout
assigned_user_idstring | null
assignee_namestring | null
categorySupportCategoryRefDto | null
closed_atstring (date-time) | null
contact_idstring | null
created_at requiredstring (date-time)
created_by requiredstring
customer_emailstring | nullEMAIL tickets: the customer's address.
email_connection_idstring | nullEMAIL tickets: the Email Marketing connection replies go out on.
email_replySupportEmailReplyStateDto | nullEMAIL tickets only: read-only when the reader cannot reply (C-A9, C-A40).
first_reply_due_atstring (date-time) | nullcreated_at + the priority's first-reply target. Absent when SLA is off or no target.
first_response_atstring (date-time) | null
id requiredstring
last_agent_message_atstring (date-time) | null
last_customer_message_atstring (date-time) | null
last_message_atstring (date-time) | null
leadSupportLeadRefDto | null
lead_id requiredstring
messages requiredSupportTicketMessageDto[]
priority required"LOW" | "NORMAL" | "HIGH" | "URGENT"
resolutionstring | null
resolve_due_atstring (date-time) | nullcreated_at + the priority's resolve target. Absent when SLA is off or no target.
resolved_atstring (date-time) | null
resolved_bystring | null
sla_state"ok" | "due_soon" | "late" | nullThe worse of the two clocks: late = a target was missed (stays so after a late reply), due_soon = a running clock has 20% or less of its target left, else ok. A first public reply stops the first-reply clock; resolving or closing stops both. Absent when SLA is off or the priority has no target.
source required"MANUAL" | "WHATSAPP" | "EMAIL" | "PRODUCT"
status required"AWAITING_SUPPORT" | "AWAITING_CUSTOMER" | "ON_HOLD" | "RESOLVED" | "CLOSED"
subject requiredstring
ticket_number requiredstring
unread requiredbooleanA customer message nobody has opened since, or never opened.
updated_at requiredstring (date-time)
waba_conversation_idstring | null
wal_chat_idstring | nullPlan 29: the linked WhatsApp chat the ticket was opened from.
SupportTicketMessageDto object
SupportTicketMessageDto fields
FieldTypeAbout
attachments requiredSupportTicketAttachmentDto[]
author_namestring | null
author_type required"CUSTOMER" | "AGENT" | "SYSTEM"
author_user_idstring | null
body requiredstring
created_at requiredstring (date-time)
id requiredstring
sender_channel"official" | "linked" | nullPlan 29: which WhatsApp carried this message; null on email, manual and older ones.
sender_numberstring | nullThe number as +<digits>, linked or official (plan 34); null when it is no longer known.
sender_number_idstring | nullThe number on that side: Meta's phone-number id (official) or the linked number's id.
via_email requiredbooleanTrue when this message came in, or went out, by email.
via_whatsapp requiredbooleanTrue when this message came from, or went to, the WhatsApp chat.
visibility required"PUBLIC" | "INTERNAL"
SupportTicketSummaryDto object
SupportTicketSummaryDto fields
FieldTypeAbout
assigned_user_idstring | null
assignee_namestring | null
categorySupportCategoryRefDto | null
closed_atstring (date-time) | null
contact_idstring | null
created_at requiredstring (date-time)
created_by requiredstring
customer_emailstring | nullEMAIL tickets: the customer's address.
email_connection_idstring | nullEMAIL tickets: the Email Marketing connection replies go out on.
first_reply_due_atstring (date-time) | nullcreated_at + the priority's first-reply target. Absent when SLA is off or no target.
first_response_atstring (date-time) | null
id requiredstring
last_agent_message_atstring (date-time) | null
last_customer_message_atstring (date-time) | null
last_message_atstring (date-time) | null
leadSupportLeadRefDto | null
lead_id requiredstring
priority required"LOW" | "NORMAL" | "HIGH" | "URGENT"
resolve_due_atstring (date-time) | nullcreated_at + the priority's resolve target. Absent when SLA is off or no target.
resolved_atstring (date-time) | null
sla_state"ok" | "due_soon" | "late" | nullThe worse of the two clocks: late = a target was missed (stays so after a late reply), due_soon = a running clock has 20% or less of its target left, else ok. A first public reply stops the first-reply clock; resolving or closing stops both. Absent when SLA is off or the priority has no target.
source required"MANUAL" | "WHATSAPP" | "EMAIL" | "PRODUCT"
status required"AWAITING_SUPPORT" | "AWAITING_CUSTOMER" | "ON_HOLD" | "RESOLVED" | "CLOSED"
subject requiredstring
ticket_number requiredstring
unread requiredbooleanA customer message nobody has opened since, or never opened.
updated_at requiredstring (date-time)
waba_conversation_idstring | null
wal_chat_idstring | nullPlan 29: the linked WhatsApp chat the ticket was opened from.
SyncConflictDto object
SyncConflictDto fields
FieldTypeAbout
applied_atstring (date-time)When a run wrote the pick.
choice"local" | "remote"
connection_id requiredstring
connection_name requiredstring
created_at requiredstring (date-time)
field required"name" | "description" | "sku" | "price" | "stock"
id requiredstring
label requiredstringThe catalogue item (and variant).
link_id requiredstring
local_changed_atstring (date-time)When the conflict was found on our side.
local_changed_bystring
local_valuestringOurs, as text (price in minor units, stock a count).
price_id requiredstring
product_id requiredstring
provider required"shopify" | "woocommerce" | "meta_catalog"
remote_changed_atstring (date-time)The platform's last change of the item.
remote_valuestringTheirs, as text.
resolved_atstring (date-time)
resolved_bystring
status required"open" | "resolved" | "dismissed"
SyncConnectionDto object
SyncConnectionDto fields
FieldTypeAbout
created_at requiredstring (date-time)
display_name requiredstring
field_rules requiredFieldRulesDto
id requiredstring
is_sandbox requiredboolean
last_errorstring
last_full_sync_atstring (date-time)
last_runSyncLastRunDto
last_run_atstring (date-time)
links requirednumberLinked catalogue variants.
open_conflicts requirednumber
provider required"shopify" | "woocommerce" | "meta_catalog"
remote_hoststringShop domain, site address or catalogue id. Keys are never returned.
status required"connected" | "error" | "paused" | "dry_run"dry_run: waiting for a member to confirm the first sync's dry run.
SyncLastRunDto object
SyncLastRunDto fields
FieldTypeAbout
finished_atstring (date-time)
id requiredstring
kind required"full" | "webhook" | "poll" | "dry_run" | "manual" | "local"
status required"running" | "done" | "failed"
SyncLinkDto object
SyncLinkDto fields
FieldTypeAbout
connection_id requiredstring
created_at requiredstring (date-time)
id requiredstring
label requiredstring
last_synced_atstring (date-time)
price_id requiredstring
product_id requiredstring
remote_product_id requiredstring
remote_review_reasonstring
remote_review_statusstringMeta's review of the item (its words: pending, approved, rejected…).
remote_variant_id requiredstring
SyncReportChangeDto object
SyncReportChangeDto fields
FieldTypeAbout
conflict requirednumber
field required"name" | "description" | "sku" | "price" | "stock"
pull requirednumber
push requirednumber
SyncReportLocalDto object
SyncReportLocalDto fields
FieldTypeAbout
label requiredstring
price_id requiredstring
SyncReportMatchDto object
SyncReportMatchDto fields
FieldTypeAbout
by required"sku" | "name"
label requiredstring
price_id requiredstring
remote_variant_id requiredstring
SyncReportRemoteDto object
SyncReportRemoteDto fields
FieldTypeAbout
label requiredstring
remote_variant_id requiredstring
SyncRunDto object
SyncRunDto fields
FieldTypeAbout
conflicts requirednumber
connection_id requiredstring
created requirednumber
created_at requiredstring (date-time)
errorstring
failed requirednumber
finished_atstring (date-time)
id requiredstring
kind required"full" | "webhook" | "poll" | "dry_run" | "manual" | "local"
linked requirednumber
pulled requirednumber
pushed requirednumber
reportSyncRunReportDtoOnly on GET store/sync/runs/:id.
started_at requiredstring (date-time)
started_bystring
status required"running" | "done" | "failed"
unchanged requirednumber
SyncRunReportDto object
SyncRunReportDto fields
FieldTypeAbout
changes requiredSyncReportChangeDto[]
errors requiredstring[]
matched requiredSyncReportMatchDto[]
truncated requiredbooleanLists were cut at 200 rows.
unmatched_local requiredSyncReportLocalDto[]Ours with no match: created there when the name syncs out.
unmatched_remote requiredSyncReportRemoteDto[]Theirs with no match: not imported.
UpdateStoreItemDto object
UpdateStoreItemDto fields
FieldTypeAbout
action"buy" | "enquire" | "default"Services stay enquire.
delivery_charge_minorinteger | null
is_featuredboolean
is_visibleboolean
sort_orderinteger
UpdateWebhookEndpointDto object
UpdateWebhookEndpointDto fields
FieldTypeAbout
eventsstring[]Event names from GET webhook-events (e.g. lead.created, lead.updated, message.status).
is_enabledboolean
urlstring
WebhookEndpointDto object
WebhookEndpointDto fields
FieldTypeAbout
created_at requiredstring (date-time)
disabled_atstring (date-time) | null
disabled_reason"failing" | "manual" | null
events requiredstring[]Event names from GET webhook-events (e.g. lead.created, lead.updated, message.status).
failing_sincestring (date-time) | nullFailing without a success since then; 3 days of it turn the endpoint off.
failure_count requirednumberFailed attempts since the last success.
id requiredstring
is_enabled requiredboolean
last_delivered_atstring (date-time) | null
last_failure_atstring (date-time) | null
previous_secret_expires_atstring (date-time) | nullAfter a rotation: the old secret also signs until then.
url requiredstring