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

1mutation reverseDeliveryCreateWithShipping($labelInput: ReverseDeliveryLabelInput, $notifyCustomer: Boolean, $reverseDeliveryLineItems: [ReverseDeliveryLineItemInput!]!, $reverseFulfillmentOrderId: ID!, $trackingInput: ReverseDeliveryTrackingInput) {
2  reverseDeliveryCreateWithShipping(labelInput: $labelInput, notifyCustomer: $notifyCustomer, reverseDeliveryLineItems: $reverseDeliveryLineItems, reverseFulfillmentOrderId: $reverseFulfillmentOrderId, trackingInput: $trackingInput) {
3    reverseDelivery {
4      # ReverseDelivery fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "labelInput": {
3    "fileUrl": "https://example.myshopify.com"
4  },
5  "notifyCustomer": true,
6  "reverseDeliveryLineItems": [
7    {
8      "quantity": 1,
9      "reverseFulfillmentOrderLineItemId": "gid://shopify/<objectName>/10079785100"
10    }
11  ],
12  "reverseFulfillmentOrderId": "gid://shopify/<objectName>/10079785100",
13  "trackingInput": {
14    "number": "<your-number>",
15    "url": "https://example.myshopify.com"
16  }
17}

{
  "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
}