Order interface

• Get user's delivery address interface

  Retrieve the delivery address information of the currently logged-in user, this interface will return the most recently used delivery address.

• Save user's delivery address interface

  Create or update the shipping address information for the user.

• Cancel order interface

  Cancel the user-specified order and update the order status to cancelled.

• Create Order Interface

  Create a user shopping order, supporting orders for a single item or multiple items, and allowing specification of shipping address, coupons, and other information. Notes: This interface uses the POST method and requires data to be submitted in application/ format. Access requires user login. The order status is pending payment, waiting for user payment. Orders can be created using item ID or item detail list. Coupons and specified shipping addresses are supported. Request address {domain_address}/api/order/create Note: {domain_address} needs to be replaced with your domain address

• Get Order Details Interface

  Retrieve detailed information of a specified order, including order status, product information, shipping address, and complete order data.

• 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. An order ID must be provided as the 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 become 'completed'. Request URL: {domain_address}/api/order/finish Note: {domain_address}

• Order Creation Payment Interface

  Create a payment for the pending order, supporting multiple payment methods including WeChat, WeChat Mini Program, Alipay, PayPal, and Stripe. Notes The interface uses the POST method and requires data to be submitted in application/ format. An order ID and payment method must be provided. Only logged-in users can call this interface. The order must be in the ”pending payment” status to create a payment. Payment information corresponding to different payment methods is returned (QR code, redirect link, or mini program payment parameters). Request address

• Order Refund Application Interface

  Allow users to apply for a refund for completed or paid orders, wait for the administrator to review and process the refund application after submitting the refund application. Notes This interface uses the POST method and requires data to be submitted in application/ format. The order ID must be provided 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 "in refund".

• Get Order List Interface

  Get the list of user's orders, supporting filtering by order status and pagination.

• Check If Order Is Paid Interface

  Check the payment status of the specified order, confirm whether the order has been paid.

• Get Order Statistics Interface

  Retrieve the order statistics for the current user, including the count of orders in various states.

• Get Order Statistics Chart Interface

  Retrieve order statistics chart data, supporting query of historical trends by different order statuses.

• Get Product Checkout Information Interface

  Retrieve product settlement information, supporting settlement for a single product or multiple products' orders, including discount calculation, address information, etc. Notes The interface uses the POST method and requires data to be submitted in application/ format Supports placing an order for a single product (through the parameters of goods_id, quantity, goods_sku_id) or multiple products (through the details parameter) Supports using coupons (coupon code or coupon ID) Requires user login verification Supports setting the recipient address and order notes Request URL

• Get Order Address List Interface

• Get Wish List List Interface

  Retrieve the current logged-in user's wishlist list, supporting pagination queries, and returning the user's favorite product information. Notes: This interface uses the GET method and does not require a request body. The user must be logged in, verified by session or Token. Supports pagination queries, which can be controlled by parameters to set the number of items per page and the current page number. Returns detailed information about the products in the wishlist, including price, notes, etc. Includes a comparison of the current price and the price at the time of addition. Request address {domain address}/api/wishlist/list Instructions: {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

  Remove 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. The wish list record ID must be provided. The user must be logged in and authenticated through session or Token. Only records belonging to the current user's wish list can be deleted. The deletion operation is irreversible, please operate with caution. Request address {domain_address}/api/wishlist/delete Note: {domain_address} needs to be replaced with your domain address, such as https

• Get Available Coupon List Interface

  Retrieve the list of coupons available to the current user in their current situation, which supports filtering by order amount and product ID. Notes: This interface is used to obtain the list of coupons available to the current user. Coupons suitable for orders of a specified amount can be filtered through the amount parameter. Coupons suitable for a specified product can be filtered through the archive_id parameter. It is necessary to log in as a user to obtain the list of coupons. 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 restrictions such as time range and usage conditions. Request address

• Get my coupon list interface

  Retrieve the list of coupons claimed by the current user, supporting pagination display and status filtering functions. Notes This API is used to obtain the coupon list information of the current user. Supports pagination query, which can be controlled by the current and pageSize parameters. Supports filtering coupons by status (unused, used, or all). User login is required to obtain the coupon list. Ensure that the domain address is correctly configured. The return result includes total information, which is convenient for front-end pagination processing. Request address {domain address}/api/coupon/codes Description

• Claim coupon interface

  Allow users to claim specified coupons by providing the coupon ID to obtain the coupon. Notes: This interface uses the POST method and requires data to be submitted in application/ format. A valid coupon ID must be provided. Users must be logged in to claim coupons. Coupons may have a limit on the number of claims or time restrictions. Ensure that the domain address is correctly configured. The same user may not be able to claim the same coupon repeatedly. Request address: {domain address}/api/coupon/code Note: {domain address}

• Get shopping cart list interface

• Add to shopping cart interface

  Add specified products to the shopping cart, supporting information such as product SKU, quantity, etc., 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 Supports logged-in users and non-logged-in users (identified by cart token) Must specify product ID and quantity Specific product specifications can be specified by 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 product from the shopping cart, delete the corresponding shopping cart record based on the cart ID. Notes: This interface uses the POST method and requires data to be submitted in application/ format. Provide the cart record ID instead of the product ID. Supports logged-in users and non-logged-in users (identified by cart token). Return a success message after deletion. Request URL {domain address}/api/cart/remove Note: {domain address} needs to be replaced with your domain address, such as

• Update Shopping Cart Interface

• Get Communication Custom Order Fields Interface

  Get information about available custom fields for communication custom orders, used to provide form fields when creating communication custom orders.

• Get Communication Custom Order List

  Retrieve the list information of user communication customized orders, supporting pagination queries.

• Create Communication Custom Order Interface

  Create a customized communication order for users to submit their customized requirements, waiting for confirmation from the merchant. Notes: This interface uses the POST method and requires data to be submitted in application/ format. Access requires user login. The created order needs to be confirmed by the merchant before entering the payment process. The order status is pending confirmation, waiting for the merchant to accept. Request address {domain_address}/api/communication/order/create Note: {domain_address} needs to be replaced with your domain address, such as https

• Get Communication Custom Order Details Interface

  Get detailed information of the customized communication order, including order status, communication records, etc.

• Update Communication Custom Order Interface

  Update the basic information of the customized order communication, including the title, content, and additional order information. Notes: This interface uses the POST method and requires data to be submitted in application/ format. Access requires user login. Only orders belonging to the current user can be updated. The Order ID is a required parameter and is used to specify the order to be updated. Request address {domain address}/api/communication/order/update Notes: {domain address} needs to be replaced with your domain address, such as https://www

• Communication Custom Order Quotation Acceptance Interface

  Caution: This interface uses the POST method and requires data to be submitted in application/ format. It requires user login to access. The order status is pending payment, waiting for user payment. Orders can be created by product ID or product detail list. This interface has the same parameters as the order creation interface and is specifically used for accepting custom orders. Request address {domain_address}/api/communication/order/accept Note: {domain_address} should be replaced with your domain address, such as https://www

• Get Communication Custom Order Communication Information List Interface

  Retrieve the communication record list for a specified customized order, supporting pagination query.

• Send Communication Custom Order Information Interface

  Send a message to the specified communication custom order, used for communication between users and administrators. Notes: This interface uses the POST method and requires data to be submitted in application/ format. Access requires user login. Messages can only be sent to orders belonging to the current user. Supports various message types: text, images, quotes, videos, files, etc. Request URL {domain_address}/api/communication/message/send Note: {domain_address} needs to be replaced with your domain address, such as

• Interface to get product/order evaluation list

  Retrieve the evaluation list of products or orders, supporting filtering and pagination by product, user, etc.

• Interface to publish product/order evaluation

  Allow users to review purchased products or orders, supporting text reviews, ratings, and image uploads. [Note] This interface uses the POST method and requires data to be submitted in application/ format. Provide the document ID and review content. Supports logged-in and non-logged-in users (non-logged-in users need to provide a username). Reviews can be associated with specific orders via order ID. Supports a 1-5 star rating system. Supports uploading multiple review images. Reviews need to be reviewed before they can be displayed. Request address

• Get User's Delivery Address List Interface

  Retrieve the list of all delivery addresses for the currently logged-in user.