API CMS / admin #

Mọi route /api/v1/* cho nhân viên (XforgeClient). Chi tiết field / kiểu: spec api.openapi.json hoặc kiểu trong api.ts.

auth #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/auth/api-keys`	List the caller's API keys	`listMyApiKeys`
`POST`	`/api/v1/auth/api-keys`	Create an API key	`createMyApiKey`	`core.api_keys`
`PATCH`	`/api/v1/auth/api-keys/{id}`	Change one of the caller's API keys	`updateMyApiKey`	`core.api_keys`
`DELETE`	`/api/v1/auth/api-keys/{id}`	Revoke one of the caller's API keys	`revokeMyApiKey`
`GET`	`/api/v1/auth/configs`	Public settings	`getPublicConfigs`
`POST`	`/api/v1/auth/email/confirm`	Confirm an email address with a verification token	`confirmEmail`
`POST`	`/api/v1/auth/email/verify`	Send a verification link to the caller's email	`requestEmailVerification`
`POST`	`/api/v1/auth/login`	Log in with login + password	`login`
`POST`	`/api/v1/auth/logout`	Log out	`logout`
`GET`	`/api/v1/auth/me`	Get the current user	`getMe`
`GET`	`/api/v1/auth/mfa`	Get the caller's MFA status	`getMfaStatus`
`POST`	`/api/v1/auth/mfa/recovery-codes`	Regenerate MFA recovery codes	`regenerateRecoveryCodes`
`DELETE`	`/api/v1/auth/mfa/sms`	Remove the backup phone number	`disableMfaSms`
`POST`	`/api/v1/auth/mfa/sms/confirm`	Confirm the backup phone number with the texted code	`confirmMfaSms`
`POST`	`/api/v1/auth/mfa/sms/send`	Text a sign-in code to the backup phone number	`sendMfaSmsCode`
`POST`	`/api/v1/auth/mfa/sms/setup`	Add a backup phone number for sign-in codes	`setupMfaSms`
`POST`	`/api/v1/auth/mfa/step-up/options`	Start a passkey step-up	`getStepUpPasskeyOptions`
`DELETE`	`/api/v1/auth/mfa/totp`	Disable TOTP	`disableTotp`
`POST`	`/api/v1/auth/mfa/totp/confirm`	Confirm TOTP enrollment	`confirmTotp`
`POST`	`/api/v1/auth/mfa/totp/setup`	Start TOTP enrollment	`setupTotp`
`POST`	`/api/v1/auth/mfa/verify`	Complete an MFA login	`verifyMfa`
`GET`	`/api/v1/auth/passkeys`	List the caller's passkeys	`listPasskeys`
`DELETE`	`/api/v1/auth/passkeys/{id}`	Delete a passkey	`deletePasskey`
`POST`	`/api/v1/auth/passkeys/login/options`	Start a passkey login	`getPasskeyLoginOptions`
`POST`	`/api/v1/auth/passkeys/login/verify`	Complete a passkey login	`verifyPasskeyLogin`
`POST`	`/api/v1/auth/passkeys/register/options`	Start passkey registration	`getPasskeyRegisterOptions`
`POST`	`/api/v1/auth/passkeys/register/verify`	Register a passkey	`registerPasskey`
`POST`	`/api/v1/auth/password`	Change the caller's password	`changePassword`
`POST`	`/api/v1/auth/password/forgot`	Request a password reset email	`forgotPassword`
`POST`	`/api/v1/auth/password/reset`	Set a new password with a reset token	`resetPassword`
`POST`	`/api/v1/auth/refresh`	Rotate a refresh token	`refreshToken`
`GET`	`/api/v1/auth/sessions`	List the caller's sessions	`listSessions`
`DELETE`	`/api/v1/auth/sessions/{id}`	Sign out one session	`revokeSession`
`POST`	`/api/v1/auth/sessions/revoke-all`	Sign out everywhere	`revokeAllSessions`
`GET`	`/api/v1/auth/stores`	List stores the caller can enter	`listMyStores`
`POST`	`/api/v1/auth/switch-store`	Switch to another store	`switchStore`
`GET`	`/api/v1/auth/trusted-devices`	List the caller's remembered devices	`listTrustedDevices`
`DELETE`	`/api/v1/auth/trusted-devices/{id}`	Forget one remembered device	`revokeTrustedDevice`
`POST`	`/api/v1/auth/trusted-devices/revoke-all`	Forget every remembered device	`revokeAllTrustedDevices`

brands #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/brands`	List brands	`listBrands`	`brand.read`
`POST`	`/api/v1/brands`	Create a brand	`createBrand`	`brand.create`
`GET`	`/api/v1/brands/{id}`	Get a brand	`getBrand`	`brand.read`
`PUT`	`/api/v1/brands/{id}`	Replace a brand (full update)	`replaceBrand`	`brand.update`
`PATCH`	`/api/v1/brands/{id}`	Update a brand (partial)	`updateBrand`	`brand.update`
`DELETE`	`/api/v1/brands/{id}`	Delete a brand	`deleteBrand`	`brand.delete`
`POST`	`/api/v1/brands/{id}/restore`	Restore a brand from the trash	`restoreBrand`	`brand.restore`
`POST`	`/api/v1/brands/{id}/translations`	Add a brand translation	`addBrandTranslation`	`brand.update`
`PATCH`	`/api/v1/brands/{id}/translations/{lang}`	Update a brand translation	`updateBrandTranslation`	`brand.update`
`DELETE`	`/api/v1/brands/{id}/translations/{lang}`	Delete a brand translation	`deleteBrandTranslation`	`brand.update`
`GET`	`/api/v1/brands/options`	List brand options	`listBrandOptions`	`brand.read`
`GET`	`/api/v1/brands/trash`	List brands in the trash	`listBrandTrash`	`brand.restore`

core #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/core/accounts`	List accounts	`listAccounts`	`superuser`
`POST`	`/api/v1/core/accounts`	Create an account	`createAccount`	`superuser`
`PUT`	`/api/v1/core/accounts/{id}/limits`	Set an account's limits	`setAccountLimits`	`superuser`
`GET`	`/api/v1/core/api-keys`	List API keys	`listApiKeys`	`core.manage_users`
`DELETE`	`/api/v1/core/api-keys/{id}`	Revoke an API key	`revokeApiKey`	`core.manage_users`
`GET`	`/api/v1/core/audit`	List audit log entries	`listAuditLog`	`core.view_audit`
`GET`	`/api/v1/core/audit/records/{resource}/{id}`	List the change history of a business record	`listRecordChanges`	`core.view_record_history`
`GET`	`/api/v1/core/configs`	List the tenant's settings	`listConfigs`	`core.manage_settings`
`PUT`	`/api/v1/core/configs/{code}`	Set a setting at one level	`setConfig`	`core.manage_settings`
`DELETE`	`/api/v1/core/configs/{code}`	Remove a setting at one level	`resetConfig`	`core.manage_settings`
`GET`	`/api/v1/core/customers`	List storefront customers	`listCustomers`	`core.view_customers`
`POST`	`/api/v1/core/customers`	Create a storefront customer without a password	`createCustomer`	`core.manage_customers`
`GET`	`/api/v1/core/customers/{id}`	Get a storefront customer	`getCustomer`	`core.view_customers`
`PATCH`	`/api/v1/core/customers/{id}`	Change a storefront customer's name or phone	`updateCustomer`	`core.manage_customers`, `core.view_customers`
`POST`	`/api/v1/core/customers/{id}/erase`	Erase a storefront customer's account	`eraseCustomer`	`core.erase_customers`
`POST`	`/api/v1/core/customers/{id}/unlink`	Remove a storefront customer from your stores	`unlinkCustomer`	`core.erase_customers`
`GET`	`/api/v1/core/jobs`	List background jobs	`listJobs`	`superuser`
`GET`	`/api/v1/core/jobs/{id}`	Get a background job	`getJob`	`superuser`
`DELETE`	`/api/v1/core/jobs/{id}`	Delete a dead job	`deleteJob`	`superuser`
`POST`	`/api/v1/core/jobs/{id}/retry`	Run a job again now	`retryJob`	`superuser`
`GET`	`/api/v1/core/modules`	List modules	`listDatabaseModules`	`superuser`
`DELETE`	`/api/v1/core/modules/{name}`	Uninstall a module	`uninstallModule`	`superuser`
`POST`	`/api/v1/core/modules/install`	Install modules	`installModules`	`superuser`
`POST`	`/api/v1/core/modules/upgrade`	Upgrade modules	`upgradeModules`	`superuser`
`GET`	`/api/v1/core/permissions`	List permissions	`listPermissions`	`core.manage_roles`
`GET`	`/api/v1/core/record-rules`	List record rules	`listRecordRules`	`core.manage_record_rules`
`POST`	`/api/v1/core/record-rules`	Create a record rule	`createRecordRule`	`core.manage_record_rules`
`DELETE`	`/api/v1/core/record-rules/{id}`	Delete a record rule	`deleteRecordRule`	`core.manage_record_rules`
`GET`	`/api/v1/core/roles`	List roles	`listRoles`	`core.manage_roles`
`POST`	`/api/v1/core/roles`	Create a role	`createRole`	`core.manage_roles`
`PATCH`	`/api/v1/core/roles/{code}`	Update a role	`updateRole`	`core.manage_roles`
`DELETE`	`/api/v1/core/roles/{code}`	Delete a role	`deleteRole`	`core.manage_roles`
`GET`	`/api/v1/core/schedules`	List scheduled tasks	`listSchedules`	`superuser`
`GET`	`/api/v1/core/store-modules`	Modules of the current store	`listCurrentStoreModules`	`core.manage_store_modules`
`POST`	`/api/v1/core/store-modules/disable`	Turn modules off in the current store	`disableCurrentStoreModules`	`core.manage_store_modules`
`POST`	`/api/v1/core/store-modules/enable`	Turn modules back on in the current store	`enableCurrentStoreModules`	`core.manage_store_modules`
`GET`	`/api/v1/core/store-relations`	List store relations (chains / marketplaces)	`listStoreRelations`	`superuser`
`POST`	`/api/v1/core/store-relations`	Relate two stores	`addStoreRelation`	`superuser`
`DELETE`	`/api/v1/core/store-relations`	Remove a store relation	`removeStoreRelation`	`superuser`
`GET`	`/api/v1/core/stores`	List stores with their modules	`listStoreModules`	`superuser`
`POST`	`/api/v1/core/stores`	Create a store	`createStore`	`superuser`
`PATCH`	`/api/v1/core/stores/{code}`	Update a store	`updateStore`	`superuser`
`POST`	`/api/v1/core/stores/{code}/modules`	Enable modules for a store	`enableStoreModules`	`superuser`
`PUT`	`/api/v1/core/stores/{code}/modules`	Set the modules of a store	`setStoreModules`	`superuser`
`DELETE`	`/api/v1/core/stores/{code}/modules/{name}`	Disable a module for a store	`disableStoreModule`	`superuser`
`PUT`	`/api/v1/core/stores/{code}/plan`	Set a store's plan	`setStorePlan`	`superuser`
`DELETE`	`/api/v1/core/stores/{code}/plan`	Remove a store's plan (unlimited)	`removeStorePlan`	`superuser`
`GET`	`/api/v1/core/users`	List users	`listUsers`	`core.manage_users`
`POST`	`/api/v1/core/users`	Create a user	`createUser`	`core.manage_users`
`GET`	`/api/v1/core/users/{id}`	Get a user	`getUser`	`core.manage_users`
`PATCH`	`/api/v1/core/users/{id}`	Update a user	`updateUser`	`core.manage_users`
`GET`	`/api/v1/core/users/{id}/effective-permissions`	Explain a user's effective permissions	`getUserEffectivePermissions`	`core.manage_users`
`POST`	`/api/v1/core/users/{id}/mfa/reset`	Reset a user's MFA	`resetUserMfa`	`core.manage_users`
`PUT`	`/api/v1/core/users/{id}/permission-overrides`	Replace a user's permission overrides	`setUserPermissionOverrides`	`core.manage_users`
`POST`	`/api/v1/core/users/{id}/unlock`	Unlock a user's login	`unlockUser`	`core.manage_users`
`GET`	`/api/v1/core/webhooks`	Outbound webhooks of this store	`listWebhooks`	`core.manage_webhooks`
`POST`	`/api/v1/core/webhooks`	Register an outbound webhook	`createWebhook`	`core.manage_webhooks`
`PATCH`	`/api/v1/core/webhooks/{id}`	Change an outbound webhook	`updateWebhook`	`core.manage_webhooks`
`DELETE`	`/api/v1/core/webhooks/{id}`	Remove an outbound webhook (and its delivery log)	`deleteWebhook`	`core.manage_webhooks`
`GET`	`/api/v1/core/webhooks/{id}/deliveries`	Latest 50 deliveries of a webhook	`listWebhookDeliveries`	`core.manage_webhooks`
`POST`	`/api/v1/core/webhooks/{id}/rotate-secret`	Replace the signing secret	`rotateWebhookSecret`	`core.manage_webhooks`
`POST`	`/api/v1/core/webhooks/{id}/test`	Send a test event (core.ping)	`testWebhook`	`core.manage_webhooks`
`POST`	`/api/v1/core/webhooks/deliveries/{id}/redeliver`	Send a past delivery again	`redeliverWebhook`	`core.manage_webhooks`
`GET`	`/api/v1/core/webhooks/events`	Webhook events available in this store	`listWebhookEvents`	`core.manage_webhooks`
`GET`	`/api/v1/core/workers`	List background job worker processes	`listWorkers`	`superuser`

coupons #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/coupons`	List coupons	`listCoupons`	`coupon.read`
`POST`	`/api/v1/coupons`	Create a coupon	`createCoupon`	`coupon.create`
`GET`	`/api/v1/coupons/{id}`	Get a coupon	`getCoupon`	`coupon.read`
`PUT`	`/api/v1/coupons/{id}`	Replace a coupon (full update)	`replaceCoupon`	`coupon.update`
`PATCH`	`/api/v1/coupons/{id}`	Update a coupon (partial)	`updateCoupon`	`coupon.update`
`DELETE`	`/api/v1/coupons/{id}`	Delete a coupon	`deleteCoupon`	`coupon.delete`
`POST`	`/api/v1/coupons/{id}/restore`	Restore a coupon from the trash	`restoreCoupon`	`coupon.restore`
`GET`	`/api/v1/coupons/options`	List coupon options	`listCouponOptions`	`coupon.read`
`GET`	`/api/v1/coupons/trash`	List coupons in the trash	`listCouponTrash`	`coupon.restore`

customer-type-price-rules #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/customer-type-price-rules`	List customer type price rules	`listCustomerTypePriceRules`	`customer_type_price_rule.read`
`POST`	`/api/v1/customer-type-price-rules`	Create a customer type price rule	`createCustomerTypePriceRule`	`customer_type_price_rule.create`
`GET`	`/api/v1/customer-type-price-rules/{id}`	Get a customer type price rule	`getCustomerTypePriceRule`	`customer_type_price_rule.read`
`PATCH`	`/api/v1/customer-type-price-rules/{id}`	Update a customer type price rule (partial)	`updateCustomerTypePriceRule`	`customer_type_price_rule.update`
`DELETE`	`/api/v1/customer-type-price-rules/{id}`	Delete a customer type price rule	`deleteCustomerTypePriceRule`	`customer_type_price_rule.delete`
`GET`	`/api/v1/customer-type-price-rules/options`	List customer type price rule options	`listCustomerTypePriceRuleOptions`	`customer_type_price_rule.read`

customer-types #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/customer-types`	List customer types	`listCustomerTypes`	`customer_type.read`
`POST`	`/api/v1/customer-types`	Create a customer type	`createCustomerType`	`customer_type.create`
`GET`	`/api/v1/customer-types/{id}`	Get a customer type	`getCustomerType`	`customer_type.read`
`PUT`	`/api/v1/customer-types/{id}`	Replace a customer type (full update)	`replaceCustomerType`	`customer_type.update`
`PATCH`	`/api/v1/customer-types/{id}`	Update a customer type (partial)	`updateCustomerType`	`customer_type.update`
`DELETE`	`/api/v1/customer-types/{id}`	Delete a customer type	`deleteCustomerType`	`customer_type.delete`
`POST`	`/api/v1/customer-types/{id}/restore`	Restore a customer type from the trash	`restoreCustomerType`	`customer_type.restore`
`GET`	`/api/v1/customer-types/members`	Customers and their customer type	`listCustomerTypeMembers`	`customer_type.read`
`PUT`	`/api/v1/customer-types/members/{customerId}`	Set the customer type of a customer	`setCustomerType`	`customer_type.assign`
`GET`	`/api/v1/customer-types/options`	List customer type options	`listCustomerTypeOptions`	`customer_type.read`
`GET`	`/api/v1/customer-types/trash`	List customer types in the trash	`listCustomerTypeTrash`	`customer_type.restore`

data #

Method	Đường	Tóm tắt	Method SDK
`GET`	`/api/v1/data/datasets`	Datasets the user can export or import	`listDatasets`
`GET`	`/api/v1/data/datasets/{name}/export`	Export a dataset as CSV or Excel	`exportDataset`
`POST`	`/api/v1/data/datasets/{name}/exports`	Export a dataset in the background	`startDatasetExport`
`POST`	`/api/v1/data/datasets/{name}/import`	Import a CSV or Excel file	`importDataset`
`POST`	`/api/v1/data/datasets/{name}/imports`	Import a large CSV or Excel file in the background	`startDatasetImport`
`GET`	`/api/v1/data/datasets/{name}/template`	Empty import file (header row only)	`datasetImportTemplate`
`GET`	`/api/v1/data/exports`	My background exports in this store	`listDataExports`
`GET`	`/api/v1/data/exports/{id}/file`	Download a finished background export	`downloadDataExport`
`GET`	`/api/v1/data/imports`	My background imports in this store	`listDataImports`
`GET`	`/api/v1/data/imports/{id}`	A background import with its errors by line	`getDataImport`

files #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/files`	List files	`listFiles`	`files.read`
`POST`	`/api/v1/files`	Upload a file	`uploadFile`	`files.write`
`GET`	`/api/v1/files/{id}`	Get file metadata	`getFile`	`files.read`
`DELETE`	`/api/v1/files/{id}`	Delete a file	`deleteFile`	`files.write`
`GET`	`/api/v1/files/{id}/content`	Download file content	`downloadFile`	`files.read`
`POST`	`/api/v1/files/uploads`	Start a chunked upload	`startUpload`	`files.write`
`GET`	`/api/v1/files/uploads/{id}`	Get a chunked upload session	`getUpload`	`files.write`
`DELETE`	`/api/v1/files/uploads/{id}`	Abort a chunked upload	`abortUpload`	`files.write`
`POST`	`/api/v1/files/uploads/{id}/complete`	Complete a chunked upload	`completeUpload`	`files.write`
`PUT`	`/api/v1/files/uploads/{id}/parts/{n}`	Upload one part	`uploadPart`	`files.write`
`GET`	`/api/v1/files/usage`	Storage used and its limits	`getFileUsage`	`files.read`

gift-cards #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/gift-cards`	List gift cards	`listGiftCards`	`gift_card.read`
`POST`	`/api/v1/gift-cards`	Create a gift card	`createGiftCard`	`gift_card.create`
`GET`	`/api/v1/gift-cards/{id}`	Get a gift card	`getGiftCard`	`gift_card.read`
`PATCH`	`/api/v1/gift-cards/{id}`	Update a gift card (partial)	`updateGiftCard`	`gift_card.update`
`DELETE`	`/api/v1/gift-cards/{id}`	Delete a gift card	`deleteGiftCard`	`gift_card.delete`
`POST`	`/api/v1/gift-cards/{id}/adjust`	Top up or deduct a gift card balance	`adjustGiftCard`	`gift_card.adjust`
`GET`	`/api/v1/gift-cards/{id}/transactions`	Ledger of a gift card	`listGiftCardTransactions`	`gift_card.read`
`GET`	`/api/v1/gift-cards/options`	List gift card options	`listGiftCardOptions`	`gift_card.read`
`GET`	`/api/v1/gift-cards/order-refunds`	What can still go back to gift cards for an order	`listGiftCardOrderRefundables`	`gift_card.read`
`POST`	`/api/v1/gift-cards/order-refunds`	Give the gift card part of an order back to the card	`refundOrderToGiftCard`	`gift_card.adjust`

me #

Method	Đường	Tóm tắt	Method SDK
`GET`	`/api/v1/me/events`	Realtime events (Server-Sent Events)	`streamMyEvents`
`GET`	`/api/v1/me/notifications`	List my notifications	`listMyNotifications`
`POST`	`/api/v1/me/notifications/{id}/read`	Mark one of my notifications as read	`markMyNotificationRead`
`POST`	`/api/v1/me/notifications/read-all`	Mark all my notifications as read	`markAllMyNotificationsRead`
`GET`	`/api/v1/me/notifications/unread-count`	Count my unread notifications	`countMyUnreadNotifications`
`GET`	`/api/v1/me/push`	Web Push configuration	`getMyPushConfig`
`GET`	`/api/v1/me/push/subscriptions`	My browsers with Web Push in this store	`listMyPushSubscriptions`
`POST`	`/api/v1/me/push/subscriptions`	Turn on Web Push for this browser	`createMyPushSubscription`
`DELETE`	`/api/v1/me/push/subscriptions/{id}`	Turn off Web Push for a browser	`deleteMyPushSubscription`

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/menu`	Admin menu entries the current user can use	`listMenu`
`GET`	`/api/v1/menu/{key}/screen`	Data description of a menu entry's admin screen	`getMenuScreen`

modules #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/modules`	Modules for building the menu	`listModules`

orders #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/orders`	List orders	`listOrders`	`order.read`
`POST`	`/api/v1/orders`	Create an order	`createOrder`	`order.create`
`GET`	`/api/v1/orders/{id}`	Get an order with its lines	`getOrder`	`order.read`
`POST`	`/api/v1/orders/{id}/cancel`	Cancel an order	`cancelOrder`	`order.cancel`
`POST`	`/api/v1/orders/{id}/complete`	Complete an order	`completeOrder`	`order.manage`
`POST`	`/api/v1/orders/{id}/confirm`	Confirm an order	`confirmOrder`	`order.manage`
`POST`	`/api/v1/orders/{id}/fulfill`	Fulfil an order (ship the goods)	`fulfillOrder`	`order.manage`
`POST`	`/api/v1/orders/{id}/record-payment`	Record money received outside the gateways	`recordOrderPayment`	`order.record_payment`
`POST`	`/api/v1/orders/quote`	Preview the totals of an order to create	`quoteOrder`	`order.create`

payments #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/payments/intents`	List payment intents	`listPaymentIntents`	`payments.read`
`POST`	`/api/v1/payments/intents`	Create a payment intent	`createPaymentIntent`	`payments.write`
`GET`	`/api/v1/payments/intents/{id}`	Get a payment intent	`getPaymentIntent`	`payments.read`
`POST`	`/api/v1/payments/intents/{id}/cancel`	Cancel a pending payment intent	`cancelPaymentIntent`	`payments.write`
`POST`	`/api/v1/payments/intents/{id}/einvoice/retry`	Retry the VAT e-invoice of a paid intent	`retryPaymentIntentEinvoice`	`payments.reconcile`
`POST`	`/api/v1/payments/intents/{id}/momo`	Start a MoMo payment for an intent	`createPaymentIntentMomoCheckout`	`payments.write`
`POST`	`/api/v1/payments/intents/{id}/momo/query`	Ask MoMo about the intent's latest MoMo order	`queryPaymentIntentMomo`	`payments.reconcile`
`GET`	`/api/v1/payments/transactions`	List incoming transactions	`listPaymentTransactions`	`payments.read`
`POST`	`/api/v1/payments/transactions/{id}/ignore`	Ignore an unmatched transaction	`ignorePaymentTransaction`	`payments.reconcile`
`POST`	`/api/v1/payments/transactions/{id}/match`	Match an unmatched transaction to an intent	`matchPaymentTransaction`	`payments.reconcile`
`GET`	`/api/v1/payments/webhooks`	Webhook URLs to paste into the payment gateways	`getPaymentWebhookUrls`	`payments.read`

plan #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/plan`	The current store's plan, limits and usage	`getStorePlan`

pre-order-settings #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/pre-order-settings`	List pre-order settings	`listPreOrderSettings`	`pre_order_setting.read`
`POST`	`/api/v1/pre-order-settings`	Create a pre-order setting	`createPreOrderSetting`	`pre_order_setting.create`
`GET`	`/api/v1/pre-order-settings/{id}`	Get a pre-order setting	`getPreOrderSetting`	`pre_order_setting.read`
`PATCH`	`/api/v1/pre-order-settings/{id}`	Update a pre-order setting (partial)	`updatePreOrderSetting`	`pre_order_setting.update`
`DELETE`	`/api/v1/pre-order-settings/{id}`	Delete a pre-order setting	`deletePreOrderSetting`	`pre_order_setting.delete`
`POST`	`/api/v1/pre-order-settings/{id}/restore`	Restore a pre-order setting from the trash	`restorePreOrderSetting`	`pre_order_setting.restore`
`GET`	`/api/v1/pre-order-settings/options`	List pre-order setting options	`listPreOrderSettingOptions`	`pre_order_setting.read`
`GET`	`/api/v1/pre-order-settings/trash`	List pre-order settings in the trash	`listPreOrderSettingTrash`	`pre_order_setting.restore`

price #

Method	Đường	Tóm tắt	Method SDK	Quyền
`POST`	`/api/v1/price/quote`	Quote lines (staff)	`quotePrices`	`price.quote`

price-lists #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/price-lists`	List price lists	`listPriceLists`	`price_list.read`
`POST`	`/api/v1/price-lists`	Create a price list	`createPriceList`	`price_list.create`
`GET`	`/api/v1/price-lists/{id}`	Get a price list	`getPriceList`	`price_list.read`
`PUT`	`/api/v1/price-lists/{id}`	Replace a price list (full update)	`replacePriceList`	`price_list.update`
`PATCH`	`/api/v1/price-lists/{id}`	Update a price list (partial)	`updatePriceList`	`price_list.update`
`DELETE`	`/api/v1/price-lists/{id}`	Delete a price list	`deletePriceList`	`price_list.delete`
`GET`	`/api/v1/price-lists/{id}/customers`	Customers of a price list	`listPriceListCustomers`	`price_list.read`
`PUT`	`/api/v1/price-lists/{id}/customers`	Replace the customers of a price list	`setPriceListCustomers`	`price_list.update`
`GET`	`/api/v1/price-lists/{id}/items`	Prices of a price list	`listPriceListItems`	`price_list.read`
`PUT`	`/api/v1/price-lists/{id}/items`	Replace the prices of a price list	`setPriceListItems`	`price_list.update`
`POST`	`/api/v1/price-lists/{id}/restore`	Restore a price list from the trash	`restorePriceList`	`price_list.restore`
`GET`	`/api/v1/price-lists/options`	List price list options	`listPriceListOptions`	`price_list.read`
`GET`	`/api/v1/price-lists/trash`	List price lists in the trash	`listPriceListTrash`	`price_list.restore`

prints #

Method	Đường	Tóm tắt	Method SDK
`GET`	`/api/v1/prints`	Printable document templates I can use in this store	`listPrintables`
`GET`	`/api/v1/prints/{name}/{id}`	Render a document for printing (HTML) or as PDF	`printDocument`
`POST`	`/api/v1/prints/{name}/{id}/email`	Email a document to the recipient the module defines	`emailDocument`

product-categories #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/product-categories`	List product categories	`listProductCategories`	`product_category.read`
`POST`	`/api/v1/product-categories`	Create a product category	`createProductCategory`	`product_category.create`
`GET`	`/api/v1/product-categories/{id}`	Get a product category	`getProductCategory`	`product_category.read`
`PATCH`	`/api/v1/product-categories/{id}`	Update a product category (partial)	`updateProductCategory`	`product_category.update`
`DELETE`	`/api/v1/product-categories/{id}`	Delete a product category	`deleteProductCategory`	`product_category.delete`
`GET`	`/api/v1/product-categories/options`	List product category options	`listProductCategoryOptions`	`product_category.read`

products #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/products`	List products	`listProducts`	`product.read`
`POST`	`/api/v1/products`	Create a product	`createProduct`	`product.create`
`GET`	`/api/v1/products/{id}`	Get a product	`getProduct`	`product.read`
`PATCH`	`/api/v1/products/{id}`	Update a product (partial)	`updateProduct`	`product.update`
`DELETE`	`/api/v1/products/{id}`	Delete a product	`deleteProduct`	`product.delete`
`POST`	`/api/v1/products/{id}/restore`	Restore a product from the trash	`restoreProduct`	`product.restore`
`POST`	`/api/v1/products/{id}/variants`	Add a product variant	`addProductVariant`	`product.update`
`PATCH`	`/api/v1/products/{id}/variants/{variantId}`	Update a product variant (partial)	`updateProductVariant`	`product.update`
`DELETE`	`/api/v1/products/{id}/variants/{variantId}`	Delete a product variant	`deleteProductVariant`	`product.update`
`GET`	`/api/v1/products/attributes`	List product attributes	`listProductAttributes`	`product.read`
`POST`	`/api/v1/products/attributes`	Create a product attribute	`createProductAttribute`	`product.manage_attributes`
`GET`	`/api/v1/products/attributes/{id}`	Get a product attribute	`getProductAttribute`	`product.read`
`PATCH`	`/api/v1/products/attributes/{id}`	Update a product attribute (partial)	`updateProductAttribute`	`product.manage_attributes`
`DELETE`	`/api/v1/products/attributes/{id}`	Delete a product attribute	`deleteProductAttribute`	`product.manage_attributes`
`POST`	`/api/v1/products/attributes/{id}/values`	Add a value to a product attribute	`addProductAttributeValue`	`product.manage_attributes`
`PATCH`	`/api/v1/products/attributes/{id}/values/{valueId}`	Update a product attribute value (partial)	`updateProductAttributeValue`	`product.manage_attributes`
`DELETE`	`/api/v1/products/attributes/{id}/values/{valueId}`	Delete a product attribute value	`deleteProductAttributeValue`	`product.manage_attributes`
`GET`	`/api/v1/products/options`	List product options	`listProductOptions`	`product.read`
`GET`	`/api/v1/products/trash`	List products in the trash	`listProductTrash`	`product.restore`
`GET`	`/api/v1/products/variants/options`	List product variant options	`listProductVariantOptions`	`product.read`

purchase-orders #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/purchase-orders`	List purchase orders	`listPurchaseOrders`	`purchase_order.read`
`POST`	`/api/v1/purchase-orders`	Create a purchase order (draft)	`createPurchaseOrder`	`purchase_order.create`
`GET`	`/api/v1/purchase-orders/{id}`	Get a purchase order with its lines	`getPurchaseOrder`	`purchase_order.read`
`DELETE`	`/api/v1/purchase-orders/{id}`	Delete a draft purchase order	`deletePurchaseOrder`	`purchase_order.delete`
`POST`	`/api/v1/purchase-orders/{id}/cancel`	Cancel a purchase order	`cancelPurchaseOrder`	`purchase_order.update`
`POST`	`/api/v1/purchase-orders/{id}/close`	Close a fully received purchase order	`closePurchaseOrder`	`purchase_order.update`
`POST`	`/api/v1/purchase-orders/{id}/place`	Place a draft purchase order	`placePurchaseOrder`	`purchase_order.update`
`POST`	`/api/v1/purchase-orders/{id}/receive`	Receive goods of a purchase order	`receivePurchaseOrder`	`purchase_order.receive`, `stock.view_cost`
`POST`	`/api/v1/purchase-orders/{id}/returns`	Return received goods to the supplier	`returnPurchaseOrderItems`	`purchase_order.receive`
`POST`	`/api/v1/purchase-orders/{id}/short-close`	Close a partially received purchase order	`shortClosePurchaseOrder`	`purchase_order.update`

refunds #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/refunds`	List refunds	`listRefunds`	`refund.read`
`POST`	`/api/v1/refunds`	Create a refund for an order (pending)	`createRefund`	`refund.create`
`GET`	`/api/v1/refunds/{id}`	Get a refund	`getRefund`	`refund.read`
`POST`	`/api/v1/refunds/{id}/complete`	Complete a refund (money paid back)	`completeRefund`	`refund.complete`
`POST`	`/api/v1/refunds/{id}/fail`	Mark a refund failed	`failRefund`	`refund.complete`
`POST`	`/api/v1/refunds/{id}/send`	Send a MoMo refund through the store's MoMo account	`sendRefund`	`refund.send`

reports #

Method	Đường	Tóm tắt	Method SDK
`GET`	`/api/v1/reports`	Reports the user can run	`listReports`
`POST`	`/api/v1/reports/{name}/export`	Run a report and download it as CSV or Excel	`exportReport`
`POST`	`/api/v1/reports/{name}/exports`	Run a report in the background	`startReportExport`
`POST`	`/api/v1/reports/{name}/run`	Run a report	`runReport`
`GET`	`/api/v1/reports/schedules`	My scheduled report emails in this store	`listReportSchedules`
`POST`	`/api/v1/reports/schedules`	Email me a report on a schedule	`createReportSchedule`
`PATCH`	`/api/v1/reports/schedules/{id}`	Change or pause a scheduled report	`updateReportSchedule`
`DELETE`	`/api/v1/reports/schedules/{id}`	Stop a scheduled report	`deleteReportSchedule`

return-requests #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/return-requests`	List return requests	`listReturnRequests`	`return_request.read`
`POST`	`/api/v1/return-requests`	Create a return request for an order	`createReturnRequest`	`return_request.create`
`GET`	`/api/v1/return-requests/{id}`	Get a return request	`getReturnRequest`	`return_request.read`
`POST`	`/api/v1/return-requests/{id}/approve`	Approve a return request	`approveReturnRequest`	`return_request.manage`
`POST`	`/api/v1/return-requests/{id}/cancel`	Cancel a return request	`cancelReturnRequest`	`return_request.manage`
`POST`	`/api/v1/return-requests/{id}/close`	Close a received return without a refund	`closeReturnRequest`	`return_request.manage`
`POST`	`/api/v1/return-requests/{id}/receive`	Receive the returned goods	`receiveReturnRequest`	`return_request.receive`
`POST`	`/api/v1/return-requests/{id}/refund`	Refund a received return	`refundReturnRequest`	`return_request.refund`
`POST`	`/api/v1/return-requests/{id}/reject`	Reject a return request	`rejectReturnRequest`	`return_request.manage`

shipments #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/shipments`	List shipments	`listShipments`	`shipment.read`
`POST`	`/api/v1/shipments`	Create a shipment for an order (pending)	`createShipment`	`shipment.manage`
`GET`	`/api/v1/shipments/{id}`	Get a shipment	`getShipment`	`shipment.read`
`PATCH`	`/api/v1/shipments/{id}`	Update carrier details of a shipment	`updateShipment`	`shipment.manage`
`POST`	`/api/v1/shipments/{id}/cod-remit`	Record that the carrier remitted the cash on delivery	`remitShipmentCod`	`shipment.reconcile`
`POST`	`/api/v1/shipments/{id}/status`	Move a shipment to its next status	`setShipmentStatus`	`shipment.manage`
`GET`	`/api/v1/shipments/cod-summary`	Cash on delivery the carriers still hold	`getShipmentCodSummary`	`shipment.read`

stock #

Method	Đường	Tóm tắt	Method SDK	Quyền
`POST`	`/api/v1/stock/adjustments`	Adjust stock quantities	`createStockAdjustment`	`stock.adjust`
`GET`	`/api/v1/stock/allocation`	Preview which warehouses would fulfil a quantity	`previewStockAllocation`	`stock.read`
`GET`	`/api/v1/stock/batches`	List stock batches (lots)	`listStockBatches`	`stock.read`
`GET`	`/api/v1/stock/batches/expiring`	List batches expiring soon	`listExpiringStockBatches`	`stock.read`
`GET`	`/api/v1/stock/levels`	List stock levels	`listStockLevels`	`stock.read`
`GET`	`/api/v1/stock/levels/{id}`	Get a stock level	`getStockLevel`	`stock.read`
`PATCH`	`/api/v1/stock/levels/{id}`	Set the low-stock threshold or pick location	`updateStockLevel`	`stock.adjust`
`GET`	`/api/v1/stock/movements`	List stock movements (ledger)	`listStockMovements`	`stock.read`
`POST`	`/api/v1/stock/receipts`	Receive goods into a warehouse	`createStockReceipt`	`stock.receive`
`GET`	`/api/v1/stock/serials`	List serial numbers	`listStockSerials`	`stock.read`
`POST`	`/api/v1/stock/supplier-returns`	Return goods to a supplier	`createStockSupplierReturn`	`stock.receive`
`GET`	`/api/v1/stock/tracking/{variantId}`	Get the tracking mode of a variant	`getStockTracking`	`stock.read`
`PUT`	`/api/v1/stock/tracking/{variantId}`	Set the tracking mode of a variant	`setStockTracking`	`stock.manage_tracking`
`GET`	`/api/v1/stock/vouchers`	List stock vouchers	`listStockVouchers`	`stock.read`
`GET`	`/api/v1/stock/vouchers/{id}`	Get a stock voucher with its lines	`getStockVoucher`	`stock.read`

stock-counts #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/stock-counts`	List stock counts	`listStockCounts`	`stock_count.read`
`POST`	`/api/v1/stock-counts`	Open a stock count	`createStockCount`	`stock_count.create`
`GET`	`/api/v1/stock-counts/{id}`	Get a stock count with its lines	`getStockCount`	`stock_count.read`
`DELETE`	`/api/v1/stock-counts/{id}`	Delete an unreconciled stock count	`deleteStockCount`	`stock_count.delete`
`POST`	`/api/v1/stock-counts/{id}/cancel`	Cancel an open stock count	`cancelStockCount`	`stock_count.create`
`POST`	`/api/v1/stock-counts/{id}/reconcile`	Reconcile a stock count	`reconcileStockCount`	`stock_count.reconcile`

stock-transfers #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/stock-transfers`	List stock transfers	`listStockTransfers`	`stock_transfer.read`
`POST`	`/api/v1/stock-transfers`	Create a stock transfer (draft)	`createStockTransfer`	`stock_transfer.create`
`GET`	`/api/v1/stock-transfers/{id}`	Get a stock transfer with its lines	`getStockTransfer`	`stock_transfer.read`
`DELETE`	`/api/v1/stock-transfers/{id}`	Delete a draft stock transfer	`deleteStockTransfer`	`stock_transfer.delete`
`POST`	`/api/v1/stock-transfers/{id}/cancel`	Cancel a stock transfer	`cancelStockTransfer`	`stock_transfer.ship`
`POST`	`/api/v1/stock-transfers/{id}/receive`	Receive a stock transfer	`receiveStockTransfer`	`stock_transfer.receive`
`POST`	`/api/v1/stock-transfers/{id}/ship`	Ship a stock transfer	`shipStockTransfer`	`stock_transfer.ship`

suppliers #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/suppliers`	List suppliers	`listSuppliers`	`supplier.read`
`POST`	`/api/v1/suppliers`	Create a supplier	`createSupplier`	`supplier.create`
`GET`	`/api/v1/suppliers/{id}`	Get a supplier	`getSupplier`	`supplier.read`
`PUT`	`/api/v1/suppliers/{id}`	Replace a supplier (full update)	`replaceSupplier`	`supplier.update`
`PATCH`	`/api/v1/suppliers/{id}`	Update a supplier (partial)	`updateSupplier`	`supplier.update`
`DELETE`	`/api/v1/suppliers/{id}`	Delete a supplier	`deleteSupplier`	`supplier.delete`
`POST`	`/api/v1/suppliers/{id}/restore`	Restore a supplier from the trash	`restoreSupplier`	`supplier.restore`
`GET`	`/api/v1/suppliers/options`	List supplier options	`listSupplierOptions`	`supplier.read`
`GET`	`/api/v1/suppliers/trash`	List suppliers in the trash	`listSupplierTrash`	`supplier.restore`

tax-classes #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/tax-classes`	List tax classes	`listTaxClasses`	`tax.read`
`POST`	`/api/v1/tax-classes`	Create a tax class	`createTaxClass`	`tax.create`
`GET`	`/api/v1/tax-classes/{id}`	Get a tax class	`getTaxClass`	`tax.read`
`PUT`	`/api/v1/tax-classes/{id}`	Replace a tax class (full update)	`replaceTaxClass`	`tax.update`
`PATCH`	`/api/v1/tax-classes/{id}`	Update a tax class (partial)	`updateTaxClass`	`tax.update`
`DELETE`	`/api/v1/tax-classes/{id}`	Delete a tax class	`deleteTaxClass`	`tax.delete`
`GET`	`/api/v1/tax-classes/{id}/rates`	List the rates of a tax class	`listTaxRates`	`tax.read`
`POST`	`/api/v1/tax-classes/{id}/rates`	Add a rate to a tax class	`createTaxRate`	`tax.update`
`PUT`	`/api/v1/tax-classes/{id}/rates/{rateId}`	Replace a tax rate	`replaceTaxRate`	`tax.update`
`DELETE`	`/api/v1/tax-classes/{id}/rates/{rateId}`	Delete a tax rate	`deleteTaxRate`	`tax.update`
`POST`	`/api/v1/tax-classes/{id}/restore`	Restore a tax class from the trash	`restoreTaxClass`	`tax.restore`
`GET`	`/api/v1/tax-classes/options`	List tax class options	`listTaxClassOptions`	`tax.read`
`GET`	`/api/v1/tax-classes/products/{productId}`	Get the tax class of a product	`getProductTaxClass`	`tax.read`
`PUT`	`/api/v1/tax-classes/products/{productId}`	Set the tax class of a product	`setProductTaxClass`	`tax.update`
`GET`	`/api/v1/tax-classes/trash`	List tax classes in the trash	`listTaxClassTrash`	`tax.restore`

uoms #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/uoms`	List units of measure	`listUoms`	`uom.read`
`POST`	`/api/v1/uoms`	Create a unit of measure	`createUom`	`uom.create`
`GET`	`/api/v1/uoms/{id}`	Get a unit of measure	`getUom`	`uom.read`
`PUT`	`/api/v1/uoms/{id}`	Replace a unit of measure (full update)	`replaceUom`	`uom.update`
`PATCH`	`/api/v1/uoms/{id}`	Update a unit of measure (partial)	`updateUom`	`uom.update`
`DELETE`	`/api/v1/uoms/{id}`	Delete a unit of measure	`deleteUom`	`uom.delete`
`POST`	`/api/v1/uoms/{id}/restore`	Restore a unit of measure from the trash	`restoreUom`	`uom.restore`
`PUT`	`/api/v1/uoms/{id}/translations`	Replace the names of a unit of measure	`setUomTranslations`	`uom.update`
`POST`	`/api/v1/uoms/baseline`	Install the baseline units of measure	`installBaselineUoms`	`uom.create`
`GET`	`/api/v1/uoms/options`	List unit of measure options	`listUomOptions`	`uom.read`
`GET`	`/api/v1/uoms/trash`	List units of measure in the trash	`listUomTrash`	`uom.restore`

warehouses #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/warehouses`	List warehouses	`listWarehouses`	`warehouse.read`
`POST`	`/api/v1/warehouses`	Create a warehouse	`createWarehouse`	`warehouse.create`
`GET`	`/api/v1/warehouses/{id}`	Get a warehouse	`getWarehouse`	`warehouse.read`
`PUT`	`/api/v1/warehouses/{id}`	Replace a warehouse (full update)	`replaceWarehouse`	`warehouse.update`
`PATCH`	`/api/v1/warehouses/{id}`	Update a warehouse (partial)	`updateWarehouse`	`warehouse.update`
`DELETE`	`/api/v1/warehouses/{id}`	Delete a warehouse	`deleteWarehouse`	`warehouse.delete`
`GET`	`/api/v1/warehouses/{id}/locations`	List locations of a warehouse	`listWarehouseLocations`	`warehouse.read`
`POST`	`/api/v1/warehouses/{id}/locations`	Create a warehouse location	`createWarehouseLocation`	`warehouse.manage_locations`
`GET`	`/api/v1/warehouses/{id}/locations/{locationId}`	Get a warehouse location	`getWarehouseLocation`	`warehouse.read`
`PATCH`	`/api/v1/warehouses/{id}/locations/{locationId}`	Update a warehouse location (partial)	`updateWarehouseLocation`	`warehouse.manage_locations`
`DELETE`	`/api/v1/warehouses/{id}/locations/{locationId}`	Delete a warehouse location	`deleteWarehouseLocation`	`warehouse.manage_locations`
`POST`	`/api/v1/warehouses/{id}/restore`	Restore a warehouse from the trash	`restoreWarehouse`	`warehouse.restore`
`GET`	`/api/v1/warehouses/options`	List warehouse options	`listWarehouseOptions`	`warehouse.read`
`GET`	`/api/v1/warehouses/trash`	List warehouses in the trash	`listWarehouseTrash`	`warehouse.restore`

wishlist #

Method	Đường	Tóm tắt	Method SDK	Quyền
`GET`	`/api/v1/wishlist`	Wishlist items of the store's customers	`listWishlistItems`	`wishlist.read`

Nguồn: xforge-modules: sdk/api.openapi.json

API CMS / admin #

auth #

brands #

core #

coupons #

customer-type-price-rules #

customer-types #

data #

files #

gift-cards #

me #

menu #

modules #

orders #

payments #

plan #

pre-order-settings #

price #

price-lists #

prints #

product-categories #

products #

purchase-orders #

refunds #

reports #

return-requests #

shipments #

stock #

stock-counts #

stock-transfers #

suppliers #

tax-classes #

uoms #

warehouses #

wishlist #