returnCreate

mutation

Requires write_orders access scope or write_marketplace_orders access scope. Also: Requires the write_returns access scope. The user must have acess to return orders.

Creates a return.

Arguments

Anchor to returnInputreturnInput • ReturnInput!required: Specifies the input fields for a return.

Was this section helpful?

Anchor to ReturnCreatePayload returnsReturnCreatePayload returns

Anchor to returnreturn • Return: The created return.
Anchor to userErrorsuserErrors • [ReturnUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

mutation returnCreate($returnInput: ReturnInput!) {

returnCreate(returnInput: $returnInput) {

return {

# Return fields

}

userErrors {

field

message

}

Input

{

"returnInput": {

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

"requestedAt": "2019-09-07T15:50:00Z",

"returnLineItems": [

{

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

"quantity": 1,

"returnReason": "",

"returnReasonNote": "<your-returnReasonNote>"

}

]

}

{
  "returnInput": {
    "orderId": "gid://shopify/<objectName>/10079785100",
    "requestedAt": "2019-09-07T15:50:00Z",
    "returnLineItems": [
      {
        "fulfillmentLineItemId": "gid://shopify/<objectName>/10079785100",
        "quantity": 1,
        "returnReason": "",
        "returnReasonNote": "<your-returnReasonNote>"
      }
    ]
  }
}

input ReturnInput {
  notifyCustomer: Boolean
  orderId: ID!
  requestedAt: DateTime
  returnLineItems: [ReturnLineItemInput!]!
}

input ReturnLineItemInput {
  fulfillmentLineItemId: ID!
  quantity: Int!
  returnReason: ReturnReason!
  returnReasonNote: String
}