Anchor to section titled 'undefined'

carrierServiceCreate
mutation

Requires write_shipping access scope.

Creates a new carrier service.

Anchor to section titled 'Arguments'

Arguments

Anchor to input
input
DeliveryCarrierServiceCreateInput!
required

The input fields used to create a carrier service.

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

CarrierServiceCreatePayload returns

Anchor to CarrierServiceCreatePayload.carrierService
carrierService
DeliveryCarrierService

The created carrier service.

Anchor to CarrierServiceCreatePayload.userErrors
userErrors
[CarrierServiceCreateUserError!]!
non-null

The list of errors that occurred from executing the mutation.

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