Operations

Total operations: 174

Analytics

• track-analytics-event - POST /analytics/track - Track event

Auth

• add-profile-image - POST /auth/user/{id}/profile-image - Add profile image
• change-password - POST /auth/change-password - Change password
• check-verification-status - POST /auth/verified-email-phone - Check email/phone verification status
• create-notification-preferences - POST /auth/user/{id}/notification-preferences - Create user notification preferences
• deactivate-user - PUT /auth/user/{id}/deactivate - Deactivate account
• forgot-password - POST /auth/forgot-password - Forgot password
• generate-otp - POST /auth/generate-otp - Generate OTP
• get-anonymous-token - POST /auth/anonymous - Anonymous user
• get-notification-preferences - GET /auth/user/{id}/notification-preferences - Retrieve user notification preferences
• get-profile-image - GET /auth/user/{id}/profile-image - Retrieve a profile image
• get-user-detail - GET /auth/user/{id} - Retrieve a user
• login-with-email - POST /auth/login/email - Login with email
• login-with-password - POST /auth/login/password - Login with password
• login-with-phone - POST /auth/login/phone - Login with phone
• login-with-whatsapp - POST /auth/login/whatsapp - Login with whatsapp
• logout - POST /auth/logout - Logout user
• refresh-token - POST /auth/refresh-token - Refresh access token
• register-with-email - POST /auth/register/email - Register with email
• register-with-password - POST /auth/register/password - Register with password
• register-with-phone - POST /auth/register/phone - Register with phone
• register-with-whatsapp - POST /auth/register/whatsapp - Register with whatsapp
• remove-profile-image - DELETE /auth/user/{id}/profile-image - Delete profile image
• reset-password - POST /auth/reset-password - Reset password
• update-notification-preferences - PUT /auth/user/{id}/notification-preferences - Update user notification preferences
• update-profile-image - PUT /auth/user/{id}/profile-image - Update profile image
• update-user - PUT /auth/user/{id} - Update a user
• verify-otp - POST /auth/verify-otp - Verify OTP

Campaigns

• subscribe-newsletter - POST /campaigns/newsletter-subscribe - Subscribe to newsletter

Carts

• add-to-wishlist - POST /wishlist/{user_id} - Add product to wishlist
• apply-coupon - POST /carts/{id}/coupon - Apply coupon
• create-cart - POST /carts - Create cart
• create-cart-address - POST /carts/{id}/address - Update cart address
• delete-cart - DELETE /carts/{id} - Delete cart
• delete-from-wishlist - DELETE /wishlist/{user_id} - Delete product from wishlist
• delete-user-cart - DELETE /carts/users/{user_id} - Delete cart using user id
• evaluate-coupons - GET /carts/{id}/evaluate-coupons - Evaluate coupons
• evaluate-promotions - GET /carts/{id}/evaluate-promotions - Evaluate promotions
• get-cart - GET /carts/{id} - Retrieve cart detail
• get-user-cart - GET /carts/users/{user_id} - Retrieve cart using user id
• get-wishlist - GET /wishlist/{user_id} - Retrieve wishlist
• list-coupons - GET /carts/available-coupons - Retrieve all coupons
• list-promotions - GET /carts/available-promotions - Retrieve all promotions
• redeem-credit-balance - POST /carts/{id}/credit-balance - Use credit balance
• redeem-loyalty-points - POST /carts/{id}/loyalty-points - Redeem loyalty points
• remove-coupon - DELETE /carts/{id}/coupon - Remove coupon
• remove-credit-balance - DELETE /carts/{id}/credit-balance - Remove credit balance
• remove-loyalty-points - DELETE /carts/{id}/loyalty-points - Remove loyalty points
• update-cart - POST /carts/{id}/items - Add/delete cart item
• update-fulfillment-preference - POST /carts/{id}/fulfillment-preference - Update fulfillment preference

Catalog

• create-product-review - POST /catalog/products/{product_id}/reviews - Create product review
• get-product-detail - GET /catalog/products/{product_id_or_slug} - Retrieve a product detail
• get-variant-detail - GET /catalog/products/{product_id}/variants/{variant_id} - Retrieve variant detail
• list-categories - GET /catalog/categories - List all categories
• list-crosssell-products - GET /catalog/products/cross-sell - Retrieve cross-sell products
• list-product-reviews - GET /catalog/products/{product_id}/reviews - List all product reviews
• list-product-variants - GET /catalog/products/{product_id}/variants - Retrieve product variants
• list-products - GET /catalog/products - List all products
• list-similar-products - GET /catalog/products/similar - Retrieve similar products
• list-skus - GET /catalog/skus - List all SKUs
• list-upsell-products - GET /catalog/products/up-sell - Retrieve up-sell products
• search-products - POST /catalog/products/search - Search products

Common

• list-countries - GET /common/countries - Retrieve all countries
• list-country-pincodes - GET /common/countries/{country_iso_code}/pincodes - Retrieve pincodes
• list-country-states - GET /common/countries/{country_iso_code}/states - Retrieve country wise states

Customers

• create-address - POST /customers/{user_id}/addresses - Create address
• create-customer - POST /customers - Create customer
• delete-address - DELETE /customers/{user_id}/addresses/{address_id} - Remove particular address
• get-address-detail - GET /customers/{user_id}/addresses/{address_id} - Retrieve particular address
• get-customer-detail - GET /customers/{id} - Retrieve customer detail
• get-loyalty-details - GET /customers/{user_id}/loyalty - Retrieve loyalty details
• list-addresses - GET /customers/{user_id}/addresses - Retrieve all addresses
• list-loyalty-activities - GET /customers/{user_id}/loyalty-points-activity - List all loyalty points activity
• list-saved-payment-methods - GET /customers/{customer_id}/payment-methods - List all saved payment methods
• list-user-reviews - GET /customers/{user_id}/reviews - Retrieve all reviews
• update-address-detail - PUT /customers/{user_id}/addresses/{address_id} - Update particular address
• update-customer - PUT /customers/{id} - Update customer detail

Juspay

• create-juspay-customer - POST /payments/juspay/customers - Create customer in juspay
• create-juspay-order - POST /payments/juspay/create-order - Create order in juspay
• get-juspay-customer - GET /payments/juspay/customers/{user_id} - Retrieve customer from juspay

Kyc

• create-document - POST /customers/{id}/documents - Create document
• delete-document - DELETE /customers/{id}/documents/{document_id} - Delete document
• get-document - GET /customers/{id}/documents/{document_id} - Retrieve document detail
• list-documents - GET /customers/{id}/documents - List all documents
• list-kyc-document - GET /store/kyc-document - List all kyc documents
• update-document - PUT /customers/{id}/documents/{document_id} - Update document detail
• verify-document - POST /customers/{id}/documents/verify - Verify document

Orders

• cancel-order - POST /orders/{order_number}/cancel - Cancel order
• create-order - POST /orders - Create order
• create-order-return - POST /orders/{order_number}/return - Create order return
• get-order-detail - GET /orders/{order_number} - Retrieve order detail
• get-order-return-detail - GET /orders/{order_number}/return/{return_id} - Retrieve order return detail
• get-payment-status - GET /orders/{order_number}/payment-status - Retrieve payment status
• list-order-payments - GET /orders/{order_number}/payments - Retrieve order payments
• list-order-refunds - GET /orders/{order_number}/refunds - Retrieve order refunds
• list-order-shipments - GET /orders/{order_number}/shipments - Retrieve order shipments
• list-orders - GET /orders - Retrieve all orders
• list-returns - GET /orders/returns - Retrieve all order returns
• retry-order-payment - POST /orders/{order_number}/retry-payment - Retry payment

Pos

• claim-pos-device - POST /pos/devices/{id}/claim - Claim device
• create-pos-order - POST /pos/orders - Create order
• get-pos-fulfillment-options - POST /pos/fulfillment-options - Retrieve fulfillment options
• get-pos-user - GET /pos/users/{id} - Get POS User
• list-pos-devices - GET /pos/devices - List all available devices
• list-pos-locations - GET /pos/locations - List all locations
• login-pos-device-with-email - POST /pos/auth/login/email - Login with email
• login-pos-device-with-phone - POST /pos/auth/login/phone - Login with phone
• login-pos-device-with-whatsapp - POST /pos/auth/login/whatsapp - Login with whatsapp
• logout-from-pos-device - POST /pos/auth/logout - Logout
• pair-pos-device - POST /pos/auth/pair-device - Pair POS device
• pos-apply-coupon - POST /pos/carts/{id}/coupon - Apply coupon
• pos-create-cart - POST /pos/carts - Create cart
• pos-create-cart-address - POST /pos/carts/{id}/address - Update cart address
• pos-delete-cart - DELETE /pos/carts/{id} - Delete cart
• pos-evaluate-coupons - GET /pos/carts/{id}/evaluate-coupons - Evaluate coupons
• pos-evaluate-promotions - GET /pos/carts/{id}/evaluate-promotions - Evaluate promotions
• pos-get-cart - GET /pos/carts/{id} - Retrieve cart detail
• pos-get-payment-status - GET /pos/orders/{order_number}/payment-status - Retrieve payment status
• pos-get-product-detail - GET /pos/catalog/products/{product_id_or_slug} - Retrieve a product detail
• pos-get-user-cart - GET /pos/carts/users/{user_id} - Retrieve cart using user id
• pos-get-variant-detail - GET /pos/catalog/products/{product_id}/variants/{variant_id} - Retrieve variant detail
• pos-list-categories - GET /pos/catalog/categories - List all categories
• pos-list-coupons - GET /pos/carts/available-coupons - Retrieve all coupons
• pos-list-crosssell-products - GET /pos/catalog/products/cross-sell - Retrieve cross-sell products
• pos-list-payment-options - GET /pos/payments/payment-options - List all payment options
• pos-list-product-reviews - GET /pos/catalog/products/{product_id}/reviews - List all product reviews
• pos-list-product-variants - GET /pos/catalog/products/{product_id}/variants - Retrieve product variants
• pos-list-products - GET /pos/catalog/products - List all products
• pos-list-promotions - GET /pos/carts/available-promotions - Retrieve all promotions
• pos-list-similar-products - GET /pos/catalog/products/similar - Retrieve similar products
• pos-list-skus - GET /pos/catalog/skus - List all SKUs
• pos-list-upsell-products - GET /pos/catalog/products/up-sell - Retrieve up-sell products
• pos-redeem-credit-balance - POST /pos/carts/{id}/credit-balance - Use credit balance
• pos-redeem-loyalty-points - POST /pos/carts/{id}/loyalty-points - Redeem loyalty points
• pos-remove-coupon - DELETE /pos/carts/{id}/coupon - Remove coupon
• pos-remove-credit-balance - DELETE /pos/carts/{id}/credit-balance - Remove credit balance
• pos-remove-loyalty-points - DELETE /pos/carts/{id}/loyalty-points - Remove loyalty points
• pos-search-products - POST /pos/catalog/products/search - Search products
• pos-update-cart - POST /pos/carts/{id}/items - Add/delete cart item
• pos-update-fulfillment-preference - POST /pos/carts/{id}/fulfillment-preference - Update fulfillment preference
• refresh-pos-access-token - POST /pos/auth/refresh-token - Refresh POS access token
• unclaim-pos-device - POST /pos/devices/{id}/unclaim - Unclaim device
• update-pos-cart-customer - POST /pos/carts/{id}/update-customer - Update cart customer
• verify-pos-login-otp - POST /pos/auth/verify-otp - Verify OTP

Posadmin

• pos-check-order-inventory - GET /pos/shipping/shipments/{order_number}/check-inventory - Check Inventory
• pos-get-customer-detail - GET /pos/customers/{id} - Retrieve customer detail
• pos-get-order-detail - GET /pos/orders/{order_number} - Retrieve order details
• pos-get-order-invoice - GET /pos/orders/{order_number}/invoice - Retrieve order invoice
• pos-get-order-receipt - GET /pos/orders/{order_number}/receipt - Retrieve order receipt
• pos-get-shipment-detail - GET /pos/shipping/shipments/{reference_number} - Retrieve shipment detail
• pos-get-shipment-invoice - GET /pos/shipping/shipments/{reference_number}/invoice - Retrieve shipment invoice
• pos-list-customers - GET /pos/customers - List all customers
• pos-list-inventory - GET /pos/catalog/inventories - List all inventories
• pos-list-inventory-activity - GET /pos/catalog/inventories/activites - List all inventories activities
• pos-list-inventory-detail - GET /pos/catalog/inventories/detail - Retrieve inventory detail
• pos-list-order-activity - GET /pos/orders/{order_number}/activity - List all order activity
• pos-list-order-shipments - GET /pos/orders/{order_number}/shipments - Retrieve order shipments
• pos-list-orders - GET /pos/orders - List all orders
• pos-list-shipments - GET /pos/shipping/shipments - List all shipments
• pos-refund-shortfall - POST /pos/shipping/shipments/{order_number}/refund-shortfall - Refund shortfall
• pos-update-shipment - PUT /pos/shipping/shipments/{reference_number}/manual-update - Update shipment detail

Payu

• generate-hash - POST /payments/generate-hash - Generate hash

Payments

• add-card - POST /payments/cards - Add card
• list-payment-methods - GET /payments/payment-methods - List all payment methods
• list-payment-options - GET /payments/payment-options - List all payment options
• list-saved-cards - GET /payments/cards - List all saved cards
• verify-vpa - GET /payments/verify-vpa - Verify VPA

Shipping

• check-pincode-serviceability - GET /shipping/serviceability/{pincode} - Check serviceability
• get-fulfillment-options - POST /shipping/fulfillment-options - Retrieve fulfillment options

Store

• get-config - GET /store/config - Retrieve store config

Subscriptions

• create-subscription - POST /subscriptions - Create subscription
• get-subscription - GET /subscriptions/{id} - Retrieve subscription details
• list-subscriptions - GET /subscriptions - List all subscriptions
• update-subscription - PUT /subscriptions/{id} - Update a specific subscription