Order Interface
-
Get user shipping address interface
Retrieve the shipping address information of the currently logged-in user, this interface will return the most recently used shipping address.Attention: This interface uses the GET method and no request body data is required. Access requires user login. Returns the most recently used shipping address information. If the user has no shipping address, returns empty data. Request address {domain_address}/api/order/address Note: {domain_address} needs to be replaced with your domain address, such as https://www.anqicms -
Save user shipping address interface
Create or update the shipping address information for the user. Notes: This API uses the POST method and requires data to be submitted in application/ format. Access requires user login. If an ID parameter is provided, the existing address will be updated.Otherwise, create a new address All fields marked as required must be provided Request address {domain address}/api/order/address Note: {domain address} Replace it with your domain address, such as https://www.anqicms -
Cancel order interface
Cancel the user-specified order and update the order status to cancelled.Note that this interface uses the POST method, data must be submitted in application/ format, requires user login to access, can only cancel orders belonging to the current user, and the order must be in a cancellable state to be canceled. Request URL {domain address}/api/order/cancel Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms -
Create order interface
Create a user shopping order, support ordering a single item or multiple items, can specify delivery address, coupons and other information. Notes The interface uses the POST method, needs to be submitted in application/ format, requires user login to access, the order status is pending payment, waiting for user payment, can create an order through product ID or product detail list, supports using coupons and specifying a delivery address, request address {domain address}/api/order/create Note: {domain address} needs to be replaced with your domain address -
Order Details Retrieval Interface
Get detailed information of the specified order, including order status, product information, shipping address, and complete order data.Note that this interface uses the GET method, no request body data is required, access requires user login, can only obtain order details belonging to the current user, returns complete order information, product details, and shipping address information, request address {domain address}/api/order/detail Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms -
Order confirmation receipt interface
Allow users to confirm that the order has been received and update the order status to completed. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The order ID is required as an identifier for confirming receipt. Only logged-in users can call this interface. The order must be in the 'Shipped' status to confirm receipt. After confirming receipt, the order status will change to 'Completed'. Request address {domain_address}/api/order/finish Description: {domain_address} -
Order Creation Payment Interface
Create payment for pending orders, supporting multiple payment methods including WeChat, WeChat Mini Program, Alipay, PayPal, and Stripe. Notes The interface uses the POST method, data needs to be submitted in application/ format, order ID and payment method are required Only logged-in users can call this interface The order must be in the 'pending payment' status to create payment Payment information (QR code, jump link, or mini-program payment parameters) will be returned according to the different payment methods Request address -
Order application for refund interface
Allow users to apply for a refund for completed or paid orders, after submitting a refund application, wait for the administrator to review and process. Notes This interface uses the POST method, needs to be submitted in application/ format, and needs to provide the order ID as the identifier for the refund application Only logged-in users can call this interface The order must be in the "completed" or "paid" status to apply for a refund After applying for a refund, the order status will change to "refund in progress" -
Order List Retrieval Interface
Get the user's order list, support filtering by order status and pagination query.Attention: This interface uses the GET method, requires user login verification, supports filtering by order status (pending payment, paid, shipped, completed, etc.), supports pagination, the default number of items per page is determined by the pageSize parameter, and only returns the order information of the currently logged-in user. Request address {domain address}/api/orders Note: {domain address} needs to be replaced with your domain address, such as https://www.anqicms -
Check if the order has been paid interface
Check the payment status of the specified order, confirm whether the order has been paid.Attention, this interface uses the GET method, requires an order ID parameter, requires user login verification (verification that the order belongs to the current user), returns the payment status information of the order, can only query the current user's own orders, request address {domain address}/api/payment/check Note: {domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/payment/check -
Order Statistics Retrieval Interface
Get the current user's order statistics, including the count of orders in various states. -
Get order statistics chart interface
Get order statistics chart data, supporting query of historical trends by different order statuses. -
Product Checkout Information Retrieval Interface
Retrieve product settlement information, supporting settlement of orders for a single product or multiple products, including discount calculations, address information, etc. Notes The interface uses the POST method, and data must be submitted in application/ format Supports placing an order for a single product (through goods_id, quantity, goods_sku_id parameters) or multiple products (through details parameters) Supports the use of coupons (coupon code or coupon ID) User login verification is required Supports setting the recipient's address and order notes Request address -
Get order address list interface
API call address {domain address}/api/order/addresses Note: {domain address} needs to be replaced with your domain address, such as https://en.anqicms.com/api/order/addresses Call method GET Request parameters None Return parameters Field name Type Description code int Error code msg string Error description data object[] Result content data the item of the result -
Get wish list interface
Retrieve the wish list list of the currently logged-in user, support pagination query, and return the user's favorite product information. Notes The interface uses the GET method and does not require a request body The user must be logged in, and identity verification is performed through session or Token Support pagination queries, which can be controlled by parameters to control the number of items displayed per page and the current page number Return detailed information about the products in the wish list, including price, notes, etc. Include the current price of the product and the price comparison when added Request address {domain address}/api/wishlist/list Note: {domain address} -
Add Wish List Interface
Add the specified product to the user's wish list, supporting the setting of notes, price, priority, and other information. Notes: This interface uses the POST method and requires data to be submitted in application/ format. The product ID must be provided, and the SKU ID can be optionally provided. The user must be logged in, and identity is verified through session or Token. You can set the wish price, notes, and priority. If the product is already in the wish list, the existing record may be updated. Request address {domain address}/api/wishlist/add Description: {domain address} -
Remove Wish List Interface
Delete the specified product record from the user's wish list. Notes: This interface uses the POST method and requires data to be submitted in application/ format. A wish list record ID must be provided. The user must be logged in and authenticated via session or Token. Only records belonging to the current user's wish list can be deleted. The deletion operation is irreversible and should be performed with caution. Request address {domain address}/api/wishlist/delete. Note: Replace {domain address} with your domain address, such as https -
Get available coupon list interface
Retrieve the list of coupons available to the current user under the current situation, which supports filtering by order amount and product ID. Notes This interface is used to retrieve the list of coupons available to the current user. Coupons applicable to orders of specified amounts can be filtered through the amount parameter. Coupons applicable to specified products can be filtered through the archive_id parameter. It is necessary to log in to retrieve the coupon list. Ensure that the domain address is correctly configured. The returned coupons are valid and unused at the current time. The validity of the coupons includes time range, usage conditions, and other restrictions. Request address -
Get my coupons list interface
Retrieve the current user's coupons list, supporting pagination display and status filtering. Notes This API is used to retrieve the current user's coupon list information, supporting pagination queries, which can be controlled by the current and pageSize parameters. Support filtering coupons by status (unused, used, or all). The user needs to log in to get the coupon list. Ensure that the domain address is correctly configured. The returned results include total count information for easy pagination processing. Request address {domain address}/api/coupon/codes description -
Redeem coupon interface
Allow users to claim specified coupons by providing a coupon ID to obtain the coupon. Notes The interface uses the POST method, data needs to be submitted in application/ format A valid coupon ID needs to be provided Users must be logged in to claim coupons Coupons may have quantity limits or time limits The domain address needs to be correctly configured The same user may not be able to claim the same coupon twice Request address {domain address}/api/coupon/code Note: {domain address} -
Get shopping cart list interface
API call address {domain address}/api/cart/list Description: {domain address} Replace it with your domain address, such as https://en.anqicms.com/api/cart/list Call method GET Header or Cookie Field name Type Required Description cart string No Used as user judgment token when not logged in Request parameters Field name Type Required Description current int -
Add shopping cart interface
Add specified products to the shopping cart, supporting product SKU, quantity, and other information, suitable for shopping cart operations in e-commerce functions. Notes This interface uses the POST method and requires data to be submitted in application/ format It supports logged-in users and unlogged-in users (identified by cart token) Product ID and quantity must be specified Specific product specifications can be identified through SKU ID If the product is already in the shopping cart, the quantity will be updated instead of adding a new one Request address -
Remove shopping cart item interface
Remove the specified item from the shopping cart, delete the corresponding shopping cart record based on the cart ID. Notes: This interface uses the POST method, requires data to be submitted in application/ format, and needs to provide the cart record ID instead of the product ID. It supports logged-in users and non-logged-in users (identified by cart token). After deletion, a success message is returned. Request address {domain address}/api/cart/remove Instructions: {domain address} needs to be replaced with your domain address, such as -
Update shopping cart interface
API call address {domain address}/api/cart/update Note: {domain address} Replace it with your domain address, such as https://en.anqicms.com/api/cart/update Method POST Header or Cookie Field name Type Required Note cart string No Use this token to identify the user when not logged in Request parameters | Field name | Type | Required | Note -
Get communication customization order field interface
Get information about the available custom fields for communication customization orders, which are used to provide form fields when creating communication customization orders. -
Get communication customization order list interface
Retrieve the list of customized orders communicated by the user, with support for pagination. -
Create communication customization order interface
Create a communication customization order, used for users to submit customization requirements, waiting for merchant confirmation. Notes The interface uses the POST method, needs to be submitted in application/ format, requires user login to access The created order needs to be confirmed by the merchant before entering the payment process The order status is pending confirmation, waiting for merchant acceptance Request address {domain address}/api/communication/order/create Note: {domain address} needs to be replaced with your domain address, such as https -
Get communication customization order details interface
Get the detailed information of the customized communication order, including order status, communication records, etc. -
Update communication customized order interface
Update the basic information of the customized communication order, including title, content, and additional order information. Notes The interface uses the POST method, and data must be submitted in application/ format Access requires user login Can only update orders belonging to the current user Order ID is required as a parameter to specify the order to be updated Request address {domain address}/api/communication/order/update Instructions: {domain address} Replace it with your domain address, such as https://www -
Communication customized order acceptance quote interface
Caution: This interface uses the POST method, data needs to be submitted in application/ format, requires user login to access, the order status is pending payment, waiting for user payment, can be created by product ID or product detail list, this interface has the same parameters as the create order interface, specially used for accepting customized orders, request address {domain address}/api/communication/order/accept Note: {domain address} needs to be replaced with your domain address, such as https://www -
Retrieve Communication Custom Order Communication Information List Interface
Get the communication record list of the specified customized order, supporting pagination query. -
Send Communication Custom Order Information Interface
Send a message to the specified custom communication order, used for communication between users and administrators. Notes This interface uses the POST method, requires data to be submitted in application/ format, requires user login to access, can only send messages to orders belonging to the current user, supports various message types: text, images, quotes, videos, files, etc., request address {domain address}/api/communication/message/send Note: {domain address} needs to be replaced with your domain address, such as -
Get product/order evaluation list interface
Get the product or order review list, supporting filtering and pagination by product, user, and other conditions. -
Post product/order evaluation interface
Allow users to review purchased products or orders, supporting text reviews, ratings, and image uploads. Notes The API uses the POST method, requires data to be submitted in application/ format, and needs to provide the document ID and review content. Supports logged-in users and non-logged-in users (non-logged-in users need to provide a username). Can associate reviews with specific orders via order ID. Supports a 1-5 point rating system. Supports uploading multiple review images. Reviews need to be approved before they can be displayed. Request address