HTTP reference
Use the SDK for application integration. This read-only reference covers Commerce, Customer Auth, Membership and Events.
Commerce
- POST /api/carts/create — Create a Cart
- POST /api/carts/retrieve — Retrieve a Cart
- POST /api/carts/mine — Retrieve the active customer Cart
- POST /api/carts/merge — Merge a guest Cart into the customer Cart
- POST /api/carts/add-item — Add an item to a Cart
- POST /api/carts/update-item — Update a Cart item
- POST /api/carts/remove-item — Remove a Cart item
- POST /api/carts/clear — Clear a Cart
- POST /api/carts/update-discount-codes — Replace Cart discount codes
- POST /api/carts/update-attributes — Replace Cart attributes
- POST /api/orders/checkout — Create a Checkout
- POST /api/checkouts/detail — Retrieve a Checkout
- POST /api/checkouts/query — Query Checkouts as a server
- POST /api/payment-sessions/create — Create a PaymentSession
- POST /api/payment-sessions/retrieve — Retrieve a PaymentSession
- POST /api/payment-sessions/cancel — Cancel a PaymentSession
- POST /api/payment-sessions/server/retrieve — Retrieve a PaymentSession as a server
- POST /api/payment-sessions/server/cancel — Cancel a PaymentSession as a server
- POST /api/payment-sessions/server/confirm — Confirm a Toss PaymentSession as a server
- POST /api/payment-sessions/server/portone/find — Find local PortOne payment state by canonical identity
- POST /api/payment-sessions/server/portone/reconcile — Reconcile PortOne payment state by canonical identity
- POST /api/orders/custom-payment-sessions — Create a custom-provider PaymentSession as a server
- POST /api/orders/custom-payment-sessions/confirm — Confirm a custom-provider PaymentSession as a server
- POST /api/orders/custom-payment-sessions/retrieve — Retrieve a custom-provider PaymentSession by provider identity
- POST /api/payment-sessions/server/create — Create a PaymentSession
- POST /api/shipping-policies/calculate — calculateShipping
- POST /api/orders/cancel — cancelOrder
- POST /api/orders/resolve-cancel-refund — resolveCancelRefund
- POST /api/fulfillment-orders/prepare-fulfillment-order — prepareFulfillmentOrder
- POST /api/fulfillments/bulk-import — bulkImportFulfillments
- GET /api/products/detail — getProductDetail
- GET /api/products/detail/catalog — getProductDetailCatalog
- GET /api/products/listing-groups — getListingGroups
- GET /api/products/listing-groups/catalog — getListingGroupsCatalog
- GET /api/products/listing-groups/query — getListingGroupsQuery
- POST /api/products/listing-groups/query — queryListingGroups
- GET /api/products/listing-groups/query/catalog — getListingGroupsQueryCatalog
- GET /api/products/stock — getStockSnapshot
- POST /api/products/stock-check — checkStock
- GET /api/products/{id}/graph-revision — getProductGraphRevision
- PATCH /api/products/{id}/variants — patchProductVariants
- POST /api/products/upsert — upsertProduct
- POST /api/orders/create — createLegacyOrder
- POST /api/orders/update — updateLegacyOrder
- POST /api/orders/confirm-payment — confirmLegacyPayment
- GET /api/orders/by-payment — getOrderByPayment
- POST /api/orders/create-fulfillment — createFulfillment
- POST /api/orders/update-fulfillment — updateFulfillment
- POST /api/draft-orders/{id}/calculate — calculateDraftOrder
- POST /api/draft-orders/{id}/complete — completeDraftOrder
- POST /api/draft-orders/{id}/finalize — finalizeDraftOrder
- POST /api/transactions/update — updateLegacyTransaction
- POST /api/returns/create — createReturn
- POST /api/returns/update — updateReturn
- POST /api/returns/return-refund — returnRefund
- POST /api/discounts/validate — validateDiscount
- GET /api/customers/me/orders — List the authenticated customer’s placed Orders
Customer Auth
- POST /api/customers/withdraw — withdrawCustomer
- POST /api/customers/revoke-refresh — revokeCustomerRefresh
- POST /api/customers/register — registerCustomer
- POST /api/customers/login — loginCustomer
- GET /api/customers/me — getCustomerMe
- PATCH /api/customers/me — updateCustomerMe
- POST /api/customers/forgot-password — forgotCustomerPassword
- POST /api/customers/reset-password — resetCustomerPassword
- POST /api/customers/change-password — changeCustomerPassword
- POST /api/customers/refresh — refreshCustomerSession
Membership
- POST /api/memberships/subscribe — subscribeMembership
- POST /api/memberships/subscribe-intent/end — endMembershipSubscribeIntent
- POST /api/memberships/{id}/cancel — cancelMembership
- GET /api/memberships/me — getCustomerMembership
- POST /api/memberships/billing-custody — membershipBillingCustody
- POST /api/memberships/{id}/charge-result — membershipChargeResult
- POST /api/memberships/{id}/refund-result — membershipRefundResult
- POST /api/memberships/{id}/revoke — membershipRevoke
Events
- GET /api/events — List Events
- POST /api/events — Create Events
- GET /api/events/{id} — Get Events by ID
- PATCH /api/events/{id} — Update Events
- DELETE /api/events/{id} — Delete Events
- POST /api/events/{id}/schedule — Replace an event schedule through the protected action
- GET /api/event-occurrences/admission-availability — Read public admission availability for an occurrence
- GET /api/event-occurrences/range — List public event occurrences in a date range
- GET /api/event-registrations/my — List the authenticated customer event registrations
- POST /api/event-registrations/register — Register for an event occurrence
- POST /api/event-registrations/guest/lookup — Look up a guest event registration
- POST /api/event-registrations/guest/cancel — Cancel a guest event registration