Reverse
Requires access scope or access scope.
A reverse delivery is a post-fulfillment object that represents a buyer sending a package to a merchant. For example, a buyer requests a return, and a merchant sends the buyer a shipping label. The reverse delivery contains the context of the items sent back, how they're being sent back (for example, a shipping label), and the current state of the delivery (tracking information).
Anchor to FieldsFields
- deliverable (ReverseDeliveryDeliverable)
- id (ID!)
- reverseDeliveryLineItems (ReverseDeliveryLineItemConnection!)
- reverseFulfillmentOrder (ReverseFulfillmentOrder!)
- Anchor to deliverabledeliverable•Reverse
Delivery Deliverable The deliverable associated with the reverse delivery.
- •ID!non-null
The ID of the reverse delivery.
- Anchor to reverseDeliveryLineItemsreverse•Reverse
Delivery Line Items Delivery Line Item Connection! non-null The reverse delivery line items attached to the reverse delivery.
- Anchor to afterafter•String
The elements that come after the specified cursor.
- Anchor to beforebefore•String
The elements that come before the specified cursor.
- Anchor to firstfirst•Int
The first
nelements from the paginated list.- Anchor to lastlast•Int
The last
nelements from the paginated list.- Anchor to reversereverse•BooleanDefault:false
Reverse the order of the underlying list.
Arguments
- Anchor to reverseFulfillmentOrderreverse•Reverse
Fulfillment Order Fulfillment Order! non-null The
associated with the reverse delivery.
Anchor to QueriesQueries
- reverseDelivery (ReverseDelivery)
- •query
Lookup a reverse delivery by ID.
- •ID!required
The ID of the ReverseDelivery to return.
Arguments
- •ID!
Anchor to MutationsMutations
- reverseDeliveryCreateWithShipping (ReverseDeliveryCreateWithShippingPayload)
- reverseDeliveryShippingUpdate (ReverseDeliveryShippingUpdatePayload)
- •mutation
Creates a new reverse delivery with associated external shipping information.
- Anchor to labelInputlabel•Reverse
Input Delivery Label Input Default:null The return label file information for the reverse delivery.
- Anchor to notifyCustomernotify•Boolean
Customer Default:true When
truethe customer is notified with delivery instructions if theis present.- Anchor to reverseDeliveryLineItemsreverse•[Reverse
Delivery Line Items Delivery Line Item Input!]! 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 reverseFulfillmentOrderIdreverse•ID!
Fulfillment Order Id required The ID of the reverse fulfillment order that's associated to the reverse delivery.
- Anchor to trackingInputtracking•Reverse
Input Delivery Tracking Input Default:null The tracking information for the reverse delivery.
Arguments
- •mutation
Updates a reverse delivery with associated external shipping information.
- Anchor to labelInputlabel•Reverse
Input Delivery Label Input Default:null The return label file information for the reverse delivery.
- Anchor to notifyCustomernotify•Boolean
Customer Default:true If
trueand an email address exists on the, then the customer is notified with the updated delivery instructions.- Anchor to reverseDeliveryIdreverse•ID!
Delivery Id required The ID of the reverse delivery to update.
- Anchor to trackingInputtracking•Reverse
Input Delivery Tracking Input Default:null The tracking information for the reverse delivery.
Arguments