Choose a version:

reverseDeliveryShippingUpdate

mutation

Requires write_returns access scope. Also: The user must have return_orders permission.

Updates a reverse delivery with associated external shipping information.

Arguments

Anchor to labelInputlabelInput •ReverseDeliveryLabelInputDefault:null: The return label file information for the reverse delivery.
Anchor to notifyCustomernotifyCustomer •BooleanDefault:true: If true and an email address exists on the ReverseFulfillmentOrder.order, then the customer is notified with the updated delivery instructions.
Anchor to reverseDeliveryIdreverseDeliveryId •ID!required: The ID of the reverse delivery to update.
Anchor to trackingInputtrackingInput •ReverseDeliveryTrackingInputDefault:null: The tracking information for the reverse delivery.

Was this section helpful?

Anchor to ReverseDeliveryShippingUpdatePayload returnsReverseDeliveryShippingUpdatePayload returns

Anchor to reverseDeliveryreverseDelivery •ReverseDelivery: The updated reverse delivery.
Anchor to userErrorsuserErrors •[ReturnUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation reverseDeliveryShippingUpdate($labelInput: ReverseDeliveryLabelInput, $notifyCustomer: Boolean, $reverseDeliveryId: ID!, $trackingInput: ReverseDeliveryTrackingInput) {

reverseDeliveryShippingUpdate(labelInput: $labelInput, notifyCustomer: $notifyCustomer, reverseDeliveryId: $reverseDeliveryId, trackingInput: $trackingInput) {

reverseDelivery {

# ReverseDelivery fields

}

userErrors {

field

message

}

Input

{

"labelInput": {

"fileUrl": "https://example.myshopify.com"

"notifyCustomer": true,

"reverseDeliveryId": "gid://shopify/<objectName>/10079785100",

"trackingInput": {

"number": "<your-number>",

"url": "https://example.myshopify.com"

}

{
  "labelInput": {
    "fileUrl": "https://example.myshopify.com"
  },
  "notifyCustomer": true,
  "reverseDeliveryId": "gid://shopify/<objectName>/10079785100",
  "trackingInput": {
    "number": "<your-number>",
    "url": "https://example.myshopify.com"
  }
}

input ReverseDeliveryLabelInput {
  fileUrl: URL!
}

input ReverseDeliveryTrackingInput {
  number: String
  url: URL
}