Description

Topic: Returns

Fields

customer_balance: Boolean

Whether to refund to customer balance

Example: false

line_items: [ReturnLineItemCreate!]!

order_id: String!

A unique order identifier

Example: "or_EQzGqWoY"

Valid when: order_id matches regexp pattern: ^or_

return_policy_id: String!

Unique return policy identifier. See also: Unique Identifiers

Example: "rp_EQzGqWoY"

Valid when: return_policy_id matches regexp pattern: ^rp_

shipping_option_index: Int!

Index of the shipping option within return policy

Example: 0

tags: [String!]

Return tags (can be used for organization)

Used By

Mutations

returnsCreate

Preview (typescript)

interface ReturnCreate {
customer_balance?: boolean
line_items: ReturnLineItemCreate[]
order_id: string
return_policy_id: string
shipping_option_index: number
tags?: string[]
}