### Self-Pickup and Verification API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing self-pickup orders and verification processes, including creating pickup points and querying verification records. ```APIDOC ## Self-Pickup and Verification API ### Description APIs for managing self-pickup orders and verification processes, including creating pickup points and querying verification records. ### Endpoints #### Verify in-store pickup order * **Method**: POST * **Endpoint**: `/pickup/verify_order` * **Description**: Verifies an order designated for in-store pickup. #### Query list of pickup point cities * **Method**: GET * **Endpoint**: `/pickup/cities` * **Description**: Retrieves a list of cities where pickup points are available. #### Create pickup point * **Method**: POST * **Endpoint**: `/pickup/points` * **Description**: Creates a new pickup point. * **Request Body**: * `name` (string) - Required - The name of the pickup point. * `address` (string) - Required - The address of the pickup point. * `city` (string) - Required - The city where the pickup point is located. #### Query pickup point details by ID * **Method**: GET * **Endpoint**: `/pickup/points/{point_id}` * **Description**: Retrieves detailed information for a specific pickup point using its ID. #### Batch query pickup point details * **Method**: GET * **Endpoint**: `/pickup/points/batch?ids={ids}` * **Description**: Retrieves detailed information for multiple pickup points in a batch. #### Update pickup point * **Method**: PUT * **Endpoint**: `/pickup/points/{point_id}` * **Description**: Updates the information for an existing pickup point. #### Delete pickup point * **Method**: DELETE * **Endpoint**: `/pickup/points/{point_id}` * **Description**: Deletes a pickup point. #### Query self-pickup code details * **Method**: GET * **Endpoint**: `/pickup/code/{code_id}` * **Description**: Retrieves details for a self-pickup code. #### Query self-pickup verification records * **Method**: GET * **Endpoint**: `/pickup/verification_records` * **Description**: Retrieves records of self-pickup verifications. #### Verify self-pickup order by order number * **Method**: POST * **Endpoint**: `/pickup/verify_by_order` * **Description**: Verifies a self-pickup order using its order number. ``` -------------------------------- ### Order Placement and Payment API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for handling the order placement and payment process, including multi-item checkout, single-item checkout, and payment callback notifications. ```APIDOC ## Order Placement and Payment API ### Description APIs for handling the order placement and payment process, including multi-item checkout, single-item checkout, and payment callback notifications. ### Endpoints #### Multi-item checkout entry * **Method**: POST * **Endpoint**: `/checkout/multi_item` * **Description**: Initiates the checkout process for multiple items, leading to the settlement page. #### Single item checkout * **Method**: POST * **Endpoint**: `/checkout/single_item` * **Description**: Handles the checkout process for a single item, allowing the buyer to place an order. #### Cross-shop order creation * **Method**: POST * **Endpoint**: `/order/cross_shop/create` * **Description**: Creates an order that spans across different shops. #### Send payment callback message * **Method**: POST * **Endpoint**: `/payment/callback/message` * **Description**: Sends a message to notify about the payment callback. ### Extensions #### Go to payment extension point * **Description**: Allows customization of the process leading to payment. #### Order creation custom validation extension point * **Description**: Enables custom validation logic during order creation. #### Additional fee calculation extension point * **Description**: Provides a point to calculate additional fees for an order. #### Payment success page jump link customization extension point * **Description**: Allows customization of the redirect link after successful payment. #### Cross-border tax calculation extension point * **Description**: Handles tax calculations for cross-border orders. #### Points deduction order placement extension point * **Description**: Integrates point deduction functionality into the order placement process. #### Order page pickup point extension point * **Description**: Customizes the pickup point selection during the order placement process. ``` -------------------------------- ### Electronic Manifest API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing electronic manifests, including ordering numbers, printing templates, and querying manifest information. ```APIDOC ## Electronic Manifest API ### Description APIs for managing electronic manifests, including ordering numbers, printing templates, and querying manifest information. ### Endpoints #### Query merchant and logistics provider order relationship for electronic manifests * **Method**: GET * **Endpoint**: `/manifest/provider_relationship` * **Description**: Queries the subscription relationship between a merchant and an electronic manifest logistics provider. #### Query available value-added services for merchant's electronic manifests * **Method**: GET * **Endpoint**: `/manifest/value_added_services` * **Description**: Retrieves a list of available value-added services for the merchant's electronic manifests. #### Batch obtain electronic manifest numbers * **Method**: POST * **Endpoint**: `/manifest/batch_get_number` * **Description**: Requests a batch of electronic manifest numbers for shipments. #### Query electronic manifest print template * **Method**: GET * **Endpoint**: `/manifest/print_template` * **Description**: Retrieves the print template for electronic manifests. #### Query electronic manifest print message * **Method**: GET * **Endpoint**: `/manifest/print_message` * **Description**: Retrieves the message content used for printing electronic manifests. #### Update electronic manifest * **Method**: PUT * **Endpoint**: `/manifest/{manifest_id}` * **Description**: Updates information for an existing electronic manifest. #### Cancel electronic manifest * **Method**: DELETE * **Endpoint**: `/manifest/{manifest_id}` * **Description**: Cancels an electronic manifest. #### Query electronic manifest information * **Method**: GET * **Endpoint**: `/manifest/{manifest_id}` * **Description**: Retrieves detailed information for an electronic manifest. #### Electronic manifest third-party channel interface service for printing * **Method**: POST * **Endpoint**: `/manifest/print_proxy` * **Description**: A proxy service for printing electronic manifests through third-party channels. ``` -------------------------------- ### Shop Employee Management API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing shop employees, including creating, updating, deleting, enabling, disabling, and querying employee information. ```APIDOC ## Shop Employee Management API ### Description This section details the APIs for managing shop employees. It covers operations such as adding new employees, updating their details, deactivating or activating accounts, and retrieving employee lists or individual employee information. ### Endpoints #### Employee Update - **Method**: PUT - **Endpoint**: `/api/shop/employees/{employeeId}` - **Description**: Updates an existing employee's information. #### Add Employee - **Method**: POST - **Endpoint**: `/api/shop/employees` - **Description**: Adds a new employee to the shop. #### Employee Deletion - **Method**: DELETE - **Endpoint**: `/api/shop/employees/{employeeId}` - **Description**: Deletes an employee record. #### Employee Deactivation - **Method**: POST - **Endpoint**: `/api/shop/employees/{employeeId}/deactivate` - **Description**: Deactivates an employee account. #### Employee Activation - **Method**: POST - **Endpoint**: `/api/shop/employees/{employeeId}/activate` - **Description**: Activates a previously deactivated employee account. #### Paginated Employee Query - **Method**: GET - **Endpoint**: `/api/shop/employees/paginated` - **Description**: Retrieves a paginated list of shop employees. #### Query Single Employee Details - **Method**: GET - **Endpoint**: `/api/shop/employees/{employeeId}` - **Description**: Retrieves detailed information for a specific employee. #### Query Same-City Cloud Network Employees Role - **Method**: GET - **Endpoint**: `/api/shop/employees/cloud_network_roles` - **Description**: Queries the roles of employees within the same-city cloud network. #### Create Employee (Synchronous Creation) - **Method**: POST - **Endpoint**: `/api/shop/employees/sync_create` - **Description**: Creates an employee with synchronous creation logic. #### Paginated Employee Details Query - **Method**: GET - **Endpoint**: `/api/shop/employees/details/paginated` - **Description**: Retrieves a paginated list of detailed employee information. #### Batch Query Shop Employee Unique IDs - **Method**: POST - **Endpoint**: `/api/shop/employees/batch_unique_ids` - **Description**: Retrieves a list of unique IDs for multiple shop employees in a batch. ### Employee Change Message - **Method**: POST - **Endpoint**: `/api/shop/employees/messages/change` - **Description**: Receives messages regarding changes in employee information. ### Employee Deactivation/Activation Message - **Method**: POST - **Endpoint**: `/api/shop/employees/messages/status_change` - **Description**: Receives messages related to employee account deactivation or activation. ``` -------------------------------- ### Account Management API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing user accounts, including obtaining YouZan openId, querying user information, updating user details, and handling user login status. ```APIDOC ## Account Management API ### Description This section covers APIs related to account management within the YouZan platform. It includes functionalities for retrieving unique identifiers, querying and updating user information, and managing user sessions. ### Endpoints #### Get YouZan OpenID - **Method**: GET - **Endpoint**: `/api/users/youzan_openid` - **Description**: Retrieves the YouZan OpenID for a given user. #### User Query - **Method**: GET - **Endpoint**: `/api/users/query` - **Description**: Queries user information based on various criteria. #### Update User Profile - **Method**: PUT - **Endpoint**: `/api/users/{userId}/profile` - **Description**: Updates a user's profile information, such as avatar and nickname for mini-programs. #### Check for YouZan Account - **Method**: GET - **Endpoint**: `/api/users/exists` - **Description**: Checks if a YouZan account exists for a given identifier. #### Clear User Login Status - **Method**: POST - **Endpoint**: `/api/users/clear_login_status` - **Description**: Clears the login status for a specified user. #### Get YZ OpenID by UnionID - **Method**: GET - **Endpoint**: `/api/users/yz_openid_by_unionid` - **Description**: Retrieves the YouZan OpenID using the platform's UnionID. #### Get YZ OpenID by Third-Party User ID - **Method**: GET - **Endpoint**: `/api/users/yz_openid_by_third_party` - **Description**: Retrieves the YouZan OpenID using a user ID from a third-party platform. #### Get Platform Account Info - **Method**: GET - **Endpoint**: `/api/users/platform_account_info` - **Description**: Retrieves information about a user's platform account. #### Get User Info - **Method**: GET - **Endpoint**: `/api/users/info` - **Description**: Retrieves general user information. ### WeChat Related APIs #### Get YouZan OpenID by WeChat OpenID - **Method**: GET - **Endpoint**: `/api/wechat/youzan_openid` - **Description**: Retrieves the YouZan OpenID corresponding to a WeChat OpenID. #### Get WeChat OpenID by Phone or YouZan OpenID - **Method**: GET - **Endpoint**: `/api/wechat/openid` - **Description**: Retrieves the WeChat OpenID using a phone number or YouZan OpenID. #### Batch Query WeChat Fans by Follow Time - **Method**: GET - **Endpoint**: `/api/wechat/fans/batch_query` - **Description**: Batch queries WeChat fan user information based on a specified follow time range. ``` -------------------------------- ### After-sales and Refund API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing after-sales requests and refunds, including querying refund details, applying for refunds, and processing seller actions. ```APIDOC ## After-sales and Refund API ### Description APIs for managing after-sales requests and refunds, including querying refund details, applying for refunds, and processing seller actions. ### Endpoints #### Query single after-sales order details * **Method**: GET * **Endpoint**: `/after_sale/{after_sale_id}` * **Description**: Retrieves detailed information for a specific after-sales order. #### Query refund voucher list * **Method**: GET * **Endpoint**: `/refund/vouchers` * **Description**: Retrieves a list of refund vouchers. #### Buyer applies for refund * **Method**: POST * **Endpoint**: `/refund/apply` * **Description**: Allows a buyer to apply for a refund. * **Request Body**: * `order_id` (string) - Required - The ID of the order for which the refund is requested. * `reason` (string) - Required - The reason for the refund request. * `amount` (number) - Required - The refund amount. #### Seller initiates refund * **Method**: POST * **Endpoint**: `/refund/seller_initiate` * **Description**: Seller initiates a refund process. #### Seller initiates return and refund * **Method**: POST * **Endpoint**: `/refund/seller_return` * **Description**: Seller initiates a process for returning goods and issuing a refund. #### Buyer withdraws refund application * **Method**: POST * **Endpoint**: `/refund/withdraw_application` * **Description**: Buyer withdraws their refund application. #### Query sales refund orders * **Method**: GET * **Endpoint**: `/sales_refund/query` * **Description**: Retrieves sales refund orders. #### Batch query refund orders * **Method**: GET * **Endpoint**: `/refunds/batch` * **Description**: Retrieves a list of refund orders based on specified criteria. #### View refund list * **Method**: GET * **Endpoint**: `/refunds` * **Description**: Retrieves a list of all refund orders. #### Seller processes after-sales order (audit) * **Method**: PUT * **Endpoint**: `/after_sale/{after_sale_id}/audit` * **Description**: Seller performs an audit action on an after-sales order. * **Request Body**: * `status` (string) - Required - The audit status (e.g., 'approved', 'rejected'). #### Buyer confirms receipt for exchange order * **Method**: POST * **Endpoint**: `/exchange_order/confirm_receipt` * **Description**: Buyer confirms receipt of goods for an exchange order. ### Messages * **Refund Created**: Notification when a refund request is created. * **Seller Agrees Refund**: Message when the seller approves a refund request. * **Seller Rejects Refund**: Notification when the seller rejects a refund request. * **Buyer Applies for Customer Service Intervention**: Message when a buyer requests intervention from customer service. * **Buyer Returns Goods to Seller**: Notification when a buyer ships returned goods to the seller. * **Seller Confirms Receipt**: Message when the seller confirms receipt of returned goods. * **Refund Successful**: Notification when a refund has been successfully processed. * **Refund Closed**: Message indicating a refund process has been closed. * **Retail Exchange Completed**: Notification for the completion of a retail exchange. ### Extensions #### Refund custom validation extension point * **Description**: Allows for custom validation logic during the refund process. #### Refundable amount calculation extension point * **Description**: Provides a point to calculate the eligible refund amount. #### Refunded funds extension point * **Description**: Handles the extension logic for processing refunded funds. #### Refund extension point * **Description**: General extension point for refund-related operations. #### Refund query extension point * **Description**: Allows customization of refund queries. ``` -------------------------------- ### Order Management API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing orders, including querying order details, updating order status, handling returns, and managing remarks and addresses. ```APIDOC ## Order Management API ### Description APIs for managing orders, including querying order details, updating order status, handling returns, and managing remarks and addresses. ### Endpoints #### Query single transaction details * **Method**: GET * **Endpoint**: `/order/{order_id}` * **Description**: Retrieves detailed information for a specific transaction or order. #### Batch query orders * **Method**: GET * **Endpoint**: `/orders/batch` * **Description**: Retrieves a list of orders based on specified criteria. #### Seller reject order * **Method**: POST * **Endpoint**: `/order/{order_id}/reject` * **Description**: Allows the seller to reject an order. #### Star order * **Method**: POST * **Endpoint**: `/order/{order_id}/star` * **Description**: Marks an order with a star for special attention. #### Add/Modify order remarks * **Method**: PUT * **Endpoint**: `/order/{order_id}/remarks` * **Description**: Adds or modifies remarks for an order. * **Request Body**: * `remarks` (string) - Required - The remarks to add or modify. #### Confirm check-in for hotel orders * **Method**: POST * **Endpoint**: `/hotel_order/{order_id}/check_in` * **Description**: Confirms check-in for a hotel-related order. #### Query corresponding E-order number by V-order number * **Method**: GET * **Endpoint**: `/order/v_to_e?v_order_no={v_order_no}` * **Description**: Retrieves the E-order number associated with a given V-order number. #### Update order shipping address * **Method**: PUT * **Endpoint**: `/order/{order_id}/shipping_address` * **Description**: Updates the shipping address for an order. * **Request Body**: * `address` (object) - Required - The new shipping address details. #### Hide order from buyer * **Method**: PUT * **Endpoint**: `/order/{order_id}/hide` * **Description**: Hides an order from the buyer's view. #### Update order extension fields * **Method**: PUT * **Endpoint**: `/order/{order_id}/extension_fields` * **Description**: Updates custom extension fields for an order. #### Seller accepts order for hotel orders * **Method**: POST * **Endpoint**: `/hotel_order/{order_id}/accept` * **Description**: Seller accepts a hotel order. #### Query distribution purchase order details * **Method**: GET * **Endpoint**: `/purchase_order/distribution/{purchase_order_id}` * **Description**: Retrieves details for a distribution purchase order. #### Query exchange order * **Method**: GET * **Endpoint**: `/exchange_order?order_id={order_id}` * **Description**: Retrieves information about an exchange order. #### Query periodic purchase configuration information * **Method**: GET * **Endpoint**: `/periodic_purchase/config?order_id={order_id}&order_detail_id={order_detail_id}` * **Description**: Gets configuration details for periodic purchase orders. #### Order price adjustment * **Method**: PUT * **Endpoint**: `/order/{order_id}/price` * **Description**: Adjusts the price of an order. #### Update sales delivery order preparation status * **Method**: PUT * **Endpoint**: `/sales_delivery_order/{delivery_id}/preparation_status` * **Description**: Updates the preparation status of a sales delivery order. #### Verify virtual product * **Method**: POST * **Endpoint**: `/virtual_product/verify` * **Description**: Verifies a virtual product, likely for redemption or confirmation. #### Get information for virtual product code * **Method**: GET * **Endpoint**: `/virtual_product/code_info?code={code}` * **Description**: Retrieves information related to a virtual product's redemption code. #### Query virtual product verification records * **Method**: GET * **Endpoint**: `/virtual_product/verification_records` * **Description**: Retrieves records of virtual product verifications. #### Get order discount information * **Method**: GET * **Endpoint**: `/order/{order_id}/discounts` * **Description**: Retrieves information about discounts applied to an order. #### External order creation * **Method**: POST * **Endpoint**: `/external_order/create` * **Description**: Creates an order from an external source. #### External order payment * **Method**: POST * **Endpoint**: `/external_order/pay` * **Description**: Processes payment for an external order. #### Transition order to transaction completion (for specific clients) * **Method**: PUT * **Endpoint**: `/order/{order_id}/complete` * **Description**: Transitions an order to a completed transaction status. Requires whitelisting. ### Messages * **Transaction Created**: Notification for when a transaction is successfully created. * **Transaction Paid**: Notification when a transaction has been paid. * **Order Settled**: Message indicating that an order has been settled. * **Deposit Pre-sale Order Deposit Paid**: Notification for deposit payment on pre-sale orders. * **Seller Shipped**: Message sent when the seller has shipped the order. * **Seller Partially Shipped**: Notification when only part of an order has been shipped. * **Transaction Success**: Message indicating the successful completion of a transaction. * **Transaction Closed**: Notification when a transaction has been closed. * **Buyer Paid (Seller Pending Shipment)**: Indicates the buyer has paid and the seller needs to ship. * **Buyer Deleted Order**: Notification when a buyer deletes an order. * **Seller Modified Transaction Remarks**: Message when the seller modifies order remarks. * **Seller Modified Buyer Shipping Address**: Notification when the seller changes the buyer's shipping address. * **Buyer Self-Modified Shipping Address**: Message when the buyer modifies their own shipping address. * **Virtual Product Verification**: Notification related to virtual product verification. * **Gift Order User Fills Shipping Address**: Message when a gift order recipient fills in their shipping address. ### Extensions #### Self-pickup verification extension point * **Description**: Allows for custom validation during self-pickup verification. ``` -------------------------------- ### Cart API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing the shopping cart, including adding, updating, and removing items, as well as querying cart contents. ```APIDOC ## Cart API ### Description APIs for managing the shopping cart, including adding, updating, and removing items, as well as querying cart contents. ### Endpoints #### Query cart items * **Method**: GET * **Endpoint**: `/cart/list` * **Description**: Queries the list of items currently in the shopping cart. #### Get cart item count * **Method**: GET * **Endpoint**: `/cart/count` * **Description**: Retrieves the total number of different item types in the shopping cart. #### Add item to cart * **Method**: POST * **Endpoint**: `/cart/add` * **Description**: Adds a specified item to the shopping cart. * **Request Body**: * `item_id` (integer) - Required - The ID of the item to add. * `quantity` (integer) - Required - The quantity of the item to add. #### Batch delete cart items * **Method**: DELETE * **Endpoint**: `/cart/batch_delete` * **Description**: Deletes multiple items from the shopping cart in a single request. * **Request Body**: * `item_ids` (array of integers) - Required - A list of item IDs to delete. #### Update cart item quantity * **Method**: PUT * **Endpoint**: `/cart/update_quantity` * **Description**: Updates the quantity of a specific item in the shopping cart. * **Request Body**: * `item_id` (integer) - Required - The ID of the item to update. * `quantity` (integer) - Required - The new quantity for the item. #### Select/Deselect all cart items * **Method**: PUT * **Endpoint**: `/cart/select_all` * **Description**: Selects or deselects all items in the shopping cart. * **Request Body**: * `selected` (boolean) - Required - `true` to select all, `false` to deselect all. #### Update cart item selection status * **Method**: PUT * **Endpoint**: `/cart/update_selection` * **Description**: Updates the selection status of specific items in the shopping cart. * **Request Body**: * `item_id` (integer) - Required - The ID of the item whose selection status to update. * `selected` (boolean) - Required - The new selection status (`true` or `false`). #### Cart item re-selection * **Method**: POST * **Endpoint**: `/cart/reselect` * **Description**: Allows re-selection of items within the cart, potentially for promotions or specific offers. ``` -------------------------------- ### Same-City Delivery API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing same-city delivery services, including calling third-party couriers, tracking status, and setting delivery preferences. ```APIDOC ## Same-City Delivery API ### Description APIs for managing same-city delivery services, including calling third-party couriers, tracking status, and setting delivery preferences. ### Endpoints #### Call same-city third-party delivery * **Method**: POST * **Endpoint**: `/same_city_delivery/call` * **Description**: Initiates a delivery request to a same-city third-party delivery service. #### Cancel same-city third-party delivery call * **Method**: POST * **Endpoint**: `/same_city_delivery/cancel` * **Description**: Cancels a previously initiated same-city delivery request. #### Same-city delivery status callback (for tool-based containers) * **Method**: POST * **Endpoint**: `/same_city_delivery/callback/status` * **Description**: Receives status updates for same-city deliveries; primarily for tool-based systems with containers. #### Get list of callable delivery companies * **Method**: GET * **Endpoint**: `/same_city_delivery/callable_couriers` * **Description**: Retrieves a list of delivery companies available for same-city delivery. #### Add tip * **Method**: POST * **Endpoint**: `/same_city_delivery/{order_id}/add_tip` * **Description**: Adds a tip to a same-city delivery order. #### Same-city delivery status synchronization (seller's own delivery) * **Method**: POST * **Endpoint**: `/same_city_delivery/sync_status` * **Description**: Synchronizes the delivery status from the seller's internal system to Youzan for same-city deliveries handled by the seller. #### Set merchant's same-city multi-area and timed delivery information * **Method**: PUT * **Endpoint**: `/same_city_delivery/settings` * **Description**: Configures settings for same-city delivery, including multiple service areas and timed delivery options. #### Re-delivery * **Method**: POST * **Endpoint**: `/same_city_delivery/{order_id}/redeliver` * **Description**: Initiates a re-delivery attempt for a same-city delivery order. #### Get cancellation reason list * **Method**: GET * **Endpoint**: `/same_city_delivery/cancel_reasons` * **Description**: Retrieves a list of valid reasons for canceling a same-city delivery. ### Extensions #### Same-city delivery custom validation extension point * **Description**: Allows for custom validation logic specific to same-city deliveries. #### Same-city delivery consumer freight calculation extension point * **Description**: Customizes the calculation of freight for consumers in same-city deliveries. #### Same-city delivery freight calculation extension point * **Description**: Provides a point for calculating freight costs for same-city deliveries. #### Same-city delivery order cancellation extension point * **Description**: Handles custom logic when a same-city delivery order is canceled. #### Same-city delivery submission for review extension point * **Description**: Customizes the process of submitting same-city delivery information for review. #### Same-city confirmation of order placement service * **Description**: Handles the service confirmation for placing same-city orders. #### Query same-city store audit information * **Description**: Retrieves audit information for stores involved in same-city delivery. #### Get order penalty * **Description**: Retrieves penalty information for same-city delivery orders. #### Same-city delivery add tip extension point * **Description**: Handles adding tips to same-city deliveries through an extension. #### Get same-city order logistics details information * **Description**: Retrieves detailed logistics information for same-city orders. #### Same-city delivery pre-order placement extension point * **Description**: Allows pre-order placement logic customization for same-city deliveries. ``` -------------------------------- ### Logistics and Shipping API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing logistics and shipping, including order fulfillment, delivery status updates, and management of shipping templates. ```APIDOC ## Logistics and Shipping API ### Description APIs for managing logistics and shipping, including order fulfillment, delivery status updates, and management of shipping templates. ### Endpoints #### Order fulfillment * **Method**: POST * **Endpoint**: `/order/{order_id}/deliver` * **Description**: Marks an order as fulfilled and provides shipping details. * **Request Body**: * `tracking_number` (string) - Required - The tracking number for the shipment. * `courier_company` (string) - Required - The name of the courier company. #### Single item split shipment * **Method**: POST * **Endpoint**: `/order/{order_id}/split_ship` * **Description**: Allows a single item within an order to be shipped with multiple tracking numbers or shipments. #### Single item partial shipment * **Method**: POST * **Endpoint**: `/order/{order_id}/partial_ship` * **Description**: Handles partial shipment of an order where only some items are shipped initially. #### Modify logistics information * **Method**: PUT * **Endpoint**: `/shipment/{shipment_id}/logistics` * **Description**: Updates the logistics information for an existing shipment. #### Extend order receipt time * **Method**: POST * **Endpoint**: `/order/{order_id}/extend_receipt` * **Description**: Allows the buyer or seller to extend the time for confirming receipt of an order. #### Get list of courier companies * **Method**: GET * **Endpoint**: `/couriers` * **Description**: Retrieves a list of supported courier companies. #### Get regional place name list * **Method**: GET * **Endpoint**: `/regions/names` * **Description**: Retrieves a list of regional place names for address input. #### Seller marks as signed * **Method**: POST * **Endpoint**: `/shipment/{shipment_id}/mark_signed` * **Description**: Seller marks a shipment as signed/delivered. #### Periodic purchase - Ship multiple installments at once * **Method**: POST * **Endpoint**: `/periodic_purchase/{order_id}/multi_installment_ship` * **Description**: Handles shipping for multiple installments of a periodic purchase order simultaneously. #### Query latest installment shipping record * **Method**: GET * **Endpoint**: `/periodic_purchase/{order_id}/latest_shipment` * **Description**: Retrieves the shipping record for the most recent installment of a periodic purchase. #### Delivery method settings * **Method**: PUT * **Endpoint**: `/delivery_settings` * **Description**: Configures delivery methods for orders. #### Query periodic purchase shipping records * **Method**: GET * **Endpoint**: `/periodic_purchase/{order_id}/shipment_records` * **Description**: Retrieves all shipping records for a periodic purchase order. #### Get same-city timed delivery information * **Method**: GET * **Endpoint**: `/same_city_delivery/{order_id}/info` * **Description**: Retrieves information related to same-city timed delivery for an order. #### Query shipment order * **Method**: GET * **Endpoint**: `/shipments/query?order_id={order_id}` * **Description**: Retrieves details about a shipment order. #### Query delivery order information * **Method**: GET * **Endpoint**: `/delivery_orders/query?delivery_order_id={delivery_order_id}` * **Description**: Retrieves information about a specific delivery order. #### Query all package details for an order * **Method**: GET * **Endpoint**: `/order/{order_id}/packages` * **Description**: Retrieves details for all packages associated with an order. #### Batch query all package details for an order * **Method**: GET * **Endpoint**: `/orders/packages/batch?order_ids={order_ids}` * **Description**: Retrieves details for all packages across multiple orders. #### Get logistics and courier information * **Method**: GET * **Endpoint**: `/shipment/{shipment_id}/tracking` * **Description**: Retrieves tracking information for a shipment. #### Modify delivery plan * **Method**: PUT * **Endpoint**: `/delivery_plan/{plan_id}` * **Description**: Modifies an existing delivery plan. ### Extensions #### Shipping business validation extension point * **Description**: Allows for custom validation logic during the shipping process. ``` -------------------------------- ### Electronic Invoice API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing electronic invoices, including receiving invoice results and handling invoice application messages. ```APIDOC ## Electronic Invoice API ### Description APIs for managing electronic invoices, including receiving invoice results and handling invoice application messages. ### Endpoints #### Invoice result callback * **Method**: POST * ``` -------------------------------- ### Enterprise WeChat Assistant API Source: https://doc.youzanyun.com/v2/doc/cloud/token/RsS0wO4sWiOHTpk6KJCczq2xnic APIs for managing enterprise WeChat assistant features, including customer management, group chat management, and message notifications. ```APIDOC ## Enterprise WeChat Assistant API ### Description This section provides documentation for the Enterprise WeChat Assistant APIs, which facilitate interactions with WeChat Work. It includes functionalities for customer management, group chat operations, tag management, and sending various types of messages. ### Endpoints #### Paginated Query Enterprise Assistant Employee List - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/employees/paginated` - **Description**: Retrieves a paginated list of enterprise assistant employees. #### Get Enterprise WeChat Customer ID - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customers/id` - **Description**: Retrieves the Enterprise WeChat customer ID. #### Get YouZan Account by Enterprise WeChat Customer ID - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customers/youzan_account` - **Description**: Retrieves the YouZan open account associated with an Enterprise WeChat customer ID. #### Query Customer Relationship - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customer_relationship/query` - **Description**: Queries the relationship details of a customer. #### Get Customer Relationship List - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customer_relationships` - **Description**: Retrieves a list of customer relationships. #### Get Customer Relationship Flow - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customer_relationship/flow` - **Description**: Retrieves the flow of customer relationship events. #### Get Customer Group Details - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customer_groups/details` - **Description**: Retrieves detailed information about customer groups. #### Get Customer Group List - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customer_groups/list` - **Description**: Retrieves a list of customer groups. #### Get Customer Group Member Details - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/customer_groups/members/details` - **Description**: Retrieves detailed information about members within a customer group. #### Get Shop's All Customer Group Details - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/shop_customer_groups/details` - **Description**: Retrieves details for all customer groups belonging to the shop. #### Get Enterprise Assistant Tag List - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/tags` - **Description**: Retrieves the list of tags managed by the enterprise assistant. #### Create Unified Customer Group Sending Task - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/customer_groups/sending_tasks` - **Description**: Creates a unified task for sending messages to customer groups. #### Send Employee Work Reminder Message - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/messages/work_reminder` - **Description**: Sends a work reminder message to an employee. #### Send Card Type Employee Work Reminder Message - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/messages/card_work_reminder` - **Description**: Sends a work reminder message in a card format to an employee. #### Query QR Code Details (Personal, Group, Deduplication) - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/qr_codes/details` - **Description**: Queries details for QR codes, supporting personal, group, and deduplication types. #### Create "Contact Me" Method - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/contact_me` - **Description**: Creates a "Contact Me" method for users. #### Query "Contact Me" Details - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/contact_me/details` - **Description**: Retrieves the details of a "Contact Me" method. #### Modify "Contact Me" Method - **Method**: PUT - **Endpoint**: `/api/enterprise_wechat/contact_me` - **Description**: Modifies an existing "Contact Me" method. #### Delete "Contact Me" Method - **Method**: DELETE - **Endpoint**: `/api/enterprise_wechat/contact_me` - **Description**: Deletes a "Contact Me" method. ### Message Notifications #### Customer Relationship Creation Message - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/messages/customer_relationship_created` - **Description**: Receives notifications for customer relationship creation events. #### Customer Relationship Churn Event (Customer Deletes Employee) - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/messages/customer_relationship_churn` - **Description**: Receives notifications for customer relationship churn events initiated by customer deletion of an employee. #### Employee Deletes Customer Event - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/messages/employee_deletes_customer` - **Description**: Receives notifications when an employee deletes a customer. #### Customer Group (External Group) or Group Member Change - **Method**: POST - **Endpoint**: `/api/enterprise_wechat/messages/group_member_change` - **Description**: Receives notifications for changes in customer groups or their members. ### Extension Points #### Get Third-Party Custom Welcome Message Content - **Method**: GET - **Endpoint**: `/api/enterprise_wechat/extension/welcome_message` - **Description**: Retrieves the content for custom welcome messages from third-party sources. ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.