API overview
API standards and multilingual preset SDKs
The OpenAPI of this product (linkedmall/2023-09-30) uses the ROA signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Procurement store
|
API |
Title |
Description |
| ListPurchaserShops | Obtain the list of purchaser shops | Lists purchaser shops. |
| GetPurchaserShop | Obtain the purchaser's store | Retrieves the purchaser's shop. |
Product
|
API |
Title |
Description |
| GetSelectionProduct | Query product details in the selection pool | Query the details of a product in the selection pool. |
| ListSelectionProducts | Query Product List in the Selection Pool | Retrieves a list of products from a product selection pool. |
| GetSelectionProductSaleInfo | Query Product sales information in the selection pool | Queries sales information for products in the selection pool. |
| ListSelectionProductSaleInfos | Batch query the sales information of Products in the selection pool | Query product sales information for the selection pool in batches. |
| ListSelectionSkuSaleInfos | Batch query sales information of SKUs in the product selection pool | Query SKU sales information for items in the selection pool in batch. |
| ListCategories | Query Category List | Lists categories. |
| SearchProducts | Search Product Selection Pool Products | The product search API is a paginated interface for searching products based on various criteria. |
| SelectionGroupAddProduct | Warehousing Products from the Product Selection Pool | The distributor takes delivery of goods. |
| SelectionGroupRemoveProduct | Product Outbound from Selection Pool | Removes products from a distributor's stock. |
Purchase order
|
API |
Title |
Description |
| SplitPurchaseOrder | Render and Split Purchase Order | Splits a purchase order and renders the resulting parent-child order structure. This API returns a list of items based on the final parent-child order structure. Distributors can use this response to render the final parent-child order layout, which simplifies receiving the purchase order creation success message and backfilling parent-child order information later. |
| RenderPurchaseOrder | Purchase Order Rendering | Renders a purchase order and returns both sellable and unsellable products. Customers can then select the sellable products to place their orders. |
| CreatePurchaseOrder | Create Purchase Order | Creates a purchase order and returns the purchase order ID. The specific result of order creation is communicated through messages. After the order is created, you can query the order details associated with the purchase order using the order API. |
| GetPurchaseOrderStatus | Obtain the purchase order status | Retrieve the purchase order status. |
Order
|
API |
Title |
Description |
| GetOrder | Obtain order details | Queries the details of an order. |
| QueryOrders | Query the order list | Queries a list of orders. |
| ListLogisticsOrders | Query order logistics information | Query logistics information for an order. |
| ConfirmDisburse | Confirm receipt of goods | Confirms the receipt of goods. |
After-sales order
|
API |
Title |
Description |
| RenderRefundOrder | After-sales order rendering | Reverse Single Rendering |
| CreateRefundOrder | Create a return order | Create a support ticket. |
| CancelRefundOrder | Cancel the after-sales order | Cancels a refund order. |
| GetRefundOrder | Obtain after-sales ticket details | Retrieve details of an after-sales order. |
| CreateGoodsShippingNotice | Backfill Waybill Information | Backfill shipping notice information. |
Region code
|
API |
Title |
Description |
| QueryChildDivisionCode | Query sub-area encoding | Queries child division codes. |