Anchor to section titled 'undefined'

carrierServiceUpdate
mutation

Requires write_shipping access scope.

Updates a carrier service. Only the app that creates a carrier service can update it.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
DeliveryCarrierServiceUpdateInput!
required

The input fields used to update a carrier service.

Was this section helpful?
Anchor to section titled 'CarrierServiceUpdatePayload returns'

CarrierServiceUpdatePayload returns

Anchor to CarrierServiceUpdatePayload.carrierService
carrierService
DeliveryCarrierService

The updated carrier service.

Anchor to CarrierServiceUpdatePayload.userErrors
userErrors
[CarrierServiceUpdateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation carrierServiceUpdate($input: DeliveryCarrierServiceUpdateInput!) {
  carrierServiceUpdate(input: $input) {
    carrierService {
      # DeliveryCarrierService fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "input": {
    "active": true,
    "callbackUrl": "https://example.myshopify.com",
    "id": "gid://shopify/<objectName>/10079785100",
    "name": "<your-name>",
    "supportsServiceDiscovery": true
  }
}
input DeliveryCarrierServiceUpdateInput {
  active: Boolean
  callbackUrl: URL
  id: ID!
  name: String
  supportsServiceDiscovery: Boolean
}