Connect Commerce API
API reference
Connect Commerce — API Reference
Base URL: https://api.goldrail.xyz (also https://api.openconnect.cc, where /connect/* = /api/connect/*).
Every route below also answers under the train alias /api/genesis/.... Generated from the Official Postman collection (goldrail-api/postman/official-connect-commerce.collection.json), itself built from the route inventory of the code. The Auth column gives the expected credential.
Guides: Connect Commerce.
cashout
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/cashout/client/nearby?lat=14.6937&lng=-17.4441&radius_km=8 | Nearby agents | API key |
| GET | /api/connect/commerce/cashout/client/agents/{cashoutAgentId} | Get agent | API key |
| POST | /api/connect/commerce/cashout/client/sessions | Create session | API key |
| GET | /api/connect/commerce/cashout/client/sessions?customer_id={customerId} | List client sessions | API key |
| GET | /api/connect/commerce/cashout/client/sessions/{cashoutSessionId} | Get session | API key |
| POST | /api/connect/commerce/cashout/client/sessions/{cashoutSessionId}/cancel | Cancel session | API key |
| POST | /api/connect/commerce/cashout/business/agents | Create agent | API key |
| GET | /api/connect/commerce/cashout/business/agents?customer_id={customerId} | List owner agents | API key |
| GET | /api/connect/commerce/cashout/business/agents/{cashoutAgentId}?customer_id={customerId} | Get owner agent | API key |
| PATCH | /api/connect/commerce/cashout/business/agents/{cashoutAgentId} | Patch agent | API key |
| POST | /api/connect/commerce/cashout/business/agents/{cashoutAgentId}/open | Set open | API key |
| GET | /api/connect/commerce/cashout/business/agents/{cashoutAgentId}/qr?customer_id={customerId} | Agent QR | API key |
| POST | /api/connect/commerce/cashout/business/agents/{cashoutAgentId}/media/presign | Presign agent media | API key |
| GET | /api/connect/commerce/cashout/business/agents/{cashoutAgentId}/sessions?customer_id={customerId} | List agent sessions | API key |
| POST | /api/connect/commerce/cashout/business/sessions/{cashoutSessionId}/authorize | Authorize session | API key |
| POST | /api/connect/commerce/cashout/business/sessions/{cashoutSessionId}/cash-handed | Cash handed | API key |
| POST | /api/connect/commerce/cashout/business/sessions/{cashoutSessionId}/complete | Complete payout retry | API key |
| POST | /api/connect/commerce/cashout/business/sessions/{cashoutSessionId}/fail | Fail session | API key |
checkout / core
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/checkout/core | Create checkout | API key |
| POST | /api/connect/commerce/checkout/core/{session_id}/execute | Execute checkout | API key |
checkout / protocol
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/checkout/protocol/checkout-settings | GET checkout-settings | Sub-Platform key |
| PATCH | /api/connect/commerce/checkout/protocol/checkout-settings | PATCH checkout-settings | Sub-Platform key |
| GET | /api/connect/commerce/checkout/protocol/order-prep-settings | GET order-prep-settings | Sub-Platform key |
| PATCH | /api/connect/commerce/checkout/protocol/order-prep-settings | PATCH order-prep-settings | Sub-Platform key |
collections
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/collections/campaigns | Create campaign | API key |
| GET | /api/connect/commerce/collections/campaigns/{campaignId} | Get campaign | API key |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/close | Close campaign | API key |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/contributions | Contribute | API key |
| GET | /api/connect/commerce/collections/public/campaigns/{campaignCode} | Public campaign | Public |
| GET | /api/connect/commerce/collections/public/campaigns/{campaignCode}/comments | Public comments | Public |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/comments | Create comment | API key |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/comments/{commentId}/like | Like comment | API key |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/comments/{commentId}/hide | Hide comment | API key |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/messages | Owner message | API key |
| GET | /api/connect/commerce/collections/campaigns/{campaignId}/messages?actor_customer_id={customerId} | Owner inbox | API key |
| GET | /api/connect/commerce/collections/campaigns/{campaignId}/messages/mine?actor_customer_id={customerId} | My messages | API key |
| POST | /api/connect/commerce/collections/campaigns/{campaignId}/messages/{messageId}/read | Mark message read | API key |
| POST | /api/connect/commerce/collections/splits | Create split | API key |
| GET | /api/connect/commerce/collections/splits/{splitId} | Get split | API key |
| POST | /api/connect/commerce/collections/splits/{splitId}/members/{memberId}/pay | Pay split member | API key |
| POST | /api/connect/commerce/collections/splits/{splitId}/cancel | Cancel split | API key |
drive
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/drive/client/quote | Quote ride | API key |
| POST | /api/connect/commerce/drive/client/rides | Create ride | API key |
| GET | /api/connect/commerce/drive/client/rides?customer_id={customerId} | List rides | API key |
| GET | /api/connect/commerce/drive/client/rides/{rideId} | Get ride | API key |
| POST | /api/connect/commerce/drive/client/rides/{rideId}/cancel | Cancel ride | API key |
| POST | /api/connect/commerce/drive/client/rides/{rideId}/rate | Rate ride | API key |
| POST | /api/connect/commerce/drive/client/rides/{rideId}/tip | Tip ride | API key |
| POST | /api/connect/commerce/drive/business/profile | Upsert profile | API key |
| POST | /api/connect/commerce/drive/business/availability | Go online | API key |
| GET | /api/connect/commerce/drive/business/profile/earnings?customer_id={customerId} | Profile earnings | API key |
| POST | /api/connect/commerce/drive/business/location | Location snapshot | API key |
| GET | /api/connect/commerce/drive/business/offers?customer_id={customerId} | Incoming offers | API key |
| POST | /api/connect/commerce/drive/business/offers/{offerId}/decide | Decide offer | API key |
| GET | /api/connect/commerce/drive/business/missions?customer_id={customerId} | Missions | API key |
| POST | /api/connect/commerce/drive/business/rides/{rideId}/advance | Advance taxi ride | API key |
| POST | /api/connect/commerce/drive/business/intents/{intentId}/trigger | Intent trigger | API key |
eat
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/eat/business/types | List types | API key |
| POST | /api/connect/commerce/eat/business/merchants | Create merchant | API key |
| GET | /api/connect/commerce/eat/business/merchants?customer_id={customerId} | List merchants | API key |
| GET | /api/connect/commerce/eat/business/merchants/{merchantId} | Get merchant | API key |
| PATCH | /api/connect/commerce/eat/business/merchants/{merchantId} | Patch merchant live | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/media/presign | Presign media | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/categories | Create category | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/products | Create product | API key |
| GET | /api/connect/commerce/eat/business/merchants/{merchantId}/catalog | Catalog | API key |
| GET | /api/connect/commerce/eat/business/orders?merchant_id={merchantId} | Orders projection | API key |
| GET | /api/connect/commerce/eat/client/merchants?near=14.6937,-17.4441&radius_m=3000 | Feed | API key |
| GET | /api/connect/commerce/eat/client/merchants/{merchantId} | Merchant | API key |
| GET | /api/connect/commerce/eat/client/merchants/{merchantId}/catalog | Catalog | API key |
| GET | /api/connect/commerce/eat/client/products/{productId} | Product | API key |
| GET | /api/connect/commerce/eat/client/cart?customer_id={customerId} | Get cart | API key |
| PUT | /api/connect/commerce/eat/client/cart/lines | Put cart line | API key |
| POST | /api/connect/commerce/eat/client/cart/quote | Quote cart | API key |
| POST | /api/connect/commerce/eat/client/orders | Place order | API key |
escrow
| Method | Path | Operation | Auth |
|---|---|---|---|
| PUT | /api/connect/commerce/escrow/core/config | Upsert config | API key |
| GET | /api/connect/commerce/escrow/core/config | Get config | API key |
| POST | /api/connect/commerce/escrow/orders | Create order | API key |
| GET | /api/connect/commerce/escrow/orders/{orderId} | Get order | API key |
| POST | /api/connect/commerce/escrow/orders/{orderId}/shipment | Ship order | API key |
| POST | /api/connect/commerce/escrow/orders/{orderId}/release | Release order | API key |
| POST | /api/connect/commerce/escrow/orders/{orderId}/refund | Refund order | API key |
| GET | /api/connect/commerce/escrow/settlements | List settlements | API key |
| POST | /api/connect/commerce/escrow/settlements/run | Run settlement | API key |
| GET | /api/connect/commerce/escrow/vendors/{vendorId}/payouts | Vendor payouts | API key |
gift-cards
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/gift-cards/products | List products | API key |
| POST | /api/connect/commerce/gift-cards/products | Create product | API key |
| POST | /api/connect/commerce/gift-cards/purchase | Purchase | API key |
| GET | /api/connect/commerce/gift-cards/cards?owner_customer_id={customerId} | List cards | API key |
| GET | /api/connect/commerce/gift-cards/cards/{giftCardId} | Get card | API key |
| POST | /api/connect/commerce/gift-cards/cards/{giftCardId}/redeem | Redeem | API key |
| POST | /api/connect/commerce/gift-cards/cards/{giftCardId}/transfer | Transfer | API key |
kiosk
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/kiosk/business/types | List types | API key |
| POST | /api/connect/commerce/kiosk/business/merchants | Create merchant | API key |
| GET | /api/connect/commerce/kiosk/business/merchants?customer_id={customerId} | List merchants | API key |
| GET | /api/connect/commerce/kiosk/business/merchants/{merchantId} | Get merchant | API key |
| PATCH | /api/connect/commerce/kiosk/business/merchants/{merchantId} | Patch merchant live | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/media/presign | Presign media | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/categories | Create category | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/products | Create product | API key |
| GET | /api/connect/commerce/kiosk/business/merchants/{merchantId}/catalog | Catalog | API key |
| GET | /api/connect/commerce/kiosk/business/orders?merchant_id={merchantId} | Orders projection | API key |
| GET | /api/connect/commerce/kiosk/client/merchants?near=14.6937,-17.4441&radius_m=3000 | Feed | API key |
| GET | /api/connect/commerce/kiosk/client/merchants/{merchantId} | Merchant | API key |
| GET | /api/connect/commerce/kiosk/client/merchants/{merchantId}/catalog | Catalog | API key |
| GET | /api/connect/commerce/kiosk/client/products/{productId} | Product | API key |
| GET | /api/connect/commerce/kiosk/client/cart?customer_id={customerId} | Get cart | API key |
| PUT | /api/connect/commerce/kiosk/client/cart/lines | Put cart line | API key |
| POST | /api/connect/commerce/kiosk/client/cart/quote | Quote cart | API key |
| POST | /api/connect/commerce/kiosk/client/orders | Place order | API key |
link-in-bio / fintech
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/link-in-bio/fintech/providers | List linkinbio providers | API key |
| PATCH | /api/connect/commerce/link-in-bio/fintech/providers/paylink_cool/settings | Patch provider settings | API key |
| GET | /api/connect/commerce/link-in-bio/fintech/providers/paylink_cool/usernames/availability?username=demo_user | Username availability | API key |
| POST | /api/connect/commerce/link-in-bio/fintech/customers/{customerId}/usernames | Assign scoped username | API key |
| POST | /api/connect/commerce/link-in-bio/fintech/customers/{customerId}/universal-usernames | Create universal username | API key |
link-in-bio / public
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/link-in-bio/public/providers | List public providers | Public |
| GET | /api/connect/commerce/link-in-bio/public/resolve?provider=world_openid&username=demo_user | Resolve universal username | Public |
marketplace
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/marketplace/business/vendors | Upsert vendor | API key |
| GET | /api/connect/commerce/marketplace/business/vendors | List vendors | API key |
| GET | /api/connect/commerce/marketplace/business/vendors/{vendorId} | Get vendor | API key |
| POST | /api/connect/commerce/marketplace/business/listings | Create listing | API key |
| GET | /api/connect/commerce/marketplace/business/listings | List listings | API key |
| GET | /api/connect/commerce/marketplace/business/listings/{listingId} | Get listing | API key |
| PATCH | /api/connect/commerce/marketplace/business/listings/{listingId} | Patch listing | API key |
| POST | /api/connect/commerce/marketplace/business/listings/{listingId}/media/presign | Presign media | API key |
| GET | /api/connect/commerce/marketplace/business/listings/{listingId}/media | List media | API key |
| GET | /api/connect/commerce/marketplace/client/listings | List published listings | API key |
| GET | /api/connect/commerce/marketplace/client/listings/{listingId} | Get published listing | API key |
| GET | /api/connect/commerce/marketplace/client/listings/{listingId}/media/{mediaId}/url?customer_id={customerId} | Signed media URL | API key |
| GET | /api/connect/commerce/marketplace/client/entitlements?customer_id={customerId} | List entitlements | API key |
| POST | /api/connect/commerce/marketplace/client/checkout-intent | Checkout intent | API key |
orders
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/orders/transitions | Get transitions | API key |
| PUT | /api/connect/commerce/orders/transitions | Put transitions | API key |
| POST | /api/connect/commerce/orders/shadow | Shadow replay | API key |
| GET | /api/connect/commerce/orders/cod/coverage | Get coverage | API key |
| GET | /api/connect/commerce/orders/cod/positions/{presenceEntityId} | Get courier position | API key |
| POST | /api/connect/commerce/orders/cod/positions/{presenceEntityId}/regularize | Regularize | API key |
| POST | /api/connect/commerce/orders/intents/{fulfillmentIntentId}/cod/otp | Issue dropoff OTP | API key |
| POST | /api/connect/commerce/orders/intents/{fulfillmentIntentId}/cod/collect | Collect + complete | API key |
orders / intents
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/orders/intents/{fulfillmentIntentId} | Get intent | API key |
| POST | /api/connect/commerce/orders/intents/{fulfillmentIntentId}/assign | Assign courier | API key |
| POST | /api/connect/commerce/orders/intents/{fulfillmentIntentId}/events | Post event | API key |
| POST | /api/connect/commerce/orders/intents/{fulfillmentIntentId}/compensate | Compensate | API key |
orders / orders
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/orders/orders | Create order | API key |
| GET | /api/connect/commerce/orders/orders?limit=50 | List orders | API key |
| GET | /api/connect/commerce/orders/orders/{fulfillmentOrderId} | Get order | API key |
| POST | /api/connect/commerce/orders/orders/{fulfillmentOrderId}/intents | Create intent | API key |
| GET | /api/connect/commerce/orders/orders/{fulfillmentOrderId}/settlement | List settlement | API key |
orders / settings
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/orders/settings | Get settings | API key |
| PATCH | /api/connect/commerce/orders/settings | Patch settings | API key |
payment-methods
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/payment-methods | Get portal payment methods | Sub-Platform key |
| PATCH | /api/connect/commerce/payment-methods | Update portal payment methods | Sub-Platform key |
pos
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/pos/sessions | Open room | API key |
| POST | /api/connect/commerce/pos/pairing | Claim pairing (public) | Public |
| POST | /api/connect/commerce/pos/sessions/{pos_session_id}/push-payment | Push payment | POS device token |
| POST | /api/connect/commerce/pos/sessions/{pos_session_id}/push-tip | Push tip | POS device token |
| GET | /api/connect/commerce/pos/settings | Get settings | API key |
| PUT | /api/connect/commerce/pos/settings | Put settings | API key |
| GET | /api/connect/commerce/pos/catalog | Catalog list | API key |
| GET | /api/connect/commerce/pos/catalog/lookup?barcode={pos_barcode} | Catalog lookup | API key |
| POST | /api/connect/commerce/pos/catalog/image-search | Catalog image-search | API key |
| POST | /api/connect/commerce/pos/catalog/images/{pos_image_id}/used | Mark image used | API key |
| GET | /api/connect/commerce/pos/pool/lookup?barcode={pos_barcode} | Pool lookup | API key |
| POST | /api/connect/commerce/pos/catalog | Catalog create | API key |
| PATCH | /api/connect/commerce/pos/catalog/{pos_catalog_item_id} | Catalog patch | API key |
| POST | /api/connect/commerce/pos/sessions/{pos_session_id}/lines | Add sale line | API key |
| DELETE | /api/connect/commerce/pos/sessions/{pos_session_id}/lines/{pos_line_id} | Delete sale line | API key |
| GET | /api/connect/commerce/pos/sessions/{pos_session_id}/receipt | Receipt | API key |
| GET | /api/connect/commerce/pos/sales | List sales | API key |
public / embed
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/public/embed/sessions | Create embed session | Publishable key |
| POST | /api/connect/commerce/public/embed/sessions/{session_id}/stripe-express | Stripe Express | Publishable key |
public / hosting
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/public/hosting/resolve?host=checkout.example.com | Resolve custom host (public) | Public |
| GET | /api/connect/commerce/public/hosting/smart-banner?slug=burok&surface=paylink | Smart App Banner (public) | Public |
qr
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/qr/options | Options | API key |
| GET | /api/connect/commerce/qr?data=Bonjour&format=png&size=512&dotsType=rounded&dotsColor=%23143d66 | Render simple | API key |
| POST | /api/connect/commerce/qr | Render | API key |
shop
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/shop/business/types | List types | API key |
| POST | /api/connect/commerce/shop/business/merchants | Create merchant | API key |
| GET | /api/connect/commerce/shop/business/merchants?customer_id={customerId} | List merchants | API key |
| GET | /api/connect/commerce/shop/business/merchants/{merchantId} | Get merchant | API key |
| PATCH | /api/connect/commerce/shop/business/merchants/{merchantId} | Patch merchant live | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/media/presign | Presign media | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/categories | Create category | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/products | Create product | API key |
| GET | /api/connect/commerce/shop/business/merchants/{merchantId}/catalog | Catalog | API key |
| GET | /api/connect/commerce/shop/business/orders?merchant_id={merchantId} | Orders projection | API key |
| GET | /api/connect/commerce/shop/client/merchants?near=14.6937,-17.4441&radius_m=3000 | Feed | API key |
| GET | /api/connect/commerce/shop/client/merchants/{merchantId} | Merchant | API key |
| GET | /api/connect/commerce/shop/client/merchants/{merchantId}/catalog | Catalog | API key |
| GET | /api/connect/commerce/shop/client/products/{productId} | Product | API key |
| GET | /api/connect/commerce/shop/client/cart?customer_id={customerId} | Get cart | API key |
| PUT | /api/connect/commerce/shop/client/cart/lines | Put cart line | API key |
| POST | /api/connect/commerce/shop/client/cart/quote | Quote cart | API key |
| POST | /api/connect/commerce/shop/client/orders | Place order | API key |
More endpoints (from code) / checkout
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/checkout/core | GET /api/connect/commerce/checkout/core | API key |
| GET | /api/connect/commerce/checkout/core/{id} | GET /api/connect/commerce/checkout/core/:id | API key |
| POST | /api/connect/commerce/checkout/core/{id}/cancel | POST /api/connect/commerce/checkout/core/:id/cancel | API key |
| GET | /api/connect/commerce/checkout/core/payment-links | GET /api/connect/commerce/checkout/core/payment-links | API key |
| POST | /api/connect/commerce/checkout/core/payment-links | POST /api/connect/commerce/checkout/core/payment-links | API key |
| GET | /api/connect/commerce/checkout/core/payment-links/{code} | GET /api/connect/commerce/checkout/core/payment-links/:code | API key |
| PATCH | /api/connect/commerce/checkout/core/payment-links/{code}/revoke | PATCH /api/connect/commerce/checkout/core/payment-links/:code/revoke | API key |
| POST | /api/connect/commerce/checkout/core/payment-qr-codes | POST /api/connect/commerce/checkout/core/payment-qr-codes | API key |
| GET | /api/connect/commerce/checkout/core/payment-qr-codes/{id} | GET /api/connect/commerce/checkout/core/payment-qr-codes/:id | API key |
| POST | /api/connect/commerce/checkout/core/promo-codes/consume | POST /api/connect/commerce/checkout/core/promo-codes/consume | API key |
| POST | /api/connect/commerce/checkout/core/promo-codes/validate | POST /api/connect/commerce/checkout/core/promo-codes/validate | API key |
| POST | /api/connect/commerce/checkout/core/sessions | POST /api/connect/commerce/checkout/core/sessions | API key |
| GET | /api/connect/commerce/checkout/core/sessions/{id} | GET /api/connect/commerce/checkout/core/sessions/:id | API key |
| GET | /api/connect/commerce/checkout/protocol/promo-codes | GET /api/connect/commerce/checkout/protocol/promo-codes | Sub-Platform key |
| POST | /api/connect/commerce/checkout/protocol/promo-codes | POST /api/connect/commerce/checkout/protocol/promo-codes | Sub-Platform key |
| DELETE | /api/connect/commerce/checkout/protocol/promo-codes/{id} | DELETE /api/connect/commerce/checkout/protocol/promo-codes/:id | Sub-Platform key |
| GET | /api/connect/commerce/checkout/protocol/promo-codes/{id} | GET /api/connect/commerce/checkout/protocol/promo-codes/:id | Sub-Platform key |
| PATCH | /api/connect/commerce/checkout/protocol/promo-codes/{id} | PATCH /api/connect/commerce/checkout/protocol/promo-codes/:id | Sub-Platform key |
| POST | /api/connect/commerce/checkout/protocol/promo-codes/consume | POST /api/connect/commerce/checkout/protocol/promo-codes/consume | Sub-Platform key |
| POST | /api/connect/commerce/checkout/protocol/promo-codes/validate | POST /api/connect/commerce/checkout/protocol/promo-codes/validate | Sub-Platform key |
| GET | /api/connect/commerce/checkout/protocol/qr/dynamic | GET /api/connect/commerce/checkout/protocol/qr/dynamic | Sub-Platform key |
| POST | /api/connect/commerce/checkout/protocol/qr/dynamic/rotate | POST /api/connect/commerce/checkout/protocol/qr/dynamic/rotate | Sub-Platform key |
| GET | /api/connect/commerce/checkout/protocol/qr/static | GET /api/connect/commerce/checkout/protocol/qr/static | Sub-Platform key |
| GET | /api/connect/commerce/checkout/public/{code} | GET /api/connect/commerce/checkout/public/:code | Public |
| POST | /api/connect/commerce/checkout/public/promo-codes/consume | POST /api/connect/commerce/checkout/public/promo-codes/consume | Public |
| POST | /api/connect/commerce/checkout/public/promo-codes/validate | POST /api/connect/commerce/checkout/public/promo-codes/validate | Public |
More endpoints (from code) / drive
| Method | Path | Operation | Auth |
|---|---|---|---|
| PATCH | /api/connect/commerce/drive/business/profile | PATCH /api/connect/commerce/drive/business/profile | API key |
| POST | /api/connect/commerce/drive/business/rides/{rideId}/cancel | POST /api/connect/commerce/drive/business/rides/:rideId/cancel | API key |
More endpoints (from code) / eat
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/eat/business/merchants/{merchantId}/categories | GET /api/connect/commerce/eat/business/merchants/:merchantId/categories | API key |
| DELETE | /api/connect/commerce/eat/business/merchants/{merchantId}/categories/{categoryId} | DELETE /api/connect/commerce/eat/business/merchants/:merchantId/categories/:categoryId | API key |
| PATCH | /api/connect/commerce/eat/business/merchants/{merchantId}/categories/{categoryId} | PATCH /api/connect/commerce/eat/business/merchants/:merchantId/categories/:categoryId | API key |
| GET | /api/connect/commerce/eat/business/merchants/{merchantId}/products/{productId} | GET /api/connect/commerce/eat/business/merchants/:merchantId/products/:productId | API key |
| PATCH | /api/connect/commerce/eat/business/merchants/{merchantId}/products/{productId} | PATCH /api/connect/commerce/eat/business/merchants/:merchantId/products/:productId | API key |
| PUT | /api/connect/commerce/eat/business/merchants/{merchantId}/products/{productId}/skus | PUT /api/connect/commerce/eat/business/merchants/:merchantId/products/:productId/skus | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/products/{productId}/variant-groups | POST /api/connect/commerce/eat/business/merchants/:merchantId/products/:productId/variant-groups | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/products/{productId}/variant-groups/{groupId}/values | POST /api/connect/commerce/eat/business/merchants/:merchantId/products/:productId/variant-groups/:groupId/values | API key |
| GET | /api/connect/commerce/eat/business/merchants/{merchantId}/promotions | GET /api/connect/commerce/eat/business/merchants/:merchantId/promotions | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/promotions | POST /api/connect/commerce/eat/business/merchants/:merchantId/promotions | API key |
| PATCH | /api/connect/commerce/eat/business/merchants/{merchantId}/promotions/{promoId} | PATCH /api/connect/commerce/eat/business/merchants/:merchantId/promotions/:promoId | API key |
| POST | /api/connect/commerce/eat/business/merchants/{merchantId}/reviews/{reviewId}/reply | POST /api/connect/commerce/eat/business/merchants/:merchantId/reviews/:reviewId/reply | API key |
| POST | /api/connect/commerce/eat/client/cart/checkout | POST /api/connect/commerce/eat/client/cart/checkout | API key |
| DELETE | /api/connect/commerce/eat/client/cart/lines/{lineId} | DELETE /api/connect/commerce/eat/client/cart/lines/:lineId | API key |
| GET | /api/connect/commerce/eat/client/merchants/{id}/reviews | GET /api/connect/commerce/eat/client/merchants/:id/reviews | API key |
| POST | /api/connect/commerce/eat/client/merchants/{id}/reviews | POST /api/connect/commerce/eat/client/merchants/:id/reviews | API key |
| GET | /api/connect/commerce/eat/client/orders/{id} | GET /api/connect/commerce/eat/client/orders/:id | API key |
| GET | /api/connect/commerce/eat/client/types | GET /api/connect/commerce/eat/client/types | API key |
More endpoints (from code) / kiosk
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/kiosk/business/merchants/{merchantId}/categories | GET /api/connect/commerce/kiosk/business/merchants/:merchantId/categories | API key |
| DELETE | /api/connect/commerce/kiosk/business/merchants/{merchantId}/categories/{categoryId} | DELETE /api/connect/commerce/kiosk/business/merchants/:merchantId/categories/:categoryId | API key |
| PATCH | /api/connect/commerce/kiosk/business/merchants/{merchantId}/categories/{categoryId} | PATCH /api/connect/commerce/kiosk/business/merchants/:merchantId/categories/:categoryId | API key |
| GET | /api/connect/commerce/kiosk/business/merchants/{merchantId}/products/{productId} | GET /api/connect/commerce/kiosk/business/merchants/:merchantId/products/:productId | API key |
| PATCH | /api/connect/commerce/kiosk/business/merchants/{merchantId}/products/{productId} | PATCH /api/connect/commerce/kiosk/business/merchants/:merchantId/products/:productId | API key |
| PUT | /api/connect/commerce/kiosk/business/merchants/{merchantId}/products/{productId}/skus | PUT /api/connect/commerce/kiosk/business/merchants/:merchantId/products/:productId/skus | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/products/{productId}/variant-groups | POST /api/connect/commerce/kiosk/business/merchants/:merchantId/products/:productId/variant-groups | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/products/{productId}/variant-groups/{groupId}/values | POST /api/connect/commerce/kiosk/business/merchants/:merchantId/products/:productId/variant-groups/:groupId/values | API key |
| GET | /api/connect/commerce/kiosk/business/merchants/{merchantId}/promotions | GET /api/connect/commerce/kiosk/business/merchants/:merchantId/promotions | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/promotions | POST /api/connect/commerce/kiosk/business/merchants/:merchantId/promotions | API key |
| PATCH | /api/connect/commerce/kiosk/business/merchants/{merchantId}/promotions/{promoId} | PATCH /api/connect/commerce/kiosk/business/merchants/:merchantId/promotions/:promoId | API key |
| POST | /api/connect/commerce/kiosk/business/merchants/{merchantId}/reviews/{reviewId}/reply | POST /api/connect/commerce/kiosk/business/merchants/:merchantId/reviews/:reviewId/reply | API key |
| POST | /api/connect/commerce/kiosk/client/cart/checkout | POST /api/connect/commerce/kiosk/client/cart/checkout | API key |
| DELETE | /api/connect/commerce/kiosk/client/cart/lines/{lineId} | DELETE /api/connect/commerce/kiosk/client/cart/lines/:lineId | API key |
| GET | /api/connect/commerce/kiosk/client/merchants/{id}/reviews | GET /api/connect/commerce/kiosk/client/merchants/:id/reviews | API key |
| POST | /api/connect/commerce/kiosk/client/merchants/{id}/reviews | POST /api/connect/commerce/kiosk/client/merchants/:id/reviews | API key |
| GET | /api/connect/commerce/kiosk/client/orders/{id} | GET /api/connect/commerce/kiosk/client/orders/:id | API key |
| GET | /api/connect/commerce/kiosk/client/types | GET /api/connect/commerce/kiosk/client/types | API key |
More endpoints (from code) / link-in-bio
| Method | Path | Operation | Auth |
|---|---|---|---|
| PATCH | /api/connect/commerce/link-in-bio/fintech/providers/{slug}/settings | PATCH /api/connect/commerce/link-in-bio/fintech/providers/:slug/settings | API key |
| GET | /api/connect/commerce/link-in-bio/fintech/providers/{slug}/usernames/availability | GET /api/connect/commerce/link-in-bio/fintech/providers/:slug/usernames/availability | API key |
More endpoints (from code) / pos
| Method | Path | Operation | Auth |
|---|---|---|---|
| DELETE | /api/connect/commerce/pos/catalog/{id} | DELETE /api/connect/commerce/pos/catalog/:id | API key |
| GET | /api/connect/commerce/pos/sessions/{id}/lines | GET /api/connect/commerce/pos/sessions/:id/lines | API key |
| POST | /api/connect/commerce/pos/sessions/{id}/pairing | POST /api/connect/commerce/pos/sessions/:id/pairing | API key |
| POST | /api/connect/commerce/pos/sessions/{id}/push-cart | POST /api/connect/commerce/pos/sessions/:id/push-cart | POS device token |
| POST | /api/connect/commerce/pos/sessions/{id}/push-refund | POST /api/connect/commerce/pos/sessions/:id/push-refund | POS device token |
| GET | /api/connect/commerce/pos/sessions/{id}/sync | GET /api/connect/commerce/pos/sessions/:id/sync | POS device token |
| POST | /api/connect/commerce/pos/sessions/{id}/sync | POST /api/connect/commerce/pos/sessions/:id/sync | POS device token |
More endpoints (from code) / qr-pay
| Method | Path | Operation | Auth |
|---|---|---|---|
| POST | /api/connect/commerce/qr-pay/core/create | POST /api/connect/commerce/qr-pay/core/create | API key |
| POST | /api/connect/commerce/qr-pay/core/parse | POST /api/connect/commerce/qr-pay/core/parse | Public |
| POST | /api/connect/commerce/qr-pay/core/pay | POST /api/connect/commerce/qr-pay/core/pay | API key |
| POST | /api/connect/commerce/qr-pay/core/resolve | POST /api/connect/commerce/qr-pay/core/resolve | API key |
| POST | /api/connect/commerce/qr-pay/public/parse | POST /api/connect/commerce/qr-pay/public/parse | Public |
| POST | /api/connect/commerce/qr-pay/public/resolve | POST /api/connect/commerce/qr-pay/public/resolve | Public |
More endpoints (from code) / shop
| Method | Path | Operation | Auth |
|---|---|---|---|
| GET | /api/connect/commerce/shop/business/merchants/{merchantId}/categories | GET /api/connect/commerce/shop/business/merchants/:merchantId/categories | API key |
| DELETE | /api/connect/commerce/shop/business/merchants/{merchantId}/categories/{categoryId} | DELETE /api/connect/commerce/shop/business/merchants/:merchantId/categories/:categoryId | API key |
| PATCH | /api/connect/commerce/shop/business/merchants/{merchantId}/categories/{categoryId} | PATCH /api/connect/commerce/shop/business/merchants/:merchantId/categories/:categoryId | API key |
| GET | /api/connect/commerce/shop/business/merchants/{merchantId}/products/{productId} | GET /api/connect/commerce/shop/business/merchants/:merchantId/products/:productId | API key |
| PATCH | /api/connect/commerce/shop/business/merchants/{merchantId}/products/{productId} | PATCH /api/connect/commerce/shop/business/merchants/:merchantId/products/:productId | API key |
| PUT | /api/connect/commerce/shop/business/merchants/{merchantId}/products/{productId}/skus | PUT /api/connect/commerce/shop/business/merchants/:merchantId/products/:productId/skus | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/products/{productId}/variant-groups | POST /api/connect/commerce/shop/business/merchants/:merchantId/products/:productId/variant-groups | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/products/{productId}/variant-groups/{groupId}/values | POST /api/connect/commerce/shop/business/merchants/:merchantId/products/:productId/variant-groups/:groupId/values | API key |
| GET | /api/connect/commerce/shop/business/merchants/{merchantId}/promotions | GET /api/connect/commerce/shop/business/merchants/:merchantId/promotions | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/promotions | POST /api/connect/commerce/shop/business/merchants/:merchantId/promotions | API key |
| PATCH | /api/connect/commerce/shop/business/merchants/{merchantId}/promotions/{promoId} | PATCH /api/connect/commerce/shop/business/merchants/:merchantId/promotions/:promoId | API key |
| POST | /api/connect/commerce/shop/business/merchants/{merchantId}/reviews/{reviewId}/reply | POST /api/connect/commerce/shop/business/merchants/:merchantId/reviews/:reviewId/reply | API key |
| POST | /api/connect/commerce/shop/client/cart/checkout | POST /api/connect/commerce/shop/client/cart/checkout | API key |
| DELETE | /api/connect/commerce/shop/client/cart/lines/{lineId} | DELETE /api/connect/commerce/shop/client/cart/lines/:lineId | API key |
| GET | /api/connect/commerce/shop/client/merchants/{id}/reviews | GET /api/connect/commerce/shop/client/merchants/:id/reviews | API key |
| POST | /api/connect/commerce/shop/client/merchants/{id}/reviews | POST /api/connect/commerce/shop/client/merchants/:id/reviews | API key |
| GET | /api/connect/commerce/shop/client/orders/{id} | GET /api/connect/commerce/shop/client/orders/:id | API key |
| GET | /api/connect/commerce/shop/client/types | GET /api/connect/commerce/shop/client/types | API key |