reverseDeliveryCreateWithShipping
mutation

Choose a version:

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

Creates a new reverse delivery with associated external shipping information.

Anchor to section titled 'Arguments'

Arguments

Anchor to labelInput labelInput ReverseDeliveryLabelInput default:null: The return label file information for the reverse delivery.
Anchor to notifyCustomer notifyCustomer Boolean default:true: When true the customer is notified with delivery instructions if the ReverseFulfillmentOrder.order.email is present.
Anchor to reverseDeliveryLineItems reverseDeliveryLineItems [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 reverseFulfillmentOrderId reverseFulfillmentOrderId ID! required: The ID of the reverse fulfillment order that's associated to the reverse delivery.
Anchor to trackingInput trackingInput ReverseDeliveryTrackingInput default:null: The tracking information for the reverse delivery.

Was this section helpful?

Anchor to section titled 'ReverseDeliveryCreateWithShippingPayload returns'

ReverseDeliveryCreateWithShippingPayload returns

Anchor to ReverseDeliveryCreateWithShippingPayload.reverseDelivery reverseDelivery ReverseDelivery: The created reverse delivery.
Anchor to ReverseDeliveryCreateWithShippingPayload.userErrors userErrors [ReturnUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: reverseDeliveryCreateWithShipping

Query Reference for MUTATION: reverseDeliveryCreateWithShipping

"mutation reverseDeliveryCreateWithShipping($reverseDeliveryLineItems: [ReverseDeliveryLineItemInput!]!, $reverseFulfillmentOrderId: ID!) {\n  reverseDeliveryCreateWithShipping(reverseDeliveryLineItems: $reverseDeliveryLineItems, reverseFulfillmentOrderId: $reverseFulfillmentOrderId) {\n    reverseDelivery {\n      # ReverseDelivery fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: reverseDeliveryCreateWithShipping

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

Schema Reference for MUTATION: reverseDeliveryCreateWithShipping

"input ReverseDeliveryLabelInput {\n  fileUrl: URL!\n}\n\ninput ReverseDeliveryLineItemInput {\n  quantity: Int!\n  reverseFulfillmentOrderLineItemId: ID!\n}\n\ninput ReverseDeliveryTrackingInput {\n  number: String\n  url: URL\n}\n"

Display Examples for MUTATION: reverseDeliveryCreateWithShipping

[]

reverseDeliveryCreateWithShippingmutation

Arguments

ReverseDeliveryCreateWithShippingPayload returns

reverseDeliveryCreateWithShipping
mutation