reorderDeliveryPartners

Requires permission settings:integration:update.

Set the order of the delivery partners, top first. The order drives the partner list, the automatic partner-order rule and every tie-break. Partners you leave out keep their relative order after the listed ones. At most 200 partners, and one cannot appear twice.

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 ReorderDeliveryPartners($ids: [ID!]!) {
  reorderDeliveryPartners(ids: $ids) {
    id
    displayName
    available
    configuredSecretKeys
    environment
    isEnabled
    nonSecretValues {
      key
      value
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation ReorderDeliveryPartners($ids: [ID!]!) {\n  reorderDeliveryPartners(ids: $ids) {\n    id\n    displayName\n    available\n    configuredSecretKeys\n    environment\n    isEnabled\n    nonSecretValues {\n      key\n      value\n    }\n  }\n}",
  "variables": {
    "ids": [
      "id"
    ]
  }
}
EOF

Variables:

{
  "ids": [
    "id"
  ]
}

Response:

{
  "data": {
    "reorderDeliveryPartners": [
      {
        "id": "id",
        "displayName": "string",
        "available": true,
        "configuredSecretKeys": [
          "string"
        ],
        "environment": "LIVE",
        "isEnabled": true,
        "nonSecretValues": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      }
    ]
  }
}

reorderDeliveryPartners(
  ids: [ID!]!
): [DeliveryPartnerConfigGql!]!

Arguments

reorderDeliveryPartners.ids ● [ID!]! non-null scalar

The delivery partner configuration IDs in the new order.

Type

DeliveryPartnerConfigGql object

A delivery partner the organization has set up. Secret credentials are never returned.