Admin API/Common objects/Mutations

deliveryApiConnect

mutation

Connects (or re-keys) a delivery company by API: keys checked with the company, then kept by the service.

mutation DeliveryApiConnect($slug: String!) {
  deliveryApiConnect(slug: $slug) {
    result
    userErrors {
      code
      message
      field
    }
  }
}

# Variables
{
  "slug": ""
}

Arguments

carrierAccountIdID
headersJSON
labelString
payOldDebtBoolean: This delivery account is on another Ostorya account that owes credits: pay that balance to move it here (that account is then suspended).
payloadJSON
slugString!required

Payload

resultJSON
userErrors[UserError!]!required