CreatePurchaseOrder

Updated at:

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.

Operation description

Creates a purchase order and returns the purchase order ID. Messages communicate the specific result of order creation. After the order is created, you can query the order details associated with the purchase order using the order API.

Warning Note: Purchase order creation is an asynchronous task. If a distributor calls this API and receives an abnormal status (such as error code 503), do not immediately process customer refunds. Distributors must wait for and consume the PurchaseOrderCreate message (the purchase order creation result message) to determine the order status—for example, by consuming the order status synchronization message—before proceeding with business logic. This prevents financial losses.
Important Note: If you do not receive the PurchaseOrderCreate message (the purchase order creation result message) after calling the purchase order creation API, submit a ticket to the technical support team to inquire about the cause.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

linkedmall:CreatePurchaseOrder

create

*All Resource

*

None None

Request syntax

POST /opensaas-s2b/opensaas-s2b-biz-trade/v2/purchaseOrders HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

body PurchaseOrderCreateCmd

Yes

Creates a purchase order.

{
  "outerPurchaseOrderId": "outer00****0",
  "deliveryAddress": {
    "divisionCode": "610102",
    "addressDetail": "Shaanxi Province, Xi'an City, *** Building",
    "receiverPhone": "187****1553",
    "receiver": "Mr. Yan",
    "townDivisionCode": "61010212"
  },
  "buyerId": "yt12345085",
  "productList": [
    {
      "quantity": 1,
      "productId": "6600622091****6736",
      "purchaserId": "PID2****09",
      "skuId": "6600622091****6737"
    }
  ]
}

Response elements

Element

Type

Description

Example

PurchaseOrderCreateResult

Purchase order creation result (returns the purchase order ID).

Warning Note: Purchase order creation is an asynchronous task. If a distributor calls this API and receives an abnormal status (such as error code 503), do not immediately process customer refunds. Distributors must wait for and consume the PurchaseOrderCreate message (purchase order creation result message) to determine the order status (for example, by consuming the order status synchronization message) before processing business logic. This prevents financial losses.

{
  "requestId": "48A34399-A72C-1E23-8388-7E63****E927",
  "purchaseOrderId": "6696070481****5680"
}

Examples

Success response

JSON format

{
  "purchaseOrderId": "6692****5696",
  "requestId": "841471F6-5D61-1331-8C38-2****B55"
}

Error codes

See Error CodesError Codes for a complete list.

Release notes

See Release NotesRelease Notes for a complete list.