partnerDeclineOrderRequest

Requires permission sales:sales_order:approve.

Decline one of a customer account's parked over-limit checkouts from the SELLER's console, with an optional reason the buyer sees. Terminal. Errors: APPROVAL_NOT_PENDING.

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 PartnerDeclineOrderRequest($partnerId: ID!, $requestId: ID!) {
  partnerDeclineOrderRequest(partnerId: $partnerId, requestId: $requestId) {
    orderNumber
    orderId
    request {
      id
      poNumber
      requestNumber
      resultingOrderNumber
      companyName
      decidedByName
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation PartnerDeclineOrderRequest($partnerId: ID!, $requestId: ID!) {\n  partnerDeclineOrderRequest(partnerId: $partnerId, requestId: $requestId) {\n    orderNumber\n    orderId\n    request {\n      id\n      poNumber\n      requestNumber\n      resultingOrderNumber\n      companyName\n      decidedByName\n    }\n  }\n}",
  "variables": {
    "partnerId": "id",
    "requestId": "id"
  }
}
EOF

Variables:

{
  "partnerId": "id",
  "requestId": "id"
}

Response:

{
  "data": {
    "partnerDeclineOrderRequest": {
      "orderNumber": "string",
      "orderId": "id",
      "request": {
        "id": "id",
        "poNumber": "string",
        "requestNumber": "string",
        "resultingOrderNumber": "string",
        "companyName": "string",
        "decidedByName": "string"
      }
    }
  }
}

partnerDeclineOrderRequest(
  partnerId: ID!
  reason: String
  requestId: ID!
): CustomerApprovalDecisionResult!

Arguments

partnerDeclineOrderRequest.partnerId ● ID! non-null scalar

The ID of the partner.

partnerDeclineOrderRequest.reason ● String scalar

Why the request is declined.

partnerDeclineOrderRequest.requestId ● ID! non-null scalar

The ID of the approval request.

Type

CustomerApprovalDecisionResult object

Result of an approve/decline decision. orderId/orderNumber set on approve.