reverseDeliveryCreateWithShipping

Creates a new reverse delivery with associated external shipping information.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the reverseDeliveryCreateWithShipping action (under Reverse).
Fill in the fields below, then reference the result from later steps as {{reversedeliverycreatewithshipping.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation ReverseDeliveryCreateWithShipping($reverseFulfillmentOrderId: ID!, $reverseDeliveryLineItems: [ReverseDeliveryLineItemInput!]!, $trackingInput: ReverseDeliveryTrackingInput, $labelInput: ReverseDeliveryLabelInput, $notifyCustomer: Boolean) {
  reverseDeliveryCreateWithShipping(
    reverseFulfillmentOrderId: $reverseFulfillmentOrderId
    reverseDeliveryLineItems: $reverseDeliveryLineItems
    trackingInput: $trackingInput
    labelInput: $labelInput
    notifyCustomer: $notifyCustomer
  ) {
    reverseDelivery {
      deliverable
      id
      reverseFulfillmentOrder {
        id
        order
        status
        thirdPartyConfirmation
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

reverseFulfillmentOrderIdstringrequired

The ID of the reverse fulfillment order that's associated to the reverse delivery.

reverseDeliveryLineItemsarray<object>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.

reverseFulfillmentOrderLineItemIdstringrequired

quantitynumberrequired

trackingInputobject

The tracking information for the reverse delivery.

numberstring

urlstring

labelInputobject

The return label file information for the reverse delivery.

fileUrlstringrequired

notifyCustomerboolean

When `true` the customer is notified with delivery instructions if the `ReverseFulfillmentOrder.order.email` is present.

json

{
  "reverseFulfillmentOrderId": "string",
  "reverseDeliveryLineItems": [
    {
      "reverseFulfillmentOrderLineItemId": "string",
      "quantity": 0
    }
  ],
  "trackingInput": {
    "number": "string",
    "url": "string"
  },
  "labelInput": {
    "fileUrl": "string"
  },
  "notifyCustomer": false
}

Response

Read the result with {{reversedeliverycreatewithshipping.response.data.data.reverseDeliveryCreateWithShipping}}. If the API returns errors, the step fails and they are at {{reversedeliverycreatewithshipping.response.data.errors}}.

reverseDeliveryobject

deliverableobject2 fields

This field can return one of several different object shapes — properties from every possible shape are shown together.

idstring

reverseFulfillmentOrderobject4 fields

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?