Choose a version:

reverseDeliveryCreateWithShipping

mutation

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

Creates a new 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: When true the customer is notified with delivery instructions if the ReverseFulfillmentOrder.order.email is present.
Anchor to reverseDeliveryLineItemsreverseDeliveryLineItems • [ReverseDeliveryLineItemInput!]!required: The reverse delivery line items to be created. If an empty array is provided, then this mutation will create a reverse delivery line item for each reverse fulfillment order line item, with its quantity equal to the reverse fulfillment order line item total quantity.
Anchor to reverseFulfillmentOrderIdreverseFulfillmentOrderId • ID!required: The ID of the reverse fulfillment order that's associated to the reverse delivery.
Anchor to trackingInputtrackingInput • ReverseDeliveryTrackingInputDefault:null: The tracking information for the reverse delivery.

Was this section helpful?

Anchor to ReverseDeliveryCreateWithShippingPayload returnsReverseDeliveryCreateWithShippingPayload returns

Anchor to reverseDeliveryreverseDelivery • ReverseDelivery: The created 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 reverseDeliveryCreateWithShipping($labelInput: ReverseDeliveryLabelInput, $notifyCustomer: Boolean, $reverseDeliveryLineItems: [ReverseDeliveryLineItemInput!]!, $reverseFulfillmentOrderId: ID!, $trackingInput: ReverseDeliveryTrackingInput) {

reverseDeliveryCreateWithShipping(labelInput: $labelInput, notifyCustomer: $notifyCustomer, reverseDeliveryLineItems: $reverseDeliveryLineItems, reverseFulfillmentOrderId: $reverseFulfillmentOrderId, trackingInput: $trackingInput) {

reverseDelivery {

# ReverseDelivery fields

}

userErrors {

field

message

}

Input

{

"labelInput": {

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

"notifyCustomer": true,

"reverseDeliveryLineItems": [

{

"quantity": 1,

"reverseFulfillmentOrderLineItemId": "gid://shopify/<objectName>/10079785100"

}

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

"trackingInput": {

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

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

}

{
  "labelInput": {
    "fileUrl": "https://example.myshopify.com"
  },
  "notifyCustomer": true,
  "reverseDeliveryLineItems": [
    {
      "quantity": 1,
      "reverseFulfillmentOrderLineItemId": "gid://shopify/<objectName>/10079785100"
    }
  ],
  "reverseFulfillmentOrderId": "gid://shopify/<objectName>/10079785100",
  "trackingInput": {
    "number": "<your-number>",
    "url": "https://example.myshopify.com"
  }
}

input ReverseDeliveryLabelInput {
  fileUrl: URL!
}

input ReverseDeliveryLineItemInput {
  quantity: Int!
  reverseFulfillmentOrderLineItemId: ID!
}

input ReverseDeliveryTrackingInput {
  number: String
  url: URL
}