placeOrder

Requires a customer (portal or buyer app) session.

Place a Cash-on-Delivery order. Network retries must reuse the same idempotencyKey — server returns the previously created order.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation PlaceOrder($input: PlaceOrderInput!) {
  placeOrder(input: $input) {
    id
    orderNumber
    paymentNumber
    salesRepName
    status
    addressId
    amendment {
      canChangeAddress
      canChangePaymentMethod
      canEditItems
      lockReason
      paymentMethodLockReason
      version
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation PlaceOrder($input: PlaceOrderInput!) {\n  placeOrder(input: $input) {\n    id\n    orderNumber\n    paymentNumber\n    salesRepName\n    status\n    addressId\n    amendment {\n      canChangeAddress\n      canChangePaymentMethod\n      canEditItems\n      lockReason\n      paymentMethodLockReason\n      version\n    }\n  }\n}",
  "variables": {
    "input": {
      "addressId": "id",
      "idempotencyKey": "string"
    }
  }
}
EOF

Variables:

{
  "input": {
    "addressId": "id",
    "idempotencyKey": "string"
  }
}

Response:

{
  "data": {
    "placeOrder": {
      "id": "id",
      "orderNumber": "string",
      "paymentNumber": "string",
      "salesRepName": "string",
      "status": "AWAITING_PAYMENT",
      "addressId": "id",
      "amendment": {
        "canChangeAddress": true,
        "canChangePaymentMethod": true,
        "canEditItems": true,
        "lockReason": "string",
        "paymentMethodLockReason": "string",
        "version": 0
      }
    }
  }
}

placeOrder(
  input: PlaceOrderInput!
): MobileOrder!

Arguments

placeOrder.input ● PlaceOrderInput! non-null input

The details of the place order request.

Type

MobileOrder object

Order placed via the mobile BFF. v1 is COD only; persisted in Redis until SalesOrder wiring lands.