returnCreate
mutation

Choose a version:

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.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'ReturnCreatePayload returns'

ReturnCreatePayload returns

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

Was this section helpful?

Code examples for MUTATION: returnCreate

Query Reference for MUTATION: returnCreate

"mutation returnCreate($returnInput: ReturnInput!) {\n  returnCreate(returnInput: $returnInput) {\n    return {\n      # Return fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: returnCreate

"{\n  \"returnInput\": {\n    \"exchangeLineItems\": [\n      {\n        \"appliedDiscount\": {\n          \"description\": \"<your-description>\",\n          \"value\": {\n            \"amount\": {\n              \"amount\": \"29.99\",\n              \"currencyCode\": \"AED\"\n            },\n            \"percentage\": 1.1\n          }\n        },\n        \"giftCardCodes\": [\n          \"<your-giftCardCodes>\"\n        ],\n        \"quantity\": 1,\n        \"variantId\": \"gid://shopify/<objectName>/10079785100\"\n      }\n    ],\n    \"notifyCustomer\": true,\n    \"orderId\": \"gid://shopify/<objectName>/10079785100\",\n    \"requestedAt\": \"2019-09-07T15:50:00Z\",\n    \"returnLineItems\": [\n      {\n        \"fulfillmentLineItemId\": \"gid://shopify/<objectName>/10079785100\",\n        \"quantity\": 1,\n        \"restockingFee\": {\n          \"percentage\": 1.1\n        },\n        \"returnReason\": \"COLOR\",\n        \"returnReasonNote\": \"<your-returnReasonNote>\"\n      }\n    ],\n    \"returnShippingFee\": {\n      \"amount\": {\n        \"amount\": \"29.99\",\n        \"currencyCode\": \"AED\"\n      }\n    }\n  }\n}"

Schema Reference for MUTATION: returnCreate

"input ReturnInput {\n  exchangeLineItems: [ExchangeLineItemInput!]\n  notifyCustomer: Boolean\n  orderId: ID!\n  requestedAt: DateTime\n  returnLineItems: [ReturnLineItemInput!]!\n  returnShippingFee: ReturnShippingFeeInput\n}\n\ninput ExchangeLineItemInput {\n  appliedDiscount: ExchangeLineItemAppliedDiscountInput\n  giftCardCodes: [String!]\n  quantity: Int!\n  variantId: ID\n}\n\ninput ReturnLineItemInput {\n  fulfillmentLineItemId: ID!\n  quantity: Int!\n  restockingFee: RestockingFeeInput\n  returnReason: ReturnReason!\n  returnReasonNote: String\n}\n\ninput ReturnShippingFeeInput {\n  amount: MoneyInput!\n}\n"

Display Examples for MUTATION: returnCreate

[]

returnCreatemutation

Arguments

ReturnCreatePayload returns

returnCreate
mutation