ReturnZap GraphQL API Documentation
Welcome to the ReturnZap API documentation. Here you can find details about all available queries, mutations, and types.
API Endpoints
https://api.returnzap.com/graphql/adminHeaders
# Your authorization token must be included in all requests.
Authorization: Bearer <YOUR_TOKEN_HERE>Version
1.0.0
Introduction
This is the API documentation for ReturnZap. Here you can explore all the available queries, mutations, and data types.
Queries
_debug
Response
Returns a DjangoDebug
Example
Query
query _debug {
_debug {
sql {
...DjangoDebugSQLFragment
}
exceptions {
...DjangoDebugExceptionFragment
}
}
}
Response
{
"data": {
"_debug": {
"sql": [DjangoDebugSQL],
"exceptions": [DjangoDebugException]
}
}
}
adminOrderLookup
Description
Lookup order by order number or email
Response
Returns an AdminOrderLookupResponse
Arguments
| Name | Description |
|---|---|
query - String!
|
Example
Query
query adminOrderLookup($query: String!) {
adminOrderLookup(query: $query) {
orders {
...AdminSearchOrderResultFragment
}
}
}
Variables
{"query": "abc123"}
Response
{
"data": {
"adminOrderLookup": {
"orders": [AdminSearchOrderResult]
}
}
}
dashboardMetrics
Response
Returns a DashboardMetrics
Example
Query
query dashboardMetrics(
$startDate: DateTime!,
$endDate: DateTime!
) {
dashboardMetrics(
startDate: $startDate,
endDate: $endDate
) {
returnMetrics {
...ReturnsMetricTypeFragment
}
stageMetrics {
...StageMetricTypeFragment
}
policyMetrics {
...PolicyMetricTypeFragment
}
reasonMetrics {
...ReasonMetricTypeFragment
}
actionTakenMetrics {
...ActionTakenMetricTypeFragment
}
mostReturned {
...ReturnProductMetricTypeFragment
}
activeReturns {
...ActiveReturnsMetricTypeFragment
}
startDate
endDate
}
}
Variables
{
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
Response
{
"data": {
"dashboardMetrics": {
"returnMetrics": [ReturnsMetricType],
"stageMetrics": [StageMetricType],
"policyMetrics": [PolicyMetricType],
"reasonMetrics": [ReasonMetricType],
"actionTakenMetrics": ActionTakenMetricType,
"mostReturned": ReturnProductMetricType,
"activeReturns": ActiveReturnsMetricType,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
}
}
dashboardReturns
Use 'returns' instead. This query was misnamed - it returns a filterable list of returns, not dashboard data.
Response
Returns a DashboardResponse
Arguments
| Name | Description |
|---|---|
query - String
|
Default = "" |
stages - [Int]
|
|
status - ArchiveFilter
|
|
returnDate - DateFilterRange
|
|
orderDate - DateFilterRange
|
|
stageUpdatedDate - DateFilterRange
|
|
perPage - Int
|
Default = 25 |
currentPage - Int
|
Default = 0 |
sortBy - String
|
Default = "-returnDate" |
resolvedStatus - [ResolvedStatus]
|
|
returnItemTypes - [String]
|
|
warehouseIds - [Int]
|
No filtering if not passed in or empty list. Use 0 to designate default, or no warehouse. |
Example
Query
query dashboardReturns(
$query: String,
$stages: [Int],
$status: ArchiveFilter,
$returnDate: DateFilterRange,
$orderDate: DateFilterRange,
$stageUpdatedDate: DateFilterRange,
$perPage: Int,
$currentPage: Int,
$sortBy: String,
$resolvedStatus: [ResolvedStatus],
$returnItemTypes: [String],
$warehouseIds: [Int]
) {
dashboardReturns(
query: $query,
stages: $stages,
status: $status,
returnDate: $returnDate,
orderDate: $orderDate,
stageUpdatedDate: $stageUpdatedDate,
perPage: $perPage,
currentPage: $currentPage,
sortBy: $sortBy,
resolvedStatus: $resolvedStatus,
returnItemTypes: $returnItemTypes,
warehouseIds: $warehouseIds
) {
id
returns {
...ReturnFragment
}
totalCount
}
}
Variables
{
"query": "",
"stages": [123],
"status": "ACTIVE",
"returnDate": DateFilterRange,
"orderDate": DateFilterRange,
"stageUpdatedDate": DateFilterRange,
"perPage": 25,
"currentPage": 0,
"sortBy": "-returnDate",
"resolvedStatus": ["RESOLVED"],
"returnItemTypes": ["abc123"],
"warehouseIds": [987]
}
Response
{
"data": {
"dashboardReturns": {
"id": 4,
"returns": [Return],
"totalCount": 123
}
}
}
easyPostCarrierConfig
Response
Returns [EasyPostCarrierConfig]
Example
Query
query easyPostCarrierConfig {
easyPostCarrierConfig {
carrier
displayName
service
serviceDisplayName
width
height
unit
rotate
supportsQrCode
}
}
Response
{
"data": {
"easyPostCarrierConfig": [
{
"carrier": "abc123",
"displayName": "xyz789",
"service": "xyz789",
"serviceDisplayName": "abc123",
"width": Decimal,
"height": Decimal,
"unit": "IN",
"rotate": false,
"supportsQrCode": false
}
]
}
}
getBalanceInfo
Description
Get complete balance information for a shop
Response
Returns a BalanceInfoType
Example
Query
query getBalanceInfo {
getBalanceInfo {
paymentMethods {
...ShopPaymentMethodFragment
}
balanceSettings {
...BalanceSettingsTypeFragment
}
balance
}
}
Response
{
"data": {
"getBalanceInfo": {
"paymentMethods": [ShopPaymentMethod],
"balanceSettings": BalanceSettingsType,
"balance": Decimal
}
}
}
getMe
Response
Returns a ShopifyUser
Example
Query
query getMe {
getMe {
id
uuid
accountOwner
preferredLocale
isAdmin
canManageUsers
canModifySettings
canProcessReturns
shopifyId
email
firstName
lastName
locale
isActive
chatHash
shouldUpdate
isDeleted
shopifyRoles
}
}
Response
{
"data": {
"getMe": {
"id": 4,
"uuid": "abc123",
"accountOwner": true,
"preferredLocale": "xyz789",
"isAdmin": true,
"canManageUsers": true,
"canModifySettings": true,
"canProcessReturns": false,
"shopifyId": "abc123",
"email": "abc123",
"firstName": "abc123",
"lastName": "xyz789",
"locale": "xyz789",
"isActive": false,
"chatHash": "xyz789",
"shouldUpdate": true,
"isDeleted": false,
"shopifyRoles": "xyz789"
}
}
}
getMyShop
Response
Returns an AuthenticatedShop
Example
Query
query getMyShop {
getMyShop {
uuid
url
primaryDomain
timezone
name
isTestShop
isUitestShop
onboardingCompletedAt
needsToEnableExchangeTestDrive
userPermissionsEnabled
notifyOnlyIfApprovalIsRequired
instructions
portalTheme
portalLanguage
portalFrenchUseAlternative
portalGermanUseAlternative
portalItalianUseAlternative
portalCustomizations
shouldDisplayFeesInPortal
refundPortalDisplayOrder
creditPortalDisplayOrder
exchangePortalDisplayOrder
showPortalSummary
portalExchangeSelectionMethod
portalVisualExchangeType
portalVisualExchangeIncludeCollections
portalVisualExchangeExcludeCollections
exchangeUpsellEnabled
exchangeUpsellDiscountPercentage
minFilesPerReturn
maxFilesPerReturn
isShippingLabelUploadAllowed
barcodeValue
enableCustomRmaNumber
shipFree
shipPay
shipSelf
isShippingByReturnzapAvailable
useShippingByReturnzap
prepaidShippingFee
paidShippingFee
selfShippingFee
isDefaultFeeEqualsShippingCost
shippingRateSelectLowestRate
shippingRateShowUpToPercentage
customerLabelFlatFee
customerPaidShippingMode
isNoShippingReturnEnabled
isQrCodeEnabled
isCartonizationEnabled
cartonizationLengthUnit
restockingFeeDefinedAsPercentage
defaultRefundFee
defaultExchangeFee
defaultStoreCreditFee
currency
internationalCustomsContentValueSource
klaviyoApiKey
gorgiasSubdomain
useApprovals
requireApprovalForAllReturns
useShopAddressForPosReturns
useBillingAddressFallback
allowGiftReturns
giftReturnsExchangeEnabled
giftReturnsStoreCreditEnabled
preventReturnsFromDifferentFulfillments
delayedShopifyReturnCreationEnabled
isRefundIntegrationEnabled
isRestockIntegrationEnabled
returnItemExpirationDays
isReturnItemExpirationEnabled
returnItemExpirationEnabledAt
expirationPreventionAction
expirationPeriodType
isExchangeIntegrationEnabled
exchangeMethod
isInlineExchangeEnabled
isFullCatalogExchangeEnabled
useConsolidatedOrderExchanges
discountSameProductExchangesToBeEqual
exchangeNormalizeCrossProductEqualPrices
isExchangeDifferentialPricingEnabled
exchangeRoundToZeroIfLteTo
exchangeDaysToReserveStock
allowOutOfStockExchanges
exchangeCheckInventoryAtFulfillmentLocation
carryDiscountForwardType
useExchangeShipmentOrders
exchangeShipmentOrderSuffix
exchangeShippingLineTitle
autoProcessExchangesOnCreation
isStoreCreditIntegrationEnabled
isStoreCreditIncentiveEnabled
storeCreditIncentivePercentage
minStoreCreditIncentiveAmount
maxStoreCreditIncentiveAmount
isStoreCreditIncentiveRoundToNearest
resolvePartialExchangeRefundsToStoreCredit
storeCreditExpireDays
giftCardPrefix
id
parentUrl
shopifyAdminUrl
primaryFieldBehavior
secondaryFieldBehavior
reauthenticateUrl
hasTestModeReturns
defaultPortalUrl
adminAppUrl
enableRefund
refundDays
refundDaysType
refundCommentsEnabled
refundCommentsRequired
refundRequireDeliveryBeforeReturn
enableExchange
exchangeDays
exchangeDaysType
exchangeCommentsEnabled
exchangeCommentsRequired
exchangeRequireDeliveryBeforeReturn
exchangeExcludeTags
enableStoreCredit
storeCreditDays
storeCreditDaysType
storeCreditCommentsEnabled
storeCreditCommentsRequired
storeCreditRequireDeliveryBeforeReturn
automatedStoreCreditType
notificationEmailAddress
notificationEmailAttachRma
customerEmailDisplayFromName
customerEmailReplyToAddress
defaultAddress {
...AddressFragment
}
defaultWeight
defaultWeightUnit
international
internationalOriginCountry
internationalCustomsSigner
internationalNonDeliveryOption
internationalExemptionCode
internationalDefaultHarmonizedSystemCode
shippoApiKey
stripePublishableKey
stripeSecretKey
subscriptionPlan {
...ShopSubscriptionPlanFragment
}
features
installedAt
returnReasons {
...ReturnReasonFragment
}
stages {
...StageFragment
}
notifications {
...NotificationFragment
}
rules {
...RuleFragment
}
packages {
...PackageTypeFragment
}
dynamicTranslations {
...DynamicTranslationFragment
}
returnIntegration
missingScopes
sendcloudAccounts {
...SendcloudAccountFragment
}
shopifyLocations {
...ShopifyLocationFragment
}
easyPostAccount {
...EasyPostAccountTypeFragment
}
shippoAccount {
...ShippoAccountTypeFragment
}
shipstationAccount {
...ShipStationAccountTypeFragment
}
refField1Source
refField2Source
storeCreditIncentiveType
restockingFeeType
webhookUrl
webhookEvents
questions {
...QuestionFragment
}
stageShipmentStatuses {
...StageShipmentStatusTypeFragment
}
defaultWarehouseForPosReturns
portalConfig {
...PortalConfigTypeFragment
}
hasLabelIntegration
canUseStoreShippingMode
logo
logoUploadUrl {
...SignedUrlFragment
}
easypostApiKey
onboardingComplete
installDate
exchangeIntegration
storeCreditIntegration
}
}
Response
{
"data": {
"getMyShop": {
"uuid": "xyz789",
"url": "xyz789",
"primaryDomain": "xyz789",
"timezone": "abc123",
"name": "abc123",
"isTestShop": true,
"isUitestShop": false,
"onboardingCompletedAt": "2007-12-03T10:15:30Z",
"needsToEnableExchangeTestDrive": true,
"userPermissionsEnabled": true,
"notifyOnlyIfApprovalIsRequired": true,
"instructions": "abc123",
"portalTheme": "xyz789",
"portalLanguage": "xyz789",
"portalFrenchUseAlternative": false,
"portalGermanUseAlternative": false,
"portalItalianUseAlternative": false,
"portalCustomizations": JSONString,
"shouldDisplayFeesInPortal": false,
"refundPortalDisplayOrder": 123,
"creditPortalDisplayOrder": 123,
"exchangePortalDisplayOrder": 987,
"showPortalSummary": false,
"portalExchangeSelectionMethod": "SEARCH",
"portalVisualExchangeType": "NONE",
"portalVisualExchangeIncludeCollections": [
"abc123"
],
"portalVisualExchangeExcludeCollections": [
"xyz789"
],
"exchangeUpsellEnabled": true,
"exchangeUpsellDiscountPercentage": Decimal,
"minFilesPerReturn": 123,
"maxFilesPerReturn": 987,
"isShippingLabelUploadAllowed": true,
"barcodeValue": "NONE",
"enableCustomRmaNumber": true,
"shipFree": true,
"shipPay": true,
"shipSelf": false,
"isShippingByReturnzapAvailable": false,
"useShippingByReturnzap": true,
"prepaidShippingFee": Decimal,
"paidShippingFee": Decimal,
"selfShippingFee": Decimal,
"isDefaultFeeEqualsShippingCost": true,
"shippingRateSelectLowestRate": false,
"shippingRateShowUpToPercentage": Decimal,
"customerLabelFlatFee": Decimal,
"customerPaidShippingMode": "RETURNZAP",
"isNoShippingReturnEnabled": false,
"isQrCodeEnabled": true,
"isCartonizationEnabled": true,
"cartonizationLengthUnit": "INCHES",
"restockingFeeDefinedAsPercentage": true,
"defaultRefundFee": Decimal,
"defaultExchangeFee": Decimal,
"defaultStoreCreditFee": Decimal,
"currency": "abc123",
"internationalCustomsContentValueSource": "SELL_PRICE",
"klaviyoApiKey": "xyz789",
"gorgiasSubdomain": "xyz789",
"useApprovals": true,
"requireApprovalForAllReturns": false,
"useShopAddressForPosReturns": false,
"useBillingAddressFallback": false,
"allowGiftReturns": false,
"giftReturnsExchangeEnabled": false,
"giftReturnsStoreCreditEnabled": false,
"preventReturnsFromDifferentFulfillments": true,
"delayedShopifyReturnCreationEnabled": false,
"isRefundIntegrationEnabled": true,
"isRestockIntegrationEnabled": true,
"returnItemExpirationDays": 123,
"isReturnItemExpirationEnabled": true,
"returnItemExpirationEnabledAt": "2007-12-03T10:15:30Z",
"expirationPreventionAction": "RETURN_PROCESSED",
"expirationPeriodType": "RETURN_CREATED_DATE",
"isExchangeIntegrationEnabled": true,
"exchangeMethod": "COMMENTS",
"isInlineExchangeEnabled": true,
"isFullCatalogExchangeEnabled": true,
"useConsolidatedOrderExchanges": false,
"discountSameProductExchangesToBeEqual": false,
"exchangeNormalizeCrossProductEqualPrices": false,
"isExchangeDifferentialPricingEnabled": false,
"exchangeRoundToZeroIfLteTo": Decimal,
"exchangeDaysToReserveStock": 123,
"allowOutOfStockExchanges": true,
"exchangeCheckInventoryAtFulfillmentLocation": true,
"carryDiscountForwardType": "NONE",
"useExchangeShipmentOrders": false,
"exchangeShipmentOrderSuffix": "abc123",
"exchangeShippingLineTitle": "xyz789",
"autoProcessExchangesOnCreation": true,
"isStoreCreditIntegrationEnabled": true,
"isStoreCreditIncentiveEnabled": false,
"storeCreditIncentivePercentage": 123.45,
"minStoreCreditIncentiveAmount": Decimal,
"maxStoreCreditIncentiveAmount": Decimal,
"isStoreCreditIncentiveRoundToNearest": false,
"resolvePartialExchangeRefundsToStoreCredit": true,
"storeCreditExpireDays": 123,
"giftCardPrefix": "xyz789",
"id": "4",
"parentUrl": "abc123",
"shopifyAdminUrl": "xyz789",
"primaryFieldBehavior": "EMAIL_ADDRESS",
"secondaryFieldBehavior": "SHOPIFY_ORDER_NUMBER",
"reauthenticateUrl": "abc123",
"hasTestModeReturns": false,
"defaultPortalUrl": "xyz789",
"adminAppUrl": "abc123",
"enableRefund": false,
"refundDays": 123,
"refundDaysType": "SINCE_DELIVERY",
"refundCommentsEnabled": false,
"refundCommentsRequired": true,
"refundRequireDeliveryBeforeReturn": true,
"enableExchange": true,
"exchangeDays": 123,
"exchangeDaysType": "SINCE_DELIVERY",
"exchangeCommentsEnabled": true,
"exchangeCommentsRequired": true,
"exchangeRequireDeliveryBeforeReturn": false,
"exchangeExcludeTags": ["abc123"],
"enableStoreCredit": false,
"storeCreditDays": 987,
"storeCreditDaysType": "SINCE_DELIVERY",
"storeCreditCommentsEnabled": true,
"storeCreditCommentsRequired": true,
"storeCreditRequireDeliveryBeforeReturn": true,
"automatedStoreCreditType": "DISCOUNT_CODE",
"notificationEmailAddress": "abc123",
"notificationEmailAttachRma": true,
"customerEmailDisplayFromName": "abc123",
"customerEmailReplyToAddress": "abc123",
"defaultAddress": Address,
"defaultWeight": Decimal,
"defaultWeightUnit": "abc123",
"international": false,
"internationalOriginCountry": "xyz789",
"internationalCustomsSigner": "abc123",
"internationalNonDeliveryOption": "xyz789",
"internationalExemptionCode": "abc123",
"internationalDefaultHarmonizedSystemCode": "abc123",
"shippoApiKey": "abc123",
"stripePublishableKey": "xyz789",
"stripeSecretKey": "xyz789",
"subscriptionPlan": ShopSubscriptionPlan,
"features": ["abc123"],
"installedAt": "2007-12-03T10:15:30Z",
"returnReasons": [ReturnReason],
"stages": [Stage],
"notifications": [Notification],
"rules": [Rule],
"packages": [PackageType],
"dynamicTranslations": [DynamicTranslation],
"returnIntegration": false,
"missingScopes": ["xyz789"],
"sendcloudAccounts": [SendcloudAccount],
"shopifyLocations": [ShopifyLocation],
"easyPostAccount": EasyPostAccountType,
"shippoAccount": ShippoAccountType,
"shipstationAccount": ShipStationAccountType,
"refField1Source": "BLANK",
"refField2Source": "BLANK",
"storeCreditIncentiveType": "ONCE_PER_ITEM",
"restockingFeeType": "ONCE_PER_RETURN",
"webhookUrl": "abc123",
"webhookEvents": ["RETURN_CREATED"],
"questions": [Question],
"stageShipmentStatuses": [StageShipmentStatusType],
"defaultWarehouseForPosReturns": "4",
"portalConfig": PortalConfigType,
"hasLabelIntegration": false,
"canUseStoreShippingMode": true,
"logo": "xyz789",
"logoUploadUrl": SignedUrl,
"easypostApiKey": "xyz789",
"onboardingComplete": false,
"installDate": "2007-12-03T10:15:30Z",
"exchangeIntegration": false,
"storeCreditIntegration": true
}
}
}
getPaymentMethod
Description
Get a specific payment method by ID
Response
Returns a ShopPaymentMethod
Arguments
| Name | Description |
|---|---|
paymentMethodId - ID!
|
Example
Query
query getPaymentMethod($paymentMethodId: ID!) {
getPaymentMethod(paymentMethodId: $paymentMethodId) {
id
createdAt
stripePaymentMethodId
paymentMethodType
brand
lastFour
expMonth
expYear
bankName
isActive
isDefault
status
isExpired
}
}
Variables
{"paymentMethodId": 4}
Response
{
"data": {
"getPaymentMethod": {
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"createdAt": "2007-12-03T10:15:30Z",
"stripePaymentMethodId": "abc123",
"paymentMethodType": "CARD",
"brand": "abc123",
"lastFour": "xyz789",
"expMonth": 987,
"expYear": 987,
"bankName": "abc123",
"isActive": true,
"isDefault": false,
"status": "PENDING",
"isExpired": false
}
}
}
getReturn
Example
Query
query getReturn($returnId: ID!) {
getReturn(returnId: $returnId) {
id
uuid
adminReturn
testMode
returnIntegration
usesConsolidatedOrderExchanges
traceId
customerFirstName
customerLastName
customerEmail
rmaNumber
stageLabel
stageUpdatedDate
approvalRequired
approvedAt
rejectedAt
rejectionReason
allowResubmission
receivedAt
isArchived
expiredAt
shippingMethod
giftReturn
giftReturnEmailAddress
trackingNumber
deliveryDate
deliveryStatus
labelCurrency
shopCurrency
noShippingRequired
feesSentThroughReturnIntegration
defaultRefundFee
defaultStoreCreditFee
originalHandlingFeeCharged
actualHandlingFeeCharged
restockingFeeType
originalRestockingFeeCharged
actualRestockingFeeCharged
shopifyReturnId
shopifyReturnName
shopifyReturnSyncError
shopifyOrderId
shopifyOrderDate
exchangeBalanceDue
exchangeBalancePaidAt
estimatedBalance
shopifyOrderNumber
shopifyOrderUrl
shopifyCustomerUrl
customerAddress {
...ReturnAddressTypeFragment
}
destinationAddress {
...ReturnAddressTypeFragment
}
giftReturnAddress {
...ReturnAddressTypeFragment
}
rmaFormUrl
stageId
systemStage
statusId
statusLabel
labelUrl
qrCodeUrl
labelCost
totalWeightGrams
createdAt
refunds {
...RefundTypeFragment
}
logs {
...ReturnLogFragment
}
next
previous
nextReturn {
...ReturnFragment
}
previousReturn {
...ReturnFragment
}
exchangeOrders {
...ExchangeOrderFragment
}
shipment {
...ShipmentFragment
}
appliedRules
appliedRulesDetailed {
...AppliedRuleTypeFragment
}
suggestionRefund {
...SuggestionRefundTypeFragment
}
suggestedRefund {
...SuggestedRefundTypeFragment
}
hasValidCustomerPaymentPending
warehouseName
shippedTo
warehouse {
...WarehouseTypeFragment
}
storeCredits {
...StoreCreditTypeFragment
}
externalShippingLabelUrl
items {
...ReturnItemFragment
}
exchangeItems {
...ExchangeItemFragment
}
handlingFeeCharged
restockingFeeCharged
shopifyOrderFulfillments {
...ShopifyFulfillmentTypeFragment
}
shopifyOrderTotalQuantityOrdered
shopifyOrderTotalQuantityReturnItems
shopifyOrderTags
shopifyOrderCustomerTags
shopifyReturnSyncStatus
orderId
orderNumber
orderDate
returnDate
isActive
unitQuantity
returnValueAmount
resolvedStatus
returnItemTypes
returnTypeLabels
}
}
Variables
{"returnId": 4}
Response
{
"data": {
"getReturn": {
"id": "4",
"uuid": "xyz789",
"adminReturn": false,
"testMode": false,
"returnIntegration": false,
"usesConsolidatedOrderExchanges": false,
"traceId": "xyz789",
"customerFirstName": "xyz789",
"customerLastName": "abc123",
"customerEmail": "xyz789",
"rmaNumber": "abc123",
"stageLabel": "abc123",
"stageUpdatedDate": "2007-12-03T10:15:30Z",
"approvalRequired": false,
"approvedAt": "2007-12-03T10:15:30Z",
"rejectedAt": "2007-12-03T10:15:30Z",
"rejectionReason": "xyz789",
"allowResubmission": true,
"receivedAt": "2007-12-03T10:15:30Z",
"isArchived": false,
"expiredAt": "2007-12-03T10:15:30Z",
"shippingMethod": "FREE",
"giftReturn": false,
"giftReturnEmailAddress": "xyz789",
"trackingNumber": "xyz789",
"deliveryDate": "2007-12-03T10:15:30Z",
"deliveryStatus": "xyz789",
"labelCurrency": "xyz789",
"shopCurrency": "abc123",
"noShippingRequired": true,
"feesSentThroughReturnIntegration": true,
"defaultRefundFee": Decimal,
"defaultStoreCreditFee": Decimal,
"originalHandlingFeeCharged": Decimal,
"actualHandlingFeeCharged": Decimal,
"restockingFeeType": "ONCE_PER_RETURN",
"originalRestockingFeeCharged": Decimal,
"actualRestockingFeeCharged": Decimal,
"shopifyReturnId": "abc123",
"shopifyReturnName": "xyz789",
"shopifyReturnSyncError": "UNKNOWN_ERROR",
"shopifyOrderId": "xyz789",
"shopifyOrderDate": "2007-12-03T10:15:30Z",
"exchangeBalanceDue": Decimal,
"exchangeBalancePaidAt": "2007-12-03T10:15:30Z",
"estimatedBalance": Decimal,
"shopifyOrderNumber": "xyz789",
"shopifyOrderUrl": "abc123",
"shopifyCustomerUrl": "abc123",
"customerAddress": ReturnAddressType,
"destinationAddress": ReturnAddressType,
"giftReturnAddress": ReturnAddressType,
"rmaFormUrl": "abc123",
"stageId": 4,
"systemStage": 987,
"statusId": "abc123",
"statusLabel": "xyz789",
"labelUrl": "xyz789",
"qrCodeUrl": "xyz789",
"labelCost": Decimal,
"totalWeightGrams": Decimal,
"createdAt": "2007-12-03T10:15:30Z",
"refunds": [RefundType],
"logs": [ReturnLog],
"next": "abc123",
"previous": "abc123",
"nextReturn": Return,
"previousReturn": Return,
"exchangeOrders": [ExchangeOrder],
"shipment": Shipment,
"appliedRules": ["xyz789"],
"appliedRulesDetailed": [AppliedRuleType],
"suggestionRefund": SuggestionRefundType,
"suggestedRefund": SuggestedRefundType,
"hasValidCustomerPaymentPending": true,
"warehouseName": "xyz789",
"shippedTo": "abc123",
"warehouse": WarehouseType,
"storeCredits": [StoreCreditType],
"externalShippingLabelUrl": "abc123",
"items": [ReturnItem],
"exchangeItems": [ExchangeItem],
"handlingFeeCharged": Decimal,
"restockingFeeCharged": Decimal,
"shopifyOrderFulfillments": [
ShopifyFulfillmentType
],
"shopifyOrderTotalQuantityOrdered": 123,
"shopifyOrderTotalQuantityReturnItems": 123,
"shopifyOrderTags": ["xyz789"],
"shopifyOrderCustomerTags": [
"abc123"
],
"shopifyReturnSyncStatus": "UNSYNCABLE",
"orderId": "abc123",
"orderNumber": "abc123",
"orderDate": "2007-12-03T10:15:30Z",
"returnDate": "2007-12-03T10:15:30Z",
"isActive": false,
"unitQuantity": 987,
"returnValueAmount": Decimal,
"resolvedStatus": "RESOLVED",
"returnItemTypes": ["abc123"],
"returnTypeLabels": ["abc123"]
}
}
}
getReturnRule
Example
Query
query getReturnRule($ruleId: ID!) {
getReturnRule(ruleId: $ruleId) {
id
uuid
isActive
name
rule
description
when
conditions {
...ConditionFragment
}
action
actionOption
unit
value
message
warehouseName
warehouseId
destinationCountry
question
questionChoices
questionId
questionChoiceId
windowDays
}
}
Variables
{"ruleId": "4"}
Response
{
"data": {
"getReturnRule": {
"id": 4,
"uuid": "xyz789",
"isActive": true,
"name": "xyz789",
"rule": "abc123",
"description": "abc123",
"when": "AND",
"conditions": [Condition],
"action": "DENY_RETURN",
"actionOption": "ALL",
"unit": "SHOP_DEFAULT_CURRENCY",
"value": "abc123",
"message": "abc123",
"warehouseName": "abc123",
"warehouseId": 4,
"destinationCountry": "abc123",
"question": 4,
"questionChoices": [4],
"questionId": 4,
"questionChoiceId": "4",
"windowDays": 123
}
}
}
installStatus
Description
Check if a shop is installed and has valid credentials
Response
Returns an InstallStatusType
Arguments
| Name | Description |
|---|---|
shopUrl - String!
|
Example
Query
query installStatus($shopUrl: String!) {
installStatus(shopUrl: $shopUrl) {
installed
redirectUrl
}
}
Variables
{"shopUrl": "abc123"}
Response
{
"data": {
"installStatus": {
"installed": true,
"redirectUrl": "abc123"
}
}
}
ledgerEntries
Description
Get ledger entries with Relay-style pagination
Response
Returns a LedgerConnection
Example
Query
query ledgerEntries(
$before: String,
$after: String,
$first: Int,
$last: Int
) {
ledgerEntries(
before: $before,
after: $after,
first: $first,
last: $last
) {
pageInfo {
...PageInfoFragment
}
edges {
...LedgerEdgeFragment
}
}
}
Variables
{
"before": "abc123",
"after": "xyz789",
"first": 123,
"last": 123
}
Response
{
"data": {
"ledgerEntries": {
"pageInfo": PageInfo,
"edges": [LedgerEdge]
}
}
}
maintenanceMode
Response
Returns a Boolean
Example
Query
query maintenanceMode {
maintenanceMode
}
Response
{"data": {"maintenanceMode": true}}
packages
Response
Returns [PackageType]
Example
Query
query packages {
packages {
id
name
type
length
width
height
unit
weight
weightUnit
uuid
}
}
Response
{
"data": {
"packages": [
{
"id": "4",
"name": "abc123",
"type": "xyz789",
"length": Decimal,
"width": Decimal,
"height": Decimal,
"unit": "IN",
"weight": Decimal,
"weightUnit": "GRAMS",
"uuid": 4
}
]
}
}
returnRules
Response
Returns [Rule]
Example
Query
query returnRules {
returnRules {
id
uuid
isActive
name
rule
description
when
conditions {
...ConditionFragment
}
action
actionOption
unit
value
message
warehouseName
warehouseId
destinationCountry
question
questionChoices
questionId
questionChoiceId
windowDays
}
}
Response
{
"data": {
"returnRules": [
{
"id": "4",
"uuid": "xyz789",
"isActive": true,
"name": "xyz789",
"rule": "abc123",
"description": "abc123",
"when": "AND",
"conditions": [Condition],
"action": "DENY_RETURN",
"actionOption": "ALL",
"unit": "SHOP_DEFAULT_CURRENCY",
"value": "abc123",
"message": "xyz789",
"warehouseName": "abc123",
"warehouseId": "4",
"destinationCountry": "abc123",
"question": "4",
"questionChoices": [4],
"questionId": "4",
"questionChoiceId": 4,
"windowDays": 123
}
]
}
}
returns
Response
Returns a DashboardResponse
Arguments
| Name | Description |
|---|---|
query - String
|
Default = "" |
stages - [Int]
|
|
status - ArchiveFilter
|
|
returnDate - DateFilterRange
|
|
orderDate - DateFilterRange
|
|
stageUpdatedDate - DateFilterRange
|
|
perPage - Int
|
Default = 25 |
currentPage - Int
|
Default = 0 |
sortBy - String
|
Default = "-returnDate" |
resolvedStatus - [ResolvedStatus]
|
|
returnItemTypes - [String]
|
|
warehouseIds - [Int]
|
No filtering if not passed in or empty list. Use 0 to designate default, or no warehouse. |
Example
Query
query returns(
$query: String,
$stages: [Int],
$status: ArchiveFilter,
$returnDate: DateFilterRange,
$orderDate: DateFilterRange,
$stageUpdatedDate: DateFilterRange,
$perPage: Int,
$currentPage: Int,
$sortBy: String,
$resolvedStatus: [ResolvedStatus],
$returnItemTypes: [String],
$warehouseIds: [Int]
) {
returns(
query: $query,
stages: $stages,
status: $status,
returnDate: $returnDate,
orderDate: $orderDate,
stageUpdatedDate: $stageUpdatedDate,
perPage: $perPage,
currentPage: $currentPage,
sortBy: $sortBy,
resolvedStatus: $resolvedStatus,
returnItemTypes: $returnItemTypes,
warehouseIds: $warehouseIds
) {
id
returns {
...ReturnFragment
}
totalCount
}
}
Variables
{
"query": "",
"stages": [987],
"status": "ACTIVE",
"returnDate": DateFilterRange,
"orderDate": DateFilterRange,
"stageUpdatedDate": DateFilterRange,
"perPage": 25,
"currentPage": 0,
"sortBy": "-returnDate",
"resolvedStatus": ["RESOLVED"],
"returnItemTypes": ["xyz789"],
"warehouseIds": [123]
}
Response
{
"data": {
"returns": {
"id": "4",
"returns": [Return],
"totalCount": 987
}
}
}
shippoCarrierServiceConfig
Response
Returns [ShippoCarrierServiceConfig]
Example
Query
query shippoCarrierServiceConfig {
shippoCarrierServiceConfig {
carrier
displayName
service
serviceDisplayName
width
height
unit
rotate
}
}
Response
{
"data": {
"shippoCarrierServiceConfig": [
{
"carrier": "xyz789",
"displayName": "abc123",
"service": "xyz789",
"serviceDisplayName": "abc123",
"width": Decimal,
"height": Decimal,
"unit": "IN",
"rotate": true
}
]
}
}
shipstationCarrierServiceConfig
Response
Example
Query
query shipstationCarrierServiceConfig {
shipstationCarrierServiceConfig {
carrier
displayName
service
serviceDisplayName
serviceDescription
width
height
unit
rotate
}
}
Response
{
"data": {
"shipstationCarrierServiceConfig": [
{
"carrier": "xyz789",
"displayName": "abc123",
"service": "abc123",
"serviceDisplayName": "abc123",
"serviceDescription": "xyz789",
"width": Decimal,
"height": Decimal,
"unit": "IN",
"rotate": true
}
]
}
}
shopifyUser
Response
Returns a ShopifyUser
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query shopifyUser($id: ID!) {
shopifyUser(id: $id) {
id
uuid
accountOwner
preferredLocale
isAdmin
canManageUsers
canModifySettings
canProcessReturns
shopifyId
email
firstName
lastName
locale
isActive
chatHash
shouldUpdate
isDeleted
shopifyRoles
}
}
Variables
{"id": 4}
Response
{
"data": {
"shopifyUser": {
"id": "4",
"uuid": "abc123",
"accountOwner": true,
"preferredLocale": "xyz789",
"isAdmin": true,
"canManageUsers": true,
"canModifySettings": true,
"canProcessReturns": false,
"shopifyId": "abc123",
"email": "abc123",
"firstName": "abc123",
"lastName": "abc123",
"locale": "abc123",
"isActive": false,
"chatHash": "abc123",
"shouldUpdate": true,
"isDeleted": false,
"shopifyRoles": "abc123"
}
}
}
shopifyUsers
Response
Returns a ShopifyUsersResponse
Example
Query
query shopifyUsers(
$query: String,
$perPage: Int,
$currentPage: Int,
$sortBy: String,
$includeDeleted: Boolean,
$permissions: [String]
) {
shopifyUsers(
query: $query,
perPage: $perPage,
currentPage: $currentPage,
sortBy: $sortBy,
includeDeleted: $includeDeleted,
permissions: $permissions
) {
id
users {
...ShopifyUserFragment
}
totalCount
}
}
Variables
{
"query": "",
"perPage": 25,
"currentPage": 0,
"sortBy": "first_name",
"includeDeleted": false,
"permissions": ["xyz789"]
}
Response
{
"data": {
"shopifyUsers": {
"id": 4,
"users": [ShopifyUser],
"totalCount": 987
}
}
}
subscriptionPlans
Response
Returns [SubscriptionPlan]
Example
Query
query subscriptionPlans {
subscriptionPlans {
id
uuid
subscriptionType
tiered
name
features
exclusiveFeatures
featuresWouldBeLost
tiers {
...SubscriptionPlanTierTypeFragment
}
price
published
subscribeUrl
}
}
Response
{
"data": {
"subscriptionPlans": [
{
"id": 987,
"uuid": 4,
"subscriptionType": "FREE",
"tiered": true,
"name": "xyz789",
"features": ["ADJUST_RETURN_WINDOWS"],
"exclusiveFeatures": ["ADJUST_RETURN_WINDOWS"],
"featuresWouldBeLost": ["ADJUST_RETURN_WINDOWS"],
"tiers": [SubscriptionPlanTierType],
"price": Decimal,
"published": true,
"subscribeUrl": "xyz789"
}
]
}
}
translatableMessages
Response
Returns [TranslatableMessageType]
Example
Query
query translatableMessages(
$category: String,
$exposedOnly: Boolean
) {
translatableMessages(
category: $category,
exposedOnly: $exposedOnly
) {
key
category
englishMessage
exposeForCustomization
translations {
...TranslationVariantTypeFragment
}
customizedTranslations {
...CustomizedTranslationTypeFragment
}
}
}
Variables
{"category": "xyz789", "exposedOnly": true}
Response
{
"data": {
"translatableMessages": [
{
"key": "xyz789",
"category": "abc123",
"englishMessage": "abc123",
"exposeForCustomization": false,
"translations": [TranslationVariantType],
"customizedTranslations": [
CustomizedTranslationType
]
}
]
}
}
warehouses
Response
Returns [WarehouseType]
Example
Query
query warehouses {
warehouses {
id
name
address {
...AddressTypeFragment
}
}
}
Response
{
"data": {
"warehouses": [
{
"id": "4",
"name": "abc123",
"address": AddressType
}
]
}
}
Mutations
addPaymentMethod
Response
Returns an AddPaymentMethod
Arguments
| Name | Description |
|---|---|
stripePaymentMethodId - String!
|
Example
Query
mutation addPaymentMethod($stripePaymentMethodId: String!) {
addPaymentMethod(stripePaymentMethodId: $stripePaymentMethodId) {
paymentMethods {
...ShopPaymentMethodFragment
}
paymentMethod {
...ShopPaymentMethodFragment
}
success
errors {
...GQLErrorTypeFragment
}
}
}
Variables
{"stripePaymentMethodId": "abc123"}
Response
{
"data": {
"addPaymentMethod": {
"paymentMethods": [ShopPaymentMethod],
"paymentMethod": ShopPaymentMethod,
"success": false,
"errors": [GQLErrorType]
}
}
}
archiveReturns
Use updateReturn or returnUpdateStatus mutations instead
Response
Returns an ArchiveReturns
Example
Query
mutation archiveReturns(
$archive: Boolean!,
$returnIds: [ID]!
) {
archiveReturns(
archive: $archive,
returnIds: $returnIds
) {
success
}
}
Variables
{"archive": false, "returnIds": ["4"]}
Response
{"data": {"archiveReturns": {"success": true}}}
completeOnboarding
Response
Returns a CompleteOnboarding
Example
Query
mutation completeOnboarding {
completeOnboarding {
success
shop {
...AuthenticatedShopFragment
}
}
}
Response
{
"data": {
"completeOnboarding": {
"success": true,
"shop": AuthenticatedShop
}
}
}
createSetupIntent
Response
Returns a CreateSetupIntent
Example
Query
mutation createSetupIntent {
createSetupIntent {
setupIntent {
...SetupIntentResponseTypeFragment
}
errors {
...GQLErrorTypeFragment
}
}
}
Response
{
"data": {
"createSetupIntent": {
"setupIntent": SetupIntentResponseType,
"errors": [GQLErrorType]
}
}
}
deleteTranslationOverride
Description
Delete a customized translation (revert to default)
Response
Returns a DeleteTranslationOverride
Example
Query
mutation deleteTranslationOverride(
$key: String!,
$languageCode: String!
) {
deleteTranslationOverride(
key: $key,
languageCode: $languageCode
) {
success
error
}
}
Variables
{
"key": "xyz789",
"languageCode": "abc123"
}
Response
{
"data": {
"deleteTranslationOverride": {
"success": true,
"error": "xyz789"
}
}
}
easyPostAccountUpdate
Response
Returns an EasyPostAccountMutation
Example
Query
mutation easyPostAccountUpdate(
$destinationCountries: [String],
$id: ID!,
$originCountries: [String],
$useIsReturn: Boolean!
) {
easyPostAccountUpdate(
destinationCountries: $destinationCountries,
id: $id,
originCountries: $originCountries,
useIsReturn: $useIsReturn
) {
error
easyPostAccount {
...EasyPostAccountTypeFragment
}
}
}
Variables
{
"destinationCountries": ["xyz789"],
"id": "4",
"originCountries": ["xyz789"],
"useIsReturn": false
}
Response
{
"data": {
"easyPostAccountUpdate": {
"error": "abc123",
"easyPostAccount": EasyPostAccountType
}
}
}
easyPostCarrierServiceUpdate
Response
Returns an EasyPostAccountCarrierServiceMutation
Arguments
| Name | Description |
|---|---|
services - [EasyPostCarrierServiceUpdateType]!
|
Example
Query
mutation easyPostCarrierServiceUpdate($services: [EasyPostCarrierServiceUpdateType]!) {
easyPostCarrierServiceUpdate(services: $services) {
error
services {
...EasyPostAccountCarrierServiceTypeFragment
}
}
}
Variables
{"services": [EasyPostCarrierServiceUpdateType]}
Response
{
"data": {
"easyPostCarrierServiceUpdate": {
"error": "abc123",
"services": [EasyPostAccountCarrierServiceType]
}
}
}
easyPostCarrierUpdate
Response
Returns an EasyPostCarrierMutation
Arguments
| Name | Description |
|---|---|
easyPostCarriers - [EasyPostCarrierUpdateType]!
|
Example
Query
mutation easyPostCarrierUpdate($easyPostCarriers: [EasyPostCarrierUpdateType]!) {
easyPostCarrierUpdate(easyPostCarriers: $easyPostCarriers) {
error
easyPostCarriers {
...EasyPostCarrierTypeFragment
}
}
}
Variables
{"easyPostCarriers": [EasyPostCarrierUpdateType]}
Response
{
"data": {
"easyPostCarrierUpdate": {
"error": "abc123",
"easyPostCarriers": [EasyPostCarrierType]
}
}
}
exchangeOrderBulkComplete
Use releaseExchangeItems instead
Description
Complete a list of exchange orders in Shopify and update the exchange order status in RZ
Response
Returns a ReleaseExchangeItemsMutation
Example
Query
mutation exchangeOrderBulkComplete(
$exchangeItemIds: [ID!],
$exchangeOrderIds: [ID!],
$returnId: ID,
$returnItemIds: [ID!]
) {
exchangeOrderBulkComplete(
exchangeItemIds: $exchangeItemIds,
exchangeOrderIds: $exchangeOrderIds,
returnId: $returnId,
returnItemIds: $returnItemIds
) {
errors
exchangeOrders {
...ExchangeOrderFragment
}
exchangeItems {
...ExchangeItemFragment
}
return_ {
...ReturnFragment
}
}
}
Variables
{
"exchangeItemIds": [4],
"exchangeOrderIds": ["4"],
"returnId": 4,
"returnItemIds": ["4"]
}
Response
{
"data": {
"exchangeOrderBulkComplete": {
"errors": ["xyz789"],
"exchangeOrders": [ExchangeOrder],
"exchangeItems": [ExchangeItem],
"return_": Return
}
}
}
generatePortalImageUploadUrl
Response
Returns an GeneratePortalImageUploadURL
Example
Query
mutation generatePortalImageUploadUrl(
$contentType: String!,
$filename: String!,
$imageType: String!
) {
generatePortalImageUploadUrl(
contentType: $contentType,
filename: $filename,
imageType: $imageType
) {
errors {
...GQLErrorTypeFragment
}
uploadUrl {
...SignedUrlFragment
}
imagePath
}
}
Variables
{
"contentType": "abc123",
"filename": "abc123",
"imageType": "xyz789"
}
Response
{
"data": {
"generatePortalImageUploadUrl": {
"errors": [GQLErrorType],
"uploadUrl": SignedUrl,
"imagePath": "abc123"
}
}
}
generateShippingLabelUploadUrl
Response
Returns an GenerateShippingLabelUploadURL
Example
Query
mutation generateShippingLabelUploadUrl(
$contentType: String!,
$fileName: String!
) {
generateShippingLabelUploadUrl(
contentType: $contentType,
fileName: $fileName
) {
error
url {
...SignedUrlFragment
}
}
}
Variables
{
"contentType": "xyz789",
"fileName": "xyz789"
}
Response
{
"data": {
"generateShippingLabelUploadUrl": {
"error": "xyz789",
"url": SignedUrl
}
}
}
generateUploadUrl
Use generate_shipping_label_upload_url instead
Response
Returns an GenerateShippingLabelUploadURL
Example
Query
mutation generateUploadUrl(
$contentType: String!,
$fileName: String!
) {
generateUploadUrl(
contentType: $contentType,
fileName: $fileName
) {
error
url {
...SignedUrlFragment
}
}
}
Variables
{
"contentType": "xyz789",
"fileName": "xyz789"
}
Response
{
"data": {
"generateUploadUrl": {
"error": "abc123",
"url": SignedUrl
}
}
}
loadBalance
Response
Returns a LoadBalance
Example
Query
mutation loadBalance(
$amount: Decimal!,
$paymentMethodId: ID!
) {
loadBalance(
amount: $amount,
paymentMethodId: $paymentMethodId
) {
success
message
ledgerEntryId
errors {
...GQLErrorTypeFragment
}
}
}
Variables
{
"amount": Decimal,
"paymentMethodId": "4"
}
Response
{
"data": {
"loadBalance": {
"success": true,
"message": "xyz789",
"ledgerEntryId": 4,
"errors": [GQLErrorType]
}
}
}
orderInvoiceSend
Response
Returns an OrderInvoiceSend
Example
Query
mutation orderInvoiceSend(
$exchangeOrderId: ID,
$returnId: ID
) {
orderInvoiceSend(
exchangeOrderId: $exchangeOrderId,
returnId: $returnId
) {
errors {
...GQLErrorTypeFragment
}
}
}
Variables
{"exchangeOrderId": null, "returnId": null}
Response
{"data": {"orderInvoiceSend": {"errors": [GQLErrorType]}}}
packageCreate
Response
Returns a PackageCreate
Arguments
| Name | Description |
|---|---|
package - PackageInput!
|
Example
Query
mutation packageCreate($package: PackageInput!) {
packageCreate(package: $package) {
package {
...PackageTypeFragment
}
}
}
Variables
{"package": PackageInput}
Response
{"data": {"packageCreate": {"package": PackageType}}}
packageDelete
Response
Returns a PackageDelete
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation packageDelete($id: ID!) {
packageDelete(id: $id) {
error
}
}
Variables
{"id": 4}
Response
{
"data": {
"packageDelete": {"error": "xyz789"}
}
}
packageUpdate
Response
Returns a PackageUpdate
Arguments
| Name | Description |
|---|---|
package - PackageInput!
|
Example
Query
mutation packageUpdate($package: PackageInput!) {
packageUpdate(package: $package) {
error
package {
...PackageTypeFragment
}
}
}
Variables
{"package": PackageInput}
Response
{
"data": {
"packageUpdate": {
"error": "abc123",
"package": PackageType
}
}
}
questionCreate
Response
Returns a CreateOrUpdateQuestion
Arguments
| Name | Description |
|---|---|
question - QuestionInput!
|
Example
Query
mutation questionCreate($question: QuestionInput!) {
questionCreate(question: $question) {
question {
...QuestionFragment
}
}
}
Variables
{"question": QuestionInput}
Response
{"data": {"questionCreate": {"question": Question}}}
questionDelete
Response
Returns a DeleteQuestion
Arguments
| Name | Description |
|---|---|
questionId - ID!
|
Example
Query
mutation questionDelete($questionId: ID!) {
questionDelete(questionId: $questionId) {
success
}
}
Variables
{"questionId": "4"}
Response
{"data": {"questionDelete": {"success": true}}}
questionUpdate
Response
Returns a CreateOrUpdateQuestion
Arguments
| Name | Description |
|---|---|
question - QuestionInput!
|
Example
Query
mutation questionUpdate($question: QuestionInput!) {
questionUpdate(question: $question) {
question {
...QuestionFragment
}
}
}
Variables
{"question": QuestionInput}
Response
{"data": {"questionUpdate": {"question": Question}}}
registerUser
Description
This mutation takes a session token from the frontend and uses it to retrieve more details about the user. Those details are then used to create or update the user's profile.
Response
Returns a RegisterUser
Arguments
| Name | Description |
|---|---|
sessionToken - String
|
The session token from createApp().getSessionToken() |
Example
Query
mutation registerUser($sessionToken: String) {
registerUser(sessionToken: $sessionToken) {
user {
...ShopifyUserFragment
}
}
}
Variables
{"sessionToken": "xyz789"}
Response
{"data": {"registerUser": {"user": ShopifyUser}}}
releaseExchangeItems
Description
Release exchange items to be fulfilled.
Response
Returns a ReleaseExchangeItemsMutation
Example
Query
mutation releaseExchangeItems(
$exchangeItemIds: [ID!],
$exchangeOrderIds: [ID!],
$returnId: ID,
$returnItemIds: [ID!]
) {
releaseExchangeItems(
exchangeItemIds: $exchangeItemIds,
exchangeOrderIds: $exchangeOrderIds,
returnId: $returnId,
returnItemIds: $returnItemIds
) {
errors
exchangeOrders {
...ExchangeOrderFragment
}
exchangeItems {
...ExchangeItemFragment
}
return_ {
...ReturnFragment
}
}
}
Variables
{
"exchangeItemIds": ["4"],
"exchangeOrderIds": ["4"],
"returnId": "4",
"returnItemIds": ["4"]
}
Response
{
"data": {
"releaseExchangeItems": {
"errors": ["xyz789"],
"exchangeOrders": [ExchangeOrder],
"exchangeItems": [ExchangeItem],
"return_": Return
}
}
}
resendRmaForm
Response
Returns an ResendRMAForm
Arguments
| Name | Description |
|---|---|
returnId - ID!
|
Example
Query
mutation resendRmaForm($returnId: ID!) {
resendRmaForm(returnId: $returnId) {
error
}
}
Variables
{"returnId": 4}
Response
{
"data": {
"resendRmaForm": {"error": "abc123"}
}
}
returnApprove
Response
Returns an ApproveReturn
Example
Query
mutation returnApprove(
$customRmaNumber: String,
$externalShippingLabelUrl: String,
$noShippingRequired: Boolean,
$returnId: ID!
) {
returnApprove(
customRmaNumber: $customRmaNumber,
externalShippingLabelUrl: $externalShippingLabelUrl,
noShippingRequired: $noShippingRequired,
returnId: $returnId
) {
error
errorText
return {
...ReturnFragment
}
}
}
Variables
{
"customRmaNumber": "xyz789",
"externalShippingLabelUrl": "abc123",
"noShippingRequired": null,
"returnId": 4
}
Response
{
"data": {
"returnApprove": {
"error": "xyz789",
"errorText": "xyz789",
"return": Return
}
}
}
returnCreateStoreCredit
Response
Returns a CreateReturnStoreCreditMutation
Arguments
| Name | Description |
|---|---|
amount - Decimal!
|
|
bonusCredit - Decimal
|
Bonus credit amount to issue separately via storeCreditAccountCredit |
handlingFee - Decimal
|
Handling fee charged for the return |
notifyCustomer - Boolean
|
|
refundShipping - Boolean!
|
|
restockingFee - Decimal
|
Restocking fee charged for the return |
returnItemIds - [ID!]!
|
Example
Query
mutation returnCreateStoreCredit(
$amount: Decimal!,
$bonusCredit: Decimal,
$handlingFee: Decimal,
$notifyCustomer: Boolean,
$refundShipping: Boolean!,
$restockingFee: Decimal,
$returnItemIds: [ID!]!
) {
returnCreateStoreCredit(
amount: $amount,
bonusCredit: $bonusCredit,
handlingFee: $handlingFee,
notifyCustomer: $notifyCustomer,
refundShipping: $refundShipping,
restockingFee: $restockingFee,
returnItemIds: $returnItemIds
) {
error
errorText
return {
...ReturnFragment
}
storeCredit {
...StoreCreditTypeFragment
}
}
}
Variables
{
"amount": Decimal,
"bonusCredit": Decimal,
"handlingFee": Decimal,
"notifyCustomer": true,
"refundShipping": false,
"restockingFee": Decimal,
"returnItemIds": ["4"]
}
Response
{
"data": {
"returnCreateStoreCredit": {
"error": "abc123",
"errorText": "xyz789",
"return": Return,
"storeCredit": StoreCreditType
}
}
}
returnDispose
Description
Dispose a return items in Shopify. This will create disposition for each return item in Shopify. Used for restocking items and for marking items as missing in Return. This action is irreversible, once a return item is disposed it cannot be undone.
Response
Returns a DisposeReturn
Arguments
| Name | Description |
|---|---|
dispositionType - DispositionType!
|
|
returnId - ID!
|
|
returnItemIds - [ID!]!
|
|
shopifyLocationId - ID!
|
Example
Query
mutation returnDispose(
$dispositionType: DispositionType!,
$returnId: ID!,
$returnItemIds: [ID!]!,
$shopifyLocationId: ID!
) {
returnDispose(
dispositionType: $dispositionType,
returnId: $returnId,
returnItemIds: $returnItemIds,
shopifyLocationId: $shopifyLocationId
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"dispositionType": "MISSING",
"returnId": "4",
"returnItemIds": ["4"],
"shopifyLocationId": 4
}
Response
{
"data": {
"returnDispose": {
"error": "xyz789",
"return": Return
}
}
}
returnExport
Response
Returns a ReturnExport
Arguments
| Name | Description |
|---|---|
filters - FiltersInput
|
|
returnIds - [ID]!
|
Specific return IDs to update. If empty, filters are used to resolve returns. |
Example
Query
mutation returnExport(
$filters: FiltersInput,
$returnIds: [ID]!
) {
returnExport(
filters: $filters,
returnIds: $returnIds
) {
success
queued
eventName
url
message
}
}
Variables
{"filters": FiltersInput, "returnIds": [4]}
Response
{
"data": {
"returnExport": {
"success": true,
"queued": false,
"eventName": "abc123",
"url": "xyz789",
"message": "xyz789"
}
}
}
returnItemBulkDelete
Description
Delete multiple return items
Response
Returns a ReturnItemBulkDelete
Arguments
| Name | Description |
|---|---|
returnItemIds - [ID]!
|
Example
Query
mutation returnItemBulkDelete($returnItemIds: [ID]!) {
returnItemBulkDelete(returnItemIds: $returnItemIds) {
error
return {
...ReturnFragment
}
}
}
Variables
{"returnItemIds": ["4"]}
Response
{
"data": {
"returnItemBulkDelete": {
"error": "xyz789",
"return": Return
}
}
}
returnItemBulkUpdate
Description
Update multiple return items at once
Response
Returns a ReturnItemBulkUpdate
Arguments
| Name | Description |
|---|---|
returnItemIds - [ID]!
|
|
updateField - ReturnItemBulkUpdateInput!
|
Example
Query
mutation returnItemBulkUpdate(
$returnItemIds: [ID]!,
$updateField: ReturnItemBulkUpdateInput!
) {
returnItemBulkUpdate(
returnItemIds: $returnItemIds,
updateField: $updateField
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"returnItemIds": ["4"],
"updateField": ReturnItemBulkUpdateInput
}
Response
{
"data": {
"returnItemBulkUpdate": {
"error": "abc123",
"return": Return
}
}
}
returnItemDelete
Response
Returns a ReturnItemDelete
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation returnItemDelete($id: ID!) {
returnItemDelete(id: $id) {
error
return {
...ReturnFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"returnItemDelete": {
"error": "abc123",
"return": Return
}
}
}
returnItemManuallyResolveUpdate
Description
Used to update the line items of return isResolved field to true or false
Response
Returns an UpdateResolveReturnItems
Arguments
| Name | Description |
|---|---|
handlingFee - Decimal
|
Handling fee charged for the return |
isResolved - Boolean!
|
Resolved or not, this applies to all the return items |
restockingFee - Decimal
|
Restocking fee charged for the return |
returnId - ID!
|
|
returnItemIds - [ID]!
|
List of return items that should be updated |
Example
Query
mutation returnItemManuallyResolveUpdate(
$handlingFee: Decimal,
$isResolved: Boolean!,
$restockingFee: Decimal,
$returnId: ID!,
$returnItemIds: [ID]!
) {
returnItemManuallyResolveUpdate(
handlingFee: $handlingFee,
isResolved: $isResolved,
restockingFee: $restockingFee,
returnId: $returnId,
returnItemIds: $returnItemIds
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"handlingFee": Decimal,
"isResolved": true,
"restockingFee": Decimal,
"returnId": "4",
"returnItemIds": ["4"]
}
Response
{
"data": {
"returnItemManuallyResolveUpdate": {
"error": "abc123",
"return": Return
}
}
}
returnItemMissingUpdate
Description
Used to update the line items of return isMissing field to true or false
Response
Returns an UpdateMissingReturnItems
Example
Query
mutation returnItemMissingUpdate(
$isMissing: Boolean!,
$returnId: ID!,
$returnItemIds: [ID]!
) {
returnItemMissingUpdate(
isMissing: $isMissing,
returnId: $returnId,
returnItemIds: $returnItemIds
) {
error
return {
...ReturnFragment
}
}
}
Variables
{"isMissing": false, "returnId": 4, "returnItemIds": [4]}
Response
{
"data": {
"returnItemMissingUpdate": {
"error": "abc123",
"return": Return
}
}
}
returnItemUpdate
Response
Returns a ReturnItemUpdate
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
item - ReturnItemUpdateInput!
|
Example
Query
mutation returnItemUpdate(
$id: ID!,
$item: ReturnItemUpdateInput!
) {
returnItemUpdate(
id: $id,
item: $item
) {
error
return {
...ReturnFragment
}
}
}
Variables
{"id": 4, "item": ReturnItemUpdateInput}
Response
{
"data": {
"returnItemUpdate": {
"error": "xyz789",
"return": Return
}
}
}
returnItemUpdateSkipRestock
Response
Returns a ReturnItemUpdateSkipRestock
Example
Query
mutation returnItemUpdateSkipRestock(
$returnItemIds: [ID]!,
$skipRestock: Boolean!
) {
returnItemUpdateSkipRestock(
returnItemIds: $returnItemIds,
skipRestock: $skipRestock
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"returnItemIds": ["4"],
"skipRestock": false
}
Response
{
"data": {
"returnItemUpdateSkipRestock": {
"error": "xyz789",
"return": Return
}
}
}
returnLogUpdate
Response
Returns a ReturnLogUpdate
Example
Query
mutation returnLogUpdate(
$comment: String,
$logId: ID,
$returnId: ID!
) {
returnLogUpdate(
comment: $comment,
logId: $logId,
returnId: $returnId
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"comment": "xyz789",
"logId": 4,
"returnId": "4"
}
Response
{
"data": {
"returnLogUpdate": {
"error": "xyz789",
"return": Return
}
}
}
returnReceived
Description
Update the return stage to Received. Also, marks missing line items as missing.
Response
Returns a ReceivedReturn
Example
Query
mutation returnReceived(
$missingReturnItemIds: [ID],
$resolvedReturnItemIds: [ID],
$returnId: ID!
) {
returnReceived(
missingReturnItemIds: $missingReturnItemIds,
resolvedReturnItemIds: $resolvedReturnItemIds,
returnId: $returnId
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"missingReturnItemIds": [4],
"resolvedReturnItemIds": [4],
"returnId": "4"
}
Response
{
"data": {
"returnReceived": {
"error": "abc123",
"return": Return
}
}
}
returnRefund
Response
Returns a RefundReturn
Example
Query
mutation returnRefund(
$handlingFee: Decimal,
$notifyCustomer: Boolean!,
$refundCurrency: String!,
$refundFullAmount: Decimal!,
$refundShipping: Boolean!,
$restockingFee: Decimal,
$returnId: ID!,
$returnItemIds: [ID!]!
) {
returnRefund(
handlingFee: $handlingFee,
notifyCustomer: $notifyCustomer,
refundCurrency: $refundCurrency,
refundFullAmount: $refundFullAmount,
refundShipping: $refundShipping,
restockingFee: $restockingFee,
returnId: $returnId,
returnItemIds: $returnItemIds
) {
error
return {
...ReturnFragment
}
refund {
...RefundTypeFragment
}
}
}
Variables
{
"handlingFee": Decimal,
"notifyCustomer": true,
"refundCurrency": "xyz789",
"refundFullAmount": Decimal,
"refundShipping": true,
"restockingFee": Decimal,
"returnId": "4",
"returnItemIds": ["4"]
}
Response
{
"data": {
"returnRefund": {
"error": "xyz789",
"return": Return,
"refund": RefundType
}
}
}
returnReject
Response
Returns a RejectReturn
Example
Query
mutation returnReject(
$allowResubmission: Boolean,
$rejectionReason: String,
$returnId: ID!
) {
returnReject(
allowResubmission: $allowResubmission,
rejectionReason: $rejectionReason,
returnId: $returnId
) {
error
return {
...ReturnFragment
}
}
}
Variables
{
"allowResubmission": false,
"rejectionReason": "xyz789",
"returnId": "4"
}
Response
{
"data": {
"returnReject": {
"error": "abc123",
"return": Return
}
}
}
returnRuleActiveToggle
Response
Returns a ReturnRuleActiveToggle
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation returnRuleActiveToggle($id: ID!) {
returnRuleActiveToggle(id: $id) {
error
}
}
Variables
{"id": 4}
Response
{
"data": {
"returnRuleActiveToggle": {
"error": "abc123"
}
}
}
returnRuleCreate
Response
Returns a ReturnRuleCreateOrUpdate
Arguments
| Name | Description |
|---|---|
returnRule - RuleInput!
|
Example
Query
mutation returnRuleCreate($returnRule: RuleInput!) {
returnRuleCreate(returnRule: $returnRule) {
error
returnRule {
...RuleFragment
}
}
}
Variables
{"returnRule": RuleInput}
Response
{
"data": {
"returnRuleCreate": {
"error": "xyz789",
"returnRule": Rule
}
}
}
returnRuleDelete
Response
Returns a ReturnRuleDelete
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation returnRuleDelete($id: ID!) {
returnRuleDelete(id: $id) {
error
}
}
Variables
{"id": "4"}
Response
{
"data": {
"returnRuleDelete": {"error": "abc123"}
}
}
returnRuleUpdate
Response
Returns a ReturnRuleCreateOrUpdate
Arguments
| Name | Description |
|---|---|
returnRule - RuleInput!
|
Example
Query
mutation returnRuleUpdate($returnRule: RuleInput!) {
returnRuleUpdate(returnRule: $returnRule) {
error
returnRule {
...RuleFragment
}
}
}
Variables
{"returnRule": RuleInput}
Response
{
"data": {
"returnRuleUpdate": {
"error": "abc123",
"returnRule": Rule
}
}
}
returnTransitionStage
Response
Returns a ReturnTransitionStage
Arguments
| Name | Description |
|---|---|
filters - FiltersInput
|
|
returnIds - [ID]!
|
Specific return IDs to update. If empty, filters are used to resolve returns. |
stageId - ID!
|
Example
Query
mutation returnTransitionStage(
$filters: FiltersInput,
$returnIds: [ID]!,
$stageId: ID!
) {
returnTransitionStage(
filters: $filters,
returnIds: $returnIds,
stageId: $stageId
) {
success
affectedReturnIds
}
}
Variables
{
"filters": FiltersInput,
"returnIds": ["4"],
"stageId": "4"
}
Response
{
"data": {
"returnTransitionStage": {"success": true, "affectedReturnIds": [123]}
}
}
returnUpdateStatus
Response
Returns a ReturnUpdateStatus
Arguments
| Name | Description |
|---|---|
filters - FiltersInput
|
|
isArchived - Boolean!
|
|
returnIds - [ID]!
|
Specific return IDs to update. If empty, filters are used to resolve returns. |
Example
Query
mutation returnUpdateStatus(
$filters: FiltersInput,
$isArchived: Boolean!,
$returnIds: [ID]!
) {
returnUpdateStatus(
filters: $filters,
isArchived: $isArchived,
returnIds: $returnIds
) {
success
affectedReturnIds
}
}
Variables
{
"filters": FiltersInput,
"isArchived": false,
"returnIds": ["4"]
}
Response
{"data": {"returnUpdateStatus": {"success": true, "affectedReturnIds": [123]}}}
returnsDelete
Response
Returns a DeleteReturns
Arguments
| Name | Description |
|---|---|
returnIds - [ID]!
|
Example
Query
mutation returnsDelete($returnIds: [ID]!) {
returnsDelete(returnIds: $returnIds) {
success
}
}
Variables
{"returnIds": [4]}
Response
{"data": {"returnsDelete": {"success": true}}}
returnsDeleteTestMode
Response
Returns a ReturnsDeleteTestMode
Example
Query
mutation returnsDeleteTestMode {
returnsDeleteTestMode {
success
shop {
...AuthenticatedShopFragment
}
}
}
Response
{
"data": {
"returnsDeleteTestMode": {
"success": true,
"shop": AuthenticatedShop
}
}
}
shipStationAccountUpdate
Response
Returns a ShipStationAccountMutation
Example
Query
mutation shipStationAccountUpdate(
$apiKey: String!,
$apiSecret: String!,
$services: String
) {
shipStationAccountUpdate(
apiKey: $apiKey,
apiSecret: $apiSecret,
services: $services
) {
error
fieldErrors {
...FieldErrorTypeFragment
}
account {
...ShipStationAccountTypeFragment
}
}
}
Variables
{
"apiKey": "abc123",
"apiSecret": "xyz789",
"services": "abc123"
}
Response
{
"data": {
"shipStationAccountUpdate": {
"error": "abc123",
"fieldErrors": [FieldErrorType],
"account": ShipStationAccountType
}
}
}
shipStationCarrierServiceUpdate
Response
Returns a ShipStationAccountCarrierServiceMutation
Arguments
| Name | Description |
|---|---|
services - [ShipStationCarrierServiceUpdateType]!
|
Example
Query
mutation shipStationCarrierServiceUpdate($services: [ShipStationCarrierServiceUpdateType]!) {
shipStationCarrierServiceUpdate(services: $services) {
error
services {
...ShipStationAccountCarrierServiceTypeFragment
}
}
}
Variables
{"services": [ShipStationCarrierServiceUpdateType]}
Response
{
"data": {
"shipStationCarrierServiceUpdate": {
"error": "xyz789",
"services": [ShipStationAccountCarrierServiceType]
}
}
}
shipStationCarrierUpdate
Response
Returns a ShipStationAccountCarrierMutation
Arguments
| Name | Description |
|---|---|
carriers - [ShipStationCarrierUpdateType]!
|
Example
Query
mutation shipStationCarrierUpdate($carriers: [ShipStationCarrierUpdateType]!) {
shipStationCarrierUpdate(carriers: $carriers) {
error
carriers {
...ShipStationAccountCarrierTypeFragment
}
}
}
Variables
{"carriers": [ShipStationCarrierUpdateType]}
Response
{
"data": {
"shipStationCarrierUpdate": {
"error": "xyz789",
"carriers": [ShipStationAccountCarrierType]
}
}
}
shippoAccountUpdate
Response
Returns a ShippoAccountMutation
Example
Query
mutation shippoAccountUpdate(
$services: String,
$useIsReturn: Boolean!
) {
shippoAccountUpdate(
services: $services,
useIsReturn: $useIsReturn
) {
error
account {
...ShippoAccountTypeFragment
}
}
}
Variables
{"services": "abc123", "useIsReturn": true}
Response
{
"data": {
"shippoAccountUpdate": {
"error": "abc123",
"account": ShippoAccountType
}
}
}
shippoCarrierServiceUpdate
Response
Returns a ShippoAccountCarrierServiceMutation
Arguments
| Name | Description |
|---|---|
services - [ShippoCarrierServiceUpdateType]!
|
Example
Query
mutation shippoCarrierServiceUpdate($services: [ShippoCarrierServiceUpdateType]!) {
shippoCarrierServiceUpdate(services: $services) {
error
services {
...ShippoAccountCarrierServiceTypeFragment
}
}
}
Variables
{"services": [ShippoCarrierServiceUpdateType]}
Response
{
"data": {
"shippoCarrierServiceUpdate": {
"error": "abc123",
"services": [ShippoAccountCarrierServiceType]
}
}
}
shippoCarrierUpdate
Response
Returns a ShippoAccountCarrierMutation
Arguments
| Name | Description |
|---|---|
carriers - [ShippoCarrierUpdateType]!
|
Example
Query
mutation shippoCarrierUpdate($carriers: [ShippoCarrierUpdateType]!) {
shippoCarrierUpdate(carriers: $carriers) {
error
carriers {
...ShippoAccountCarrierTypeFragment
}
}
}
Variables
{"carriers": [ShippoCarrierUpdateType]}
Response
{
"data": {
"shippoCarrierUpdate": {
"error": "abc123",
"carriers": [ShippoAccountCarrierType]
}
}
}
shopifyUsersBulkUpdate
Response
Returns a ShopifyUsersBulkUpdate
Arguments
| Name | Description |
|---|---|
updates - [ShopifyUserUpdateInput]!
|
Example
Query
mutation shopifyUsersBulkUpdate($updates: [ShopifyUserUpdateInput]!) {
shopifyUsersBulkUpdate(updates: $updates) {
users {
...ShopifyUserFragment
}
errors
}
}
Variables
{"updates": [ShopifyUserUpdateInput]}
Response
{
"data": {
"shopifyUsersBulkUpdate": {
"users": [ShopifyUser],
"errors": ["abc123"]
}
}
}
taxNumbersDelete
Response
Returns a DeleteTaxNumbers
Arguments
| Name | Description |
|---|---|
ids - [ID]!
|
Example
Query
mutation taxNumbersDelete($ids: [ID]!) {
taxNumbersDelete(ids: $ids) {
errors {
...GQLErrorTypeFragment
}
}
}
Variables
{"ids": ["4"]}
Response
{"data": {"taxNumbersDelete": {"errors": [GQLErrorType]}}}
taxNumbersPut
Response
Returns a PutTaxNumbers
Arguments
| Name | Description |
|---|---|
taxNumbers - [TaxNumberInput]!
|
Example
Query
mutation taxNumbersPut($taxNumbers: [TaxNumberInput]!) {
taxNumbersPut(taxNumbers: $taxNumbers) {
errors {
...GQLErrorTypeFragment
}
taxNumbers {
...TaxNumberOutputFragment
}
}
}
Variables
{"taxNumbers": [TaxNumberInput]}
Response
{
"data": {
"taxNumbersPut": {
"errors": [GQLErrorType],
"taxNumbers": [TaxNumberOutput]
}
}
}
updateBalanceSettings
Response
Returns an UpdateBalanceSettings
Example
Query
mutation updateBalanceSettings(
$autoRechargeAmount: Decimal,
$autoRechargeEnabled: Boolean,
$autoRechargeThreshold: Decimal,
$currency: String
) {
updateBalanceSettings(
autoRechargeAmount: $autoRechargeAmount,
autoRechargeEnabled: $autoRechargeEnabled,
autoRechargeThreshold: $autoRechargeThreshold,
currency: $currency
) {
balanceSettings {
...BalanceSettingsTypeFragment
}
errors {
...GQLErrorTypeFragment
}
}
}
Variables
{
"autoRechargeAmount": Decimal,
"autoRechargeEnabled": false,
"autoRechargeThreshold": Decimal,
"currency": "xyz789"
}
Response
{
"data": {
"updateBalanceSettings": {
"balanceSettings": BalanceSettingsType,
"errors": [GQLErrorType]
}
}
}
updatePaymentMethod
Response
Returns an UpdatePaymentMethod
Example
Query
mutation updatePaymentMethod(
$delete: Boolean!,
$isDefault: Boolean!,
$paymentMethodId: ID!
) {
updatePaymentMethod(
delete: $delete,
isDefault: $isDefault,
paymentMethodId: $paymentMethodId
) {
paymentMethod {
...ShopPaymentMethodFragment
}
success
errors {
...GQLErrorTypeFragment
}
}
}
Variables
{
"delete": true,
"isDefault": true,
"paymentMethodId": "4"
}
Response
{
"data": {
"updatePaymentMethod": {
"paymentMethod": ShopPaymentMethod,
"success": true,
"errors": [GQLErrorType]
}
}
}
updatePortalConfig
Response
Returns an UpdatePortalConfig
Arguments
| Name | Description |
|---|---|
logo - ImageInput
|
|
logoDark - ImageInput
|
|
lookupSideImage - ImageInput
|
|
lookupSideImageDark - ImageInput
|
|
lookupSideImageSameWidthAsLookupForm - Boolean
|
Example
Query
mutation updatePortalConfig(
$logo: ImageInput,
$logoDark: ImageInput,
$lookupSideImage: ImageInput,
$lookupSideImageDark: ImageInput,
$lookupSideImageSameWidthAsLookupForm: Boolean
) {
updatePortalConfig(
logo: $logo,
logoDark: $logoDark,
lookupSideImage: $lookupSideImage,
lookupSideImageDark: $lookupSideImageDark,
lookupSideImageSameWidthAsLookupForm: $lookupSideImageSameWidthAsLookupForm
) {
portalConfig {
...PortalConfigTypeFragment
}
error
}
}
Variables
{
"logo": ImageInput,
"logoDark": ImageInput,
"lookupSideImage": ImageInput,
"lookupSideImageDark": ImageInput,
"lookupSideImageSameWidthAsLookupForm": false
}
Response
{
"data": {
"updatePortalConfig": {
"portalConfig": PortalConfigType,
"error": "xyz789"
}
}
}
updateReturn
Response
Returns an UpdateReturn
Example
Query
mutation updateReturn(
$isArchived: Boolean!,
$returnId: Int!,
$stageId: ID!
) {
updateReturn(
isArchived: $isArchived,
returnId: $returnId,
stageId: $stageId
) {
success
ret {
...ReturnFragment
}
}
}
Variables
{"isArchived": false, "returnId": 123, "stageId": 4}
Response
{
"data": {
"updateReturn": {"success": true, "ret": Return}
}
}
updateSettings
Response
Returns an UpdateSettings
Arguments
| Name | Description |
|---|---|
allowGiftReturns - Boolean
|
Allow gift returns |
allowOutOfStockExchanges - Boolean
|
Allow exchanges for out of stock products |
autoProcessExchangesOnCreation - Boolean
|
Automatically process and reserve exchange items from stock when return is created |
automatedStoreCreditType - AutomatedStoreCreditType
|
|
barcodeValue - BarcodeValue
|
|
carryDiscountForwardType - CarryDiscountForwardType
|
|
cartonizationLengthUnit - LengthUnit
|
|
creditPortalDisplayOrder - Int
|
|
customerEmailContent - String
|
|
customerEmailDisplayFromName - String
|
|
customerEmailReplyToAddress - String
|
|
customerLabelFlatFee - Decimal
|
Flat fee to charge for each label when using store mode |
customerPaidShippingMode - CustomerPaidShippingMode
|
Mode for customer-paid shipping |
defaultAddress - AddressInput
|
|
defaultExchangeFee - Decimal
|
|
defaultRefundFee - Decimal
|
|
defaultStoreCreditFee - Decimal
|
|
defaultWarehouseForPosReturns - ID
|
|
defaultWeight - Decimal
|
|
defaultWeightUnit - String
|
|
delayedShopifyReturnCreationEnabled - Boolean
|
|
discountSameProductExchangesToBeEqual - Boolean
|
|
dynamicTranslations - [DynamicTranslationInput]
|
|
easypostApiKey - String
|
|
enableCustomRmaNumber - Boolean
|
|
enableExchange - Boolean
|
|
enableRefund - Boolean
|
|
enableStoreCredit - Boolean
|
|
exchangeCheckInventoryAtFulfillmentLocation - Boolean
|
Limit exchange inventory to original fulfillment location ID(s). Requires READ_INVENTORY scope. |
exchangeCommentsEnabled - Boolean
|
|
exchangeCommentsRequired - Boolean
|
|
exchangeDays - Int
|
|
exchangeDaysToReserveStock - Int
|
Number of days to reserve stock for exchange |
exchangeDaysType - DaysType
|
|
exchangeExcludeTags - [String]
|
|
exchangeMethod - ExchangeMethod
|
|
exchangeNormalizeCrossProductEqualPrices - Boolean
|
|
exchangePortalDisplayOrder - Int
|
|
exchangeRequireDeliveryBeforeReturn - Boolean
|
Prevent exchanges for items not yet delivered |
exchangeRoundToZeroIfLteTo - Decimal
|
|
exchangeShipmentOrderSuffix - String
|
|
exchangeShippingLineTitle - String
|
|
exchangeUpsellDiscountPercentage - Decimal
|
|
exchangeUpsellEnabled - Boolean
|
|
expirationPeriodType - ExpirationPeriodType
|
|
expirationPreventionAction - ExpirationPreventionAction
|
|
giftCardPrefix - String
|
|
giftReturnsExchangeEnabled - Boolean
|
Enable exchanges for gift returns |
giftReturnsStoreCreditEnabled - Boolean
|
Enable store credit for gift returns |
gorgiasSubdomain - String
|
|
instructions - String
|
|
international - Boolean
|
|
internationalCustomsContentValueSource - CustomsContentValueSource
|
|
internationalCustomsSigner - String
|
|
internationalDefaultHarmonizedSystemCode - String
|
|
internationalExemptionCode - String
|
|
internationalNonDeliveryOption - String
|
|
internationalOriginCountry - String
|
|
isCartonizationEnabled - Boolean
|
|
isDefaultFeeEqualsShippingCost - Boolean
|
|
isExchangeDifferentialPricingEnabled - Boolean
|
Enable exchange differential pricing. |
isExchangeIntegrationEnabled - Boolean
|
Integration with Shopify Exchange |
isFullCatalogExchangeEnabled - Boolean
|
Enable full catalog exchange |
isInlineExchangeEnabled - Boolean
|
Enable inline exchange on the portal |
isNoShippingReturnEnabled - Boolean
|
|
isQrCodeEnabled - Boolean
|
|
isRefundIntegrationEnabled - Boolean
|
Integration with Shopify Refund |
isRestockIntegrationEnabled - Boolean
|
Integration with Shopify Restock |
isReturnItemExpirationEnabled - Boolean
|
|
isShippingLabelUploadAllowed - Boolean
|
|
isStoreCreditIncentiveEnabled - Boolean
|
|
isStoreCreditIncentiveRoundToNearest - Boolean
|
|
isStoreCreditIntegrationEnabled - Boolean
|
Integration with Shopify Store Credit |
klaviyoApiKey - String
|
|
maxFilesPerReturn - Int
|
|
maxStoreCreditIncentiveAmount - Decimal
|
|
minFilesPerReturn - Int
|
|
minStoreCreditIncentiveAmount - Decimal
|
|
notificationEmailAddress - String
|
|
notificationEmailAttachRma - Boolean
|
|
notifications - [NotificationInput]
|
|
notifyOnlyIfApprovalIsRequired - Boolean
|
|
onboardingComplete - Boolean
|
|
paidShippingFee - Decimal
|
|
portalCustomizations - JSONString
|
|
portalExchangeSelectionMethod - PortalExchangeSelectionMethod
|
|
portalFrenchUseAlternative - Boolean
|
|
portalGermanUseAlternative - Boolean
|
|
portalItalianUseAlternative - Boolean
|
|
portalLanguage - String
|
|
portalTheme - String
|
|
portalVisualExchangeExcludeCollections - [String]
|
|
portalVisualExchangeIncludeCollections - [String]
|
|
portalVisualExchangeType - PortalVisualExchangeType
|
|
prepaidShippingFee - Decimal
|
|
preventReturnsFromDifferentFulfillments - Boolean
|
Prevent items from different fulfillments from being returned together |
primaryFieldBehavior - PrimaryFieldBehavior
|
|
questions - [QuestionInput]
|
|
refField1Source - RefFieldSource
|
|
refField2Source - RefFieldSource
|
|
refundCommentsEnabled - Boolean
|
|
refundCommentsRequired - Boolean
|
|
refundDays - Int
|
|
refundDaysType - DaysType
|
|
refundPortalDisplayOrder - Int
|
|
refundRequireDeliveryBeforeReturn - Boolean
|
Prevent refunds for items not yet delivered |
requireApprovalForAllReturns - Boolean
|
|
resolvePartialExchangeRefundsToStoreCredit - Boolean
|
|
restockingFeeDefinedAsPercentage - Boolean
|
|
restockingFeeType - RestockingFeeType
|
|
returnItemExpirationDays - Int
|
|
returnReasons - [ReturnReasonInput]
|
|
secondaryFieldBehavior - SecondaryFieldBehavior
|
|
selfShippingFee - Decimal
|
|
shipFree - Boolean
|
|
shipPay - Boolean
|
|
shipSelf - Boolean
|
|
shippingRateSelectLowestRate - Boolean
|
|
shippingRateShowUpToPercentage - Decimal
|
|
shippoApiKey - String
|
|
shouldDisplayFeesInPortal - Boolean
|
|
showPortalSummary - Boolean
|
|
stageShipmentStatuses - [StageShipmentStatusInput]
|
|
stages - [StageInput]
|
|
storeCreditCommentsEnabled - Boolean
|
|
storeCreditCommentsRequired - Boolean
|
|
storeCreditDays - Int
|
|
storeCreditDaysType - DaysType
|
|
storeCreditExpireDays - Int
|
|
storeCreditIncentivePercentage - Decimal
|
|
storeCreditIncentiveType - StoreCreditIncentiveType
|
|
storeCreditRequireDeliveryBeforeReturn - Boolean
|
Prevent store credit returns for items not yet delivered |
stripePublishableKey - String
|
|
stripeSecretKey - String
|
|
useApprovals - Boolean
|
|
useBillingAddressFallback - Boolean
|
Fall back to billing address when shipping address is missing |
useConsolidatedOrderExchanges - Boolean
|
|
useExchangeShipmentOrders - Boolean
|
|
useShippingByReturnzap - Boolean
|
|
useShopAddressForPosReturns - Boolean
|
|
userPermissionsEnabled - Boolean
|
Enable user permissions |
webhookEvents - [WebhookEventType]
|
|
webhookUrl - String
|
Example
Query
mutation updateSettings(
$allowGiftReturns: Boolean,
$allowOutOfStockExchanges: Boolean,
$autoProcessExchangesOnCreation: Boolean,
$automatedStoreCreditType: AutomatedStoreCreditType,
$barcodeValue: BarcodeValue,
$carryDiscountForwardType: CarryDiscountForwardType,
$cartonizationLengthUnit: LengthUnit,
$creditPortalDisplayOrder: Int,
$customerEmailContent: String,
$customerEmailDisplayFromName: String,
$customerEmailReplyToAddress: String,
$customerLabelFlatFee: Decimal,
$customerPaidShippingMode: CustomerPaidShippingMode,
$defaultAddress: AddressInput,
$defaultExchangeFee: Decimal,
$defaultRefundFee: Decimal,
$defaultStoreCreditFee: Decimal,
$defaultWarehouseForPosReturns: ID,
$defaultWeight: Decimal,
$defaultWeightUnit: String,
$delayedShopifyReturnCreationEnabled: Boolean,
$discountSameProductExchangesToBeEqual: Boolean,
$dynamicTranslations: [DynamicTranslationInput],
$easypostApiKey: String,
$enableCustomRmaNumber: Boolean,
$enableExchange: Boolean,
$enableRefund: Boolean,
$enableStoreCredit: Boolean,
$exchangeCheckInventoryAtFulfillmentLocation: Boolean,
$exchangeCommentsEnabled: Boolean,
$exchangeCommentsRequired: Boolean,
$exchangeDays: Int,
$exchangeDaysToReserveStock: Int,
$exchangeDaysType: DaysType,
$exchangeExcludeTags: [String],
$exchangeMethod: ExchangeMethod,
$exchangeNormalizeCrossProductEqualPrices: Boolean,
$exchangePortalDisplayOrder: Int,
$exchangeRequireDeliveryBeforeReturn: Boolean,
$exchangeRoundToZeroIfLteTo: Decimal,
$exchangeShipmentOrderSuffix: String,
$exchangeShippingLineTitle: String,
$exchangeUpsellDiscountPercentage: Decimal,
$exchangeUpsellEnabled: Boolean,
$expirationPeriodType: ExpirationPeriodType,
$expirationPreventionAction: ExpirationPreventionAction,
$giftCardPrefix: String,
$giftReturnsExchangeEnabled: Boolean,
$giftReturnsStoreCreditEnabled: Boolean,
$gorgiasSubdomain: String,
$instructions: String,
$international: Boolean,
$internationalCustomsContentValueSource: CustomsContentValueSource,
$internationalCustomsSigner: String,
$internationalDefaultHarmonizedSystemCode: String,
$internationalExemptionCode: String,
$internationalNonDeliveryOption: String,
$internationalOriginCountry: String,
$isCartonizationEnabled: Boolean,
$isDefaultFeeEqualsShippingCost: Boolean,
$isExchangeDifferentialPricingEnabled: Boolean,
$isExchangeIntegrationEnabled: Boolean,
$isFullCatalogExchangeEnabled: Boolean,
$isInlineExchangeEnabled: Boolean,
$isNoShippingReturnEnabled: Boolean,
$isQrCodeEnabled: Boolean,
$isRefundIntegrationEnabled: Boolean,
$isRestockIntegrationEnabled: Boolean,
$isReturnItemExpirationEnabled: Boolean,
$isShippingLabelUploadAllowed: Boolean,
$isStoreCreditIncentiveEnabled: Boolean,
$isStoreCreditIncentiveRoundToNearest: Boolean,
$isStoreCreditIntegrationEnabled: Boolean,
$klaviyoApiKey: String,
$maxFilesPerReturn: Int,
$maxStoreCreditIncentiveAmount: Decimal,
$minFilesPerReturn: Int,
$minStoreCreditIncentiveAmount: Decimal,
$notificationEmailAddress: String,
$notificationEmailAttachRma: Boolean,
$notifications: [NotificationInput],
$notifyOnlyIfApprovalIsRequired: Boolean,
$onboardingComplete: Boolean,
$paidShippingFee: Decimal,
$portalCustomizations: JSONString,
$portalExchangeSelectionMethod: PortalExchangeSelectionMethod,
$portalFrenchUseAlternative: Boolean,
$portalGermanUseAlternative: Boolean,
$portalItalianUseAlternative: Boolean,
$portalLanguage: String,
$portalTheme: String,
$portalVisualExchangeExcludeCollections: [String],
$portalVisualExchangeIncludeCollections: [String],
$portalVisualExchangeType: PortalVisualExchangeType,
$prepaidShippingFee: Decimal,
$preventReturnsFromDifferentFulfillments: Boolean,
$primaryFieldBehavior: PrimaryFieldBehavior,
$questions: [QuestionInput],
$refField1Source: RefFieldSource,
$refField2Source: RefFieldSource,
$refundCommentsEnabled: Boolean,
$refundCommentsRequired: Boolean,
$refundDays: Int,
$refundDaysType: DaysType,
$refundPortalDisplayOrder: Int,
$refundRequireDeliveryBeforeReturn: Boolean,
$requireApprovalForAllReturns: Boolean,
$resolvePartialExchangeRefundsToStoreCredit: Boolean,
$restockingFeeDefinedAsPercentage: Boolean,
$restockingFeeType: RestockingFeeType,
$returnItemExpirationDays: Int,
$returnReasons: [ReturnReasonInput],
$secondaryFieldBehavior: SecondaryFieldBehavior,
$selfShippingFee: Decimal,
$shipFree: Boolean,
$shipPay: Boolean,
$shipSelf: Boolean,
$shippingRateSelectLowestRate: Boolean,
$shippingRateShowUpToPercentage: Decimal,
$shippoApiKey: String,
$shouldDisplayFeesInPortal: Boolean,
$showPortalSummary: Boolean,
$stageShipmentStatuses: [StageShipmentStatusInput],
$stages: [StageInput],
$storeCreditCommentsEnabled: Boolean,
$storeCreditCommentsRequired: Boolean,
$storeCreditDays: Int,
$storeCreditDaysType: DaysType,
$storeCreditExpireDays: Int,
$storeCreditIncentivePercentage: Decimal,
$storeCreditIncentiveType: StoreCreditIncentiveType,
$storeCreditRequireDeliveryBeforeReturn: Boolean,
$stripePublishableKey: String,
$stripeSecretKey: String,
$useApprovals: Boolean,
$useBillingAddressFallback: Boolean,
$useConsolidatedOrderExchanges: Boolean,
$useExchangeShipmentOrders: Boolean,
$useShippingByReturnzap: Boolean,
$useShopAddressForPosReturns: Boolean,
$userPermissionsEnabled: Boolean,
$webhookEvents: [WebhookEventType],
$webhookUrl: String
) {
updateSettings(
allowGiftReturns: $allowGiftReturns,
allowOutOfStockExchanges: $allowOutOfStockExchanges,
autoProcessExchangesOnCreation: $autoProcessExchangesOnCreation,
automatedStoreCreditType: $automatedStoreCreditType,
barcodeValue: $barcodeValue,
carryDiscountForwardType: $carryDiscountForwardType,
cartonizationLengthUnit: $cartonizationLengthUnit,
creditPortalDisplayOrder: $creditPortalDisplayOrder,
customerEmailContent: $customerEmailContent,
customerEmailDisplayFromName: $customerEmailDisplayFromName,
customerEmailReplyToAddress: $customerEmailReplyToAddress,
customerLabelFlatFee: $customerLabelFlatFee,
customerPaidShippingMode: $customerPaidShippingMode,
defaultAddress: $defaultAddress,
defaultExchangeFee: $defaultExchangeFee,
defaultRefundFee: $defaultRefundFee,
defaultStoreCreditFee: $defaultStoreCreditFee,
defaultWarehouseForPosReturns: $defaultWarehouseForPosReturns,
defaultWeight: $defaultWeight,
defaultWeightUnit: $defaultWeightUnit,
delayedShopifyReturnCreationEnabled: $delayedShopifyReturnCreationEnabled,
discountSameProductExchangesToBeEqual: $discountSameProductExchangesToBeEqual,
dynamicTranslations: $dynamicTranslations,
easypostApiKey: $easypostApiKey,
enableCustomRmaNumber: $enableCustomRmaNumber,
enableExchange: $enableExchange,
enableRefund: $enableRefund,
enableStoreCredit: $enableStoreCredit,
exchangeCheckInventoryAtFulfillmentLocation: $exchangeCheckInventoryAtFulfillmentLocation,
exchangeCommentsEnabled: $exchangeCommentsEnabled,
exchangeCommentsRequired: $exchangeCommentsRequired,
exchangeDays: $exchangeDays,
exchangeDaysToReserveStock: $exchangeDaysToReserveStock,
exchangeDaysType: $exchangeDaysType,
exchangeExcludeTags: $exchangeExcludeTags,
exchangeMethod: $exchangeMethod,
exchangeNormalizeCrossProductEqualPrices: $exchangeNormalizeCrossProductEqualPrices,
exchangePortalDisplayOrder: $exchangePortalDisplayOrder,
exchangeRequireDeliveryBeforeReturn: $exchangeRequireDeliveryBeforeReturn,
exchangeRoundToZeroIfLteTo: $exchangeRoundToZeroIfLteTo,
exchangeShipmentOrderSuffix: $exchangeShipmentOrderSuffix,
exchangeShippingLineTitle: $exchangeShippingLineTitle,
exchangeUpsellDiscountPercentage: $exchangeUpsellDiscountPercentage,
exchangeUpsellEnabled: $exchangeUpsellEnabled,
expirationPeriodType: $expirationPeriodType,
expirationPreventionAction: $expirationPreventionAction,
giftCardPrefix: $giftCardPrefix,
giftReturnsExchangeEnabled: $giftReturnsExchangeEnabled,
giftReturnsStoreCreditEnabled: $giftReturnsStoreCreditEnabled,
gorgiasSubdomain: $gorgiasSubdomain,
instructions: $instructions,
international: $international,
internationalCustomsContentValueSource: $internationalCustomsContentValueSource,
internationalCustomsSigner: $internationalCustomsSigner,
internationalDefaultHarmonizedSystemCode: $internationalDefaultHarmonizedSystemCode,
internationalExemptionCode: $internationalExemptionCode,
internationalNonDeliveryOption: $internationalNonDeliveryOption,
internationalOriginCountry: $internationalOriginCountry,
isCartonizationEnabled: $isCartonizationEnabled,
isDefaultFeeEqualsShippingCost: $isDefaultFeeEqualsShippingCost,
isExchangeDifferentialPricingEnabled: $isExchangeDifferentialPricingEnabled,
isExchangeIntegrationEnabled: $isExchangeIntegrationEnabled,
isFullCatalogExchangeEnabled: $isFullCatalogExchangeEnabled,
isInlineExchangeEnabled: $isInlineExchangeEnabled,
isNoShippingReturnEnabled: $isNoShippingReturnEnabled,
isQrCodeEnabled: $isQrCodeEnabled,
isRefundIntegrationEnabled: $isRefundIntegrationEnabled,
isRestockIntegrationEnabled: $isRestockIntegrationEnabled,
isReturnItemExpirationEnabled: $isReturnItemExpirationEnabled,
isShippingLabelUploadAllowed: $isShippingLabelUploadAllowed,
isStoreCreditIncentiveEnabled: $isStoreCreditIncentiveEnabled,
isStoreCreditIncentiveRoundToNearest: $isStoreCreditIncentiveRoundToNearest,
isStoreCreditIntegrationEnabled: $isStoreCreditIntegrationEnabled,
klaviyoApiKey: $klaviyoApiKey,
maxFilesPerReturn: $maxFilesPerReturn,
maxStoreCreditIncentiveAmount: $maxStoreCreditIncentiveAmount,
minFilesPerReturn: $minFilesPerReturn,
minStoreCreditIncentiveAmount: $minStoreCreditIncentiveAmount,
notificationEmailAddress: $notificationEmailAddress,
notificationEmailAttachRma: $notificationEmailAttachRma,
notifications: $notifications,
notifyOnlyIfApprovalIsRequired: $notifyOnlyIfApprovalIsRequired,
onboardingComplete: $onboardingComplete,
paidShippingFee: $paidShippingFee,
portalCustomizations: $portalCustomizations,
portalExchangeSelectionMethod: $portalExchangeSelectionMethod,
portalFrenchUseAlternative: $portalFrenchUseAlternative,
portalGermanUseAlternative: $portalGermanUseAlternative,
portalItalianUseAlternative: $portalItalianUseAlternative,
portalLanguage: $portalLanguage,
portalTheme: $portalTheme,
portalVisualExchangeExcludeCollections: $portalVisualExchangeExcludeCollections,
portalVisualExchangeIncludeCollections: $portalVisualExchangeIncludeCollections,
portalVisualExchangeType: $portalVisualExchangeType,
prepaidShippingFee: $prepaidShippingFee,
preventReturnsFromDifferentFulfillments: $preventReturnsFromDifferentFulfillments,
primaryFieldBehavior: $primaryFieldBehavior,
questions: $questions,
refField1Source: $refField1Source,
refField2Source: $refField2Source,
refundCommentsEnabled: $refundCommentsEnabled,
refundCommentsRequired: $refundCommentsRequired,
refundDays: $refundDays,
refundDaysType: $refundDaysType,
refundPortalDisplayOrder: $refundPortalDisplayOrder,
refundRequireDeliveryBeforeReturn: $refundRequireDeliveryBeforeReturn,
requireApprovalForAllReturns: $requireApprovalForAllReturns,
resolvePartialExchangeRefundsToStoreCredit: $resolvePartialExchangeRefundsToStoreCredit,
restockingFeeDefinedAsPercentage: $restockingFeeDefinedAsPercentage,
restockingFeeType: $restockingFeeType,
returnItemExpirationDays: $returnItemExpirationDays,
returnReasons: $returnReasons,
secondaryFieldBehavior: $secondaryFieldBehavior,
selfShippingFee: $selfShippingFee,
shipFree: $shipFree,
shipPay: $shipPay,
shipSelf: $shipSelf,
shippingRateSelectLowestRate: $shippingRateSelectLowestRate,
shippingRateShowUpToPercentage: $shippingRateShowUpToPercentage,
shippoApiKey: $shippoApiKey,
shouldDisplayFeesInPortal: $shouldDisplayFeesInPortal,
showPortalSummary: $showPortalSummary,
stageShipmentStatuses: $stageShipmentStatuses,
stages: $stages,
storeCreditCommentsEnabled: $storeCreditCommentsEnabled,
storeCreditCommentsRequired: $storeCreditCommentsRequired,
storeCreditDays: $storeCreditDays,
storeCreditDaysType: $storeCreditDaysType,
storeCreditExpireDays: $storeCreditExpireDays,
storeCreditIncentivePercentage: $storeCreditIncentivePercentage,
storeCreditIncentiveType: $storeCreditIncentiveType,
storeCreditRequireDeliveryBeforeReturn: $storeCreditRequireDeliveryBeforeReturn,
stripePublishableKey: $stripePublishableKey,
stripeSecretKey: $stripeSecretKey,
useApprovals: $useApprovals,
useBillingAddressFallback: $useBillingAddressFallback,
useConsolidatedOrderExchanges: $useConsolidatedOrderExchanges,
useExchangeShipmentOrders: $useExchangeShipmentOrders,
useShippingByReturnzap: $useShippingByReturnzap,
useShopAddressForPosReturns: $useShopAddressForPosReturns,
userPermissionsEnabled: $userPermissionsEnabled,
webhookEvents: $webhookEvents,
webhookUrl: $webhookUrl
) {
success
error
fieldErrors {
...FieldErrorTypeFragment
}
shop {
...AuthenticatedShopFragment
}
}
}
Variables
{
"allowGiftReturns": true,
"allowOutOfStockExchanges": false,
"autoProcessExchangesOnCreation": true,
"automatedStoreCreditType": "DISCOUNT_CODE",
"barcodeValue": "NONE",
"carryDiscountForwardType": "NONE",
"cartonizationLengthUnit": "INCHES",
"creditPortalDisplayOrder": 123,
"customerEmailContent": "xyz789",
"customerEmailDisplayFromName": "abc123",
"customerEmailReplyToAddress": "xyz789",
"customerLabelFlatFee": Decimal,
"customerPaidShippingMode": "RETURNZAP",
"defaultAddress": AddressInput,
"defaultExchangeFee": Decimal,
"defaultRefundFee": Decimal,
"defaultStoreCreditFee": Decimal,
"defaultWarehouseForPosReturns": "4",
"defaultWeight": Decimal,
"defaultWeightUnit": "abc123",
"delayedShopifyReturnCreationEnabled": true,
"discountSameProductExchangesToBeEqual": true,
"dynamicTranslations": [DynamicTranslationInput],
"easypostApiKey": "abc123",
"enableCustomRmaNumber": true,
"enableExchange": true,
"enableRefund": true,
"enableStoreCredit": false,
"exchangeCheckInventoryAtFulfillmentLocation": true,
"exchangeCommentsEnabled": false,
"exchangeCommentsRequired": true,
"exchangeDays": 987,
"exchangeDaysToReserveStock": 987,
"exchangeDaysType": "SINCE_DELIVERY",
"exchangeExcludeTags": ["xyz789"],
"exchangeMethod": "COMMENTS",
"exchangeNormalizeCrossProductEqualPrices": true,
"exchangePortalDisplayOrder": 123,
"exchangeRequireDeliveryBeforeReturn": false,
"exchangeRoundToZeroIfLteTo": Decimal,
"exchangeShipmentOrderSuffix": "abc123",
"exchangeShippingLineTitle": "xyz789",
"exchangeUpsellDiscountPercentage": Decimal,
"exchangeUpsellEnabled": true,
"expirationPeriodType": "RETURN_CREATED_DATE",
"expirationPreventionAction": "RETURN_PROCESSED",
"giftCardPrefix": "abc123",
"giftReturnsExchangeEnabled": true,
"giftReturnsStoreCreditEnabled": false,
"gorgiasSubdomain": "abc123",
"instructions": "abc123",
"international": false,
"internationalCustomsContentValueSource": "SELL_PRICE",
"internationalCustomsSigner": "xyz789",
"internationalDefaultHarmonizedSystemCode": "abc123",
"internationalExemptionCode": "xyz789",
"internationalNonDeliveryOption": "abc123",
"internationalOriginCountry": "abc123",
"isCartonizationEnabled": false,
"isDefaultFeeEqualsShippingCost": false,
"isExchangeDifferentialPricingEnabled": false,
"isExchangeIntegrationEnabled": true,
"isFullCatalogExchangeEnabled": false,
"isInlineExchangeEnabled": false,
"isNoShippingReturnEnabled": false,
"isQrCodeEnabled": false,
"isRefundIntegrationEnabled": true,
"isRestockIntegrationEnabled": true,
"isReturnItemExpirationEnabled": true,
"isShippingLabelUploadAllowed": true,
"isStoreCreditIncentiveEnabled": false,
"isStoreCreditIncentiveRoundToNearest": false,
"isStoreCreditIntegrationEnabled": false,
"klaviyoApiKey": "abc123",
"maxFilesPerReturn": 987,
"maxStoreCreditIncentiveAmount": Decimal,
"minFilesPerReturn": 123,
"minStoreCreditIncentiveAmount": Decimal,
"notificationEmailAddress": "xyz789",
"notificationEmailAttachRma": false,
"notifications": [NotificationInput],
"notifyOnlyIfApprovalIsRequired": true,
"onboardingComplete": false,
"paidShippingFee": Decimal,
"portalCustomizations": JSONString,
"portalExchangeSelectionMethod": "SEARCH",
"portalFrenchUseAlternative": false,
"portalGermanUseAlternative": false,
"portalItalianUseAlternative": true,
"portalLanguage": "xyz789",
"portalTheme": "abc123",
"portalVisualExchangeExcludeCollections": [
"abc123"
],
"portalVisualExchangeIncludeCollections": [
"xyz789"
],
"portalVisualExchangeType": "NONE",
"prepaidShippingFee": Decimal,
"preventReturnsFromDifferentFulfillments": true,
"primaryFieldBehavior": "EMAIL_ADDRESS",
"questions": [QuestionInput],
"refField1Source": "BLANK",
"refField2Source": "BLANK",
"refundCommentsEnabled": false,
"refundCommentsRequired": true,
"refundDays": 123,
"refundDaysType": "SINCE_DELIVERY",
"refundPortalDisplayOrder": 123,
"refundRequireDeliveryBeforeReturn": false,
"requireApprovalForAllReturns": true,
"resolvePartialExchangeRefundsToStoreCredit": true,
"restockingFeeDefinedAsPercentage": true,
"restockingFeeType": "ONCE_PER_RETURN",
"returnItemExpirationDays": 987,
"returnReasons": [ReturnReasonInput],
"secondaryFieldBehavior": "SHOPIFY_ORDER_NUMBER",
"selfShippingFee": Decimal,
"shipFree": false,
"shipPay": false,
"shipSelf": true,
"shippingRateSelectLowestRate": false,
"shippingRateShowUpToPercentage": Decimal,
"shippoApiKey": "xyz789",
"shouldDisplayFeesInPortal": true,
"showPortalSummary": false,
"stageShipmentStatuses": [StageShipmentStatusInput],
"stages": [StageInput],
"storeCreditCommentsEnabled": false,
"storeCreditCommentsRequired": false,
"storeCreditDays": 987,
"storeCreditDaysType": "SINCE_DELIVERY",
"storeCreditExpireDays": 123,
"storeCreditIncentivePercentage": Decimal,
"storeCreditIncentiveType": "ONCE_PER_ITEM",
"storeCreditRequireDeliveryBeforeReturn": true,
"stripePublishableKey": "abc123",
"stripeSecretKey": "abc123",
"useApprovals": false,
"useBillingAddressFallback": false,
"useConsolidatedOrderExchanges": false,
"useExchangeShipmentOrders": true,
"useShippingByReturnzap": true,
"useShopAddressForPosReturns": true,
"userPermissionsEnabled": false,
"webhookEvents": ["RETURN_CREATED"],
"webhookUrl": "xyz789"
}
Response
{
"data": {
"updateSettings": {
"success": true,
"error": "abc123",
"fieldErrors": [FieldErrorType],
"shop": AuthenticatedShop
}
}
}
updateTranslationOverride
Description
Update multiple customized translations for a shop
Response
Returns an UpdateTranslationOverride
Arguments
| Name | Description |
|---|---|
customizations - [TranslationOverrideInput]!
|
Example
Query
mutation updateTranslationOverride($customizations: [TranslationOverrideInput]!) {
updateTranslationOverride(customizations: $customizations) {
success
error
customizedTranslations {
...CustomizedTranslationTypeFragment
}
}
}
Variables
{"customizations": [TranslationOverrideInput]}
Response
{
"data": {
"updateTranslationOverride": {
"success": false,
"error": "xyz789",
"customizedTranslations": [
CustomizedTranslationType
]
}
}
}
updateUserPreferences
Description
This mutation updates the user preferences
Response
Returns an UpdateUserPreferences
Arguments
| Name | Description |
|---|---|
preferredLocale - String
|
Optional argument for updating preferred locale setting (e.g. en-US, fr-FR) |
Example
Query
mutation updateUserPreferences($preferredLocale: String) {
updateUserPreferences(preferredLocale: $preferredLocale) {
success
user {
...ShopifyUserFragment
}
}
}
Variables
{"preferredLocale": "abc123"}
Response
{
"data": {
"updateUserPreferences": {
"success": false,
"user": ShopifyUser
}
}
}
voidShipment
Response
Returns a VoidShipment
Arguments
| Name | Description |
|---|---|
returnId - ID!
|
Example
Query
mutation voidShipment($returnId: ID!) {
voidShipment(returnId: $returnId) {
error
return {
...ReturnFragment
}
}
}
Variables
{"returnId": "4"}
Response
{
"data": {
"voidShipment": {
"error": "xyz789",
"return": Return
}
}
}
warehouseCreate
Response
Returns a WarehouseCreate
Arguments
| Name | Description |
|---|---|
warehouse - WarehouseInput!
|
Example
Query
mutation warehouseCreate($warehouse: WarehouseInput!) {
warehouseCreate(warehouse: $warehouse) {
error
warehouse {
...WarehouseTypeFragment
}
}
}
Variables
{"warehouse": WarehouseInput}
Response
{
"data": {
"warehouseCreate": {
"error": "abc123",
"warehouse": WarehouseType
}
}
}
warehouseDelete
Response
Returns a WarehouseDelete
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation warehouseDelete($id: ID!) {
warehouseDelete(id: $id) {
error
}
}
Variables
{"id": 4}
Response
{
"data": {
"warehouseDelete": {"error": "xyz789"}
}
}
warehouseUpdate
Response
Returns a WarehouseUpdate
Arguments
| Name | Description |
|---|---|
warehouse - WarehouseInput!
|
Example
Query
mutation warehouseUpdate($warehouse: WarehouseInput!) {
warehouseUpdate(warehouse: $warehouse) {
error
warehouse {
...WarehouseTypeFragment
}
}
}
Variables
{"warehouse": WarehouseInput}
Response
{
"data": {
"warehouseUpdate": {
"error": "abc123",
"warehouse": WarehouseType
}
}
}
Types
ActionTakenMetricType
Example
{
"exchangesCount": 987,
"exchangesAmount": Decimal,
"refundsCount": 987,
"refundsAmount": Decimal,
"storeCreditCount": 123,
"storeCreditAmount": Decimal,
"manuallyResolvedCount": 987,
"manuallyResolvedAmount": Decimal
}
ActiveReturnStageMetricType
ActiveReturnsMetricType
Fields
| Field Name | Description |
|---|---|
count - Int
|
|
stage - [ActiveReturnStageMetricType]
|
Example
{"count": 987, "stage": [ActiveReturnStageMetricType]}
AddPaymentMethod
Fields
| Field Name | Description |
|---|---|
paymentMethods - [ShopPaymentMethod]
|
|
paymentMethod - ShopPaymentMethod
|
|
success - Boolean
|
|
errors - [GQLErrorType]
|
Example
{
"paymentMethods": [ShopPaymentMethod],
"paymentMethod": ShopPaymentMethod,
"success": true,
"errors": [GQLErrorType]
}
Address
Example
{
"id": 123,
"uuid": "4",
"name": "abc123",
"company": "xyz789",
"addressLine1": "abc123",
"addressLine2": "abc123",
"city": "abc123",
"state": "abc123",
"postalCode": "abc123",
"country": "xyz789",
"phoneNumber": "xyz789"
}
AddressInput
Example
{
"uuid": "4",
"name": "abc123",
"company": "xyz789",
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"city": "abc123",
"state": "xyz789",
"postalCode": "xyz789",
"country": "abc123",
"phoneNumber": "xyz789"
}
AddressType
Example
{
"id": "4",
"userName": "abc123",
"company": "abc123",
"street1": "xyz789",
"phone": "abc123",
"street2": "abc123",
"country": "xyz789",
"city": "abc123",
"zip": "xyz789",
"state": "abc123"
}
AdminOrderLookupResponse
Fields
| Field Name | Description |
|---|---|
orders - [AdminSearchOrderResult]!
|
Example
{"orders": [AdminSearchOrderResult]}
AdminSearchOrderResult
AnswerResponseType
Fields
| Field Name | Description |
|---|---|
text - String
|
|
selectedChoices - [SelectedChoiceType]
|
Example
{
"text": "xyz789",
"selectedChoices": [SelectedChoiceType]
}
AppliedRuleType
ApproveReturn
ArchiveFilter
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACTIVE"
ArchiveReturns
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": true}
AuthenticatedShop
Description
Note, this is different from returnzap.portal.types.PublicShop since we will expose things to an authenticated shop admin that we won't expose to the public portal APIs.
Fields
| Field Name | Description |
|---|---|
uuid - String!
|
|
url - String!
|
|
primaryDomain - String!
|
|
timezone - String!
|
IANA timezone string (e.g. America/New_York) |
name - String!
|
|
isTestShop - Boolean!
|
|
isUitestShop - Boolean!
|
|
onboardingCompletedAt - DateTime
|
|
needsToEnableExchangeTestDrive - Boolean!
|
|
userPermissionsEnabled - Boolean!
|
Enable user-level permissions (Premium feature) |
notifyOnlyIfApprovalIsRequired - Boolean!
|
|
instructions - String!
|
|
portalTheme - String!
|
|
portalLanguage - String!
|
|
portalFrenchUseAlternative - Boolean!
|
Use informal French |
portalGermanUseAlternative - Boolean!
|
Use informal German |
portalItalianUseAlternative - Boolean!
|
Use formal Italian |
portalCustomizations - JSONString!
|
|
shouldDisplayFeesInPortal - Boolean!
|
|
refundPortalDisplayOrder - Int!
|
|
creditPortalDisplayOrder - Int!
|
|
exchangePortalDisplayOrder - Int!
|
|
showPortalSummary - Boolean!
|
|
portalExchangeSelectionMethod - PortalExchangeSelectionMethod
|
|
portalVisualExchangeType - PortalVisualExchangeType
|
|
portalVisualExchangeIncludeCollections - [String!]!
|
|
portalVisualExchangeExcludeCollections - [String!]!
|
|
exchangeUpsellEnabled - Boolean!
|
|
exchangeUpsellDiscountPercentage - Decimal
|
Percentage discount for upsell exchanges |
minFilesPerReturn - Int!
|
Minimum number of files required when creating a return |
maxFilesPerReturn - Int
|
Maximum number of files allowed when creating a return |
isShippingLabelUploadAllowed - Boolean!
|
|
barcodeValue - BarcodeValue
|
|
enableCustomRmaNumber - Boolean!
|
|
shipFree - Boolean!
|
|
shipPay - Boolean!
|
|
shipSelf - Boolean!
|
|
isShippingByReturnzapAvailable - Boolean!
|
|
useShippingByReturnzap - Boolean!
|
|
prepaidShippingFee - Decimal
|
|
paidShippingFee - Decimal
|
|
selfShippingFee - Decimal
|
|
isDefaultFeeEqualsShippingCost - Boolean!
|
|
shippingRateSelectLowestRate - Boolean!
|
|
shippingRateShowUpToPercentage - Decimal!
|
|
customerLabelFlatFee - Decimal
|
Flat fee for customer labels. Leave empty to charge the actual label cost (plus multiplier); setting 0.00 forces a free label. |
customerPaidShippingMode - CustomerPaidShippingMode!
|
Determines which account to use for customer-paid shipping labels |
isNoShippingReturnEnabled - Boolean!
|
|
isQrCodeEnabled - Boolean!
|
|
isCartonizationEnabled - Boolean!
|
|
cartonizationLengthUnit - LengthUnit
|
|
restockingFeeDefinedAsPercentage - Boolean!
|
|
defaultRefundFee - Decimal
|
|
defaultExchangeFee - Decimal
|
|
defaultStoreCreditFee - Decimal
|
|
currency - String!
|
The default currency code from Shopify (e.g. USD, CAD) |
internationalCustomsContentValueSource - CustomsContentValueSource
|
|
klaviyoApiKey - String!
|
|
gorgiasSubdomain - String!
|
The user entered subdomain that we'll use to match with Gorgias accounts once they've completed the OAuth flow. |
useApprovals - Boolean!
|
|
requireApprovalForAllReturns - Boolean!
|
|
useShopAddressForPosReturns - Boolean!
|
|
useBillingAddressFallback - Boolean!
|
When enabled, fall back to billing address if shipping address is missing when creating returns |
allowGiftReturns - Boolean!
|
|
giftReturnsExchangeEnabled - Boolean!
|
|
giftReturnsStoreCreditEnabled - Boolean!
|
|
preventReturnsFromDifferentFulfillments - Boolean!
|
Prevent items which shipped in different fulfillments from being returned together |
delayedShopifyReturnCreationEnabled - Boolean!
|
ReturnZap will not create a return directly in Shopify until the return's stage.create_shopify_return=True or an admin user tries to resolve an item. |
isRefundIntegrationEnabled - Boolean!
|
Integration with Shopify Refund |
isRestockIntegrationEnabled - Boolean!
|
Has the customer enabled integration with Shopify Restock? |
returnItemExpirationDays - Int!
|
For testing, if value is over 10000, we will subtract 10000 and use the remainder as number of minutes, not days. |
isReturnItemExpirationEnabled - Boolean!
|
|
returnItemExpirationEnabledAt - DateTime
|
When return item expiration was enabled. Returns created before (this date - max_policy_days) won't be expired. |
expirationPreventionAction - ExpirationPreventionAction
|
|
expirationPeriodType - ExpirationPeriodType
|
|
isExchangeIntegrationEnabled - Boolean!
|
Has the customer enabled integration with Shopify Exchange? |
exchangeMethod - ExchangeMethod
|
|
isInlineExchangeEnabled - Boolean!
|
Allow the shop customer to exchange items in the portal |
isFullCatalogExchangeEnabled - Boolean!
|
Allow the shop customer to exchange any item in the catalog |
useConsolidatedOrderExchanges - Boolean!
|
|
discountSameProductExchangesToBeEqual - Boolean!
|
If customer is exchanging for another variant of the same product, discount it to the same value as the original variant |
exchangeNormalizeCrossProductEqualPrices - Boolean!
|
When enabled, advanced exchanges between DIFFERENT products will apply price normalization if current prices match (zero-balance swaps). |
isExchangeDifferentialPricingEnabled - Boolean!
|
Allow the shop customer to exchange items with different prices |
exchangeRoundToZeroIfLteTo - Decimal
|
If the balance due for an exchange is less than or equal to this value, round it to zero. |
exchangeDaysToReserveStock - Int!
|
Number of days to reserve stock for exchange |
allowOutOfStockExchanges - Boolean!
|
Allow exchanges for items that are out of stock |
exchangeCheckInventoryAtFulfillmentLocation - Boolean!
|
If enabled, exchange product lookup will exclude items with no inventory at the location the line item was fulfilled from. |
carryDiscountForwardType - CarryDiscountForwardType
|
|
useExchangeShipmentOrders - Boolean!
|
If True, we'll create a new exchange order for fulfilling replacement items and place a hold on the original order's fulfillment order. |
exchangeShipmentOrderSuffix - String!
|
By default we will add "-EX" + " |
exchangeShippingLineTitle - String
|
|
autoProcessExchangesOnCreation - Boolean!
|
Automatically process and reserve exchange items from stock when return is created |
isStoreCreditIntegrationEnabled - Boolean!
|
Has the customer enabled integration with Shopify Store Credit? |
isStoreCreditIncentiveEnabled - Boolean!
|
|
storeCreditIncentivePercentage - Float!
|
Percentage between 0 and 100 |
minStoreCreditIncentiveAmount - Decimal
|
|
maxStoreCreditIncentiveAmount - Decimal
|
|
isStoreCreditIncentiveRoundToNearest - Boolean!
|
|
resolvePartialExchangeRefundsToStoreCredit - Boolean!
|
If True, partial refunds from exchanges are issued to store credit. If False, they are issued as refunds. |
storeCreditExpireDays - Int
|
Number of days after which store credits expire. If null, store credits do not expire. |
giftCardPrefix - String
|
|
id - ID!
|
|
parentUrl - String
|
|
shopifyAdminUrl - String!
|
|
primaryFieldBehavior - PrimaryFieldBehavior!
|
|
secondaryFieldBehavior - SecondaryFieldBehavior!
|
|
reauthenticateUrl - String
|
Allow the user to reauthenticate with Shopify |
hasTestModeReturns - Boolean
|
|
defaultPortalUrl - String!
|
|
adminAppUrl - String!
|
|
enableRefund - Boolean
|
|
refundDays - Int
|
|
refundDaysType - DaysType
|
|
refundCommentsEnabled - Boolean
|
|
refundCommentsRequired - Boolean
|
|
refundRequireDeliveryBeforeReturn - Boolean
|
|
enableExchange - Boolean
|
|
exchangeDays - Int
|
|
exchangeDaysType - DaysType
|
|
exchangeCommentsEnabled - Boolean
|
|
exchangeCommentsRequired - Boolean
|
|
exchangeRequireDeliveryBeforeReturn - Boolean
|
|
exchangeExcludeTags - [String]
|
|
enableStoreCredit - Boolean
|
|
storeCreditDays - Int
|
|
storeCreditDaysType - DaysType
|
|
storeCreditCommentsEnabled - Boolean
|
|
storeCreditCommentsRequired - Boolean
|
|
storeCreditRequireDeliveryBeforeReturn - Boolean
|
|
automatedStoreCreditType - AutomatedStoreCreditType
|
|
notificationEmailAddress - String
|
|
notificationEmailAttachRma - Boolean
|
|
customerEmailDisplayFromName - String
|
|
customerEmailReplyToAddress - String
|
|
defaultAddress - Address
|
|
defaultWeight - Decimal
|
|
defaultWeightUnit - String
|
|
international - Boolean
|
|
internationalOriginCountry - String
|
|
internationalCustomsSigner - String
|
|
internationalNonDeliveryOption - String
|
|
internationalExemptionCode - String
|
|
internationalDefaultHarmonizedSystemCode - String
|
|
shippoApiKey - String
|
|
stripePublishableKey - String
|
|
stripeSecretKey - String
|
|
subscriptionPlan - ShopSubscriptionPlan!
|
|
features - [String]
|
|
installedAt - DateTime
|
|
returnReasons - [ReturnReason]
|
|
stages - [Stage]
|
|
notifications - [Notification]
|
|
rules - [Rule]!
|
|
packages - [PackageType]!
|
|
dynamicTranslations - [DynamicTranslation]
|
|
returnIntegration - Boolean
|
|
missingScopes - [String]
|
Missing scopes based on the enable features for the user |
sendcloudAccounts - [SendcloudAccount]
|
|
shopifyLocations - [ShopifyLocation]
|
|
Arguments
|
|
easyPostAccount - EasyPostAccountType
|
|
shippoAccount - ShippoAccountType
|
|
shipstationAccount - ShipStationAccountType
|
|
refField1Source - RefFieldSource
|
|
refField2Source - RefFieldSource
|
|
storeCreditIncentiveType - StoreCreditIncentiveType
|
|
restockingFeeType - RestockingFeeType
|
|
webhookUrl - String
|
|
webhookEvents - [WebhookEventType]
|
|
questions - [Question]
|
|
stageShipmentStatuses - [StageShipmentStatusType]
|
|
defaultWarehouseForPosReturns - ID
|
|
portalConfig - PortalConfigType!
|
|
hasLabelIntegration - Boolean!
|
|
canUseStoreShippingMode - Boolean!
|
Whether the shop can use store mode for customer-paid shipping (requires Stripe + shipping integration) |
logo - String
|
|
logoUploadUrl - SignedUrl
|
|
Arguments
|
|
easypostApiKey - String
|
Use easyPostAccount.apiKey instead |
onboardingComplete - Boolean
|
Use onboarding_completed_at instead |
installDate - DateTime
|
Use installed_at instead |
exchangeIntegration - Boolean
|
Use is_exchange_integration_enabled or check for feature instead |
storeCreditIntegration - Boolean
|
Use is_store_credit_integration_enabled or check for feature instead |
Example
{
"uuid": "abc123",
"url": "xyz789",
"primaryDomain": "xyz789",
"timezone": "xyz789",
"name": "abc123",
"isTestShop": false,
"isUitestShop": true,
"onboardingCompletedAt": "2007-12-03T10:15:30Z",
"needsToEnableExchangeTestDrive": true,
"userPermissionsEnabled": true,
"notifyOnlyIfApprovalIsRequired": true,
"instructions": "abc123",
"portalTheme": "abc123",
"portalLanguage": "abc123",
"portalFrenchUseAlternative": true,
"portalGermanUseAlternative": false,
"portalItalianUseAlternative": true,
"portalCustomizations": JSONString,
"shouldDisplayFeesInPortal": false,
"refundPortalDisplayOrder": 123,
"creditPortalDisplayOrder": 987,
"exchangePortalDisplayOrder": 987,
"showPortalSummary": false,
"portalExchangeSelectionMethod": "SEARCH",
"portalVisualExchangeType": "NONE",
"portalVisualExchangeIncludeCollections": [
"xyz789"
],
"portalVisualExchangeExcludeCollections": [
"xyz789"
],
"exchangeUpsellEnabled": false,
"exchangeUpsellDiscountPercentage": Decimal,
"minFilesPerReturn": 123,
"maxFilesPerReturn": 123,
"isShippingLabelUploadAllowed": true,
"barcodeValue": "NONE",
"enableCustomRmaNumber": false,
"shipFree": true,
"shipPay": true,
"shipSelf": false,
"isShippingByReturnzapAvailable": false,
"useShippingByReturnzap": true,
"prepaidShippingFee": Decimal,
"paidShippingFee": Decimal,
"selfShippingFee": Decimal,
"isDefaultFeeEqualsShippingCost": false,
"shippingRateSelectLowestRate": true,
"shippingRateShowUpToPercentage": Decimal,
"customerLabelFlatFee": Decimal,
"customerPaidShippingMode": "RETURNZAP",
"isNoShippingReturnEnabled": false,
"isQrCodeEnabled": true,
"isCartonizationEnabled": true,
"cartonizationLengthUnit": "INCHES",
"restockingFeeDefinedAsPercentage": false,
"defaultRefundFee": Decimal,
"defaultExchangeFee": Decimal,
"defaultStoreCreditFee": Decimal,
"currency": "xyz789",
"internationalCustomsContentValueSource": "SELL_PRICE",
"klaviyoApiKey": "xyz789",
"gorgiasSubdomain": "xyz789",
"useApprovals": true,
"requireApprovalForAllReturns": true,
"useShopAddressForPosReturns": false,
"useBillingAddressFallback": true,
"allowGiftReturns": true,
"giftReturnsExchangeEnabled": true,
"giftReturnsStoreCreditEnabled": true,
"preventReturnsFromDifferentFulfillments": true,
"delayedShopifyReturnCreationEnabled": false,
"isRefundIntegrationEnabled": true,
"isRestockIntegrationEnabled": false,
"returnItemExpirationDays": 123,
"isReturnItemExpirationEnabled": false,
"returnItemExpirationEnabledAt": "2007-12-03T10:15:30Z",
"expirationPreventionAction": "RETURN_PROCESSED",
"expirationPeriodType": "RETURN_CREATED_DATE",
"isExchangeIntegrationEnabled": false,
"exchangeMethod": "COMMENTS",
"isInlineExchangeEnabled": false,
"isFullCatalogExchangeEnabled": false,
"useConsolidatedOrderExchanges": false,
"discountSameProductExchangesToBeEqual": true,
"exchangeNormalizeCrossProductEqualPrices": false,
"isExchangeDifferentialPricingEnabled": true,
"exchangeRoundToZeroIfLteTo": Decimal,
"exchangeDaysToReserveStock": 123,
"allowOutOfStockExchanges": true,
"exchangeCheckInventoryAtFulfillmentLocation": false,
"carryDiscountForwardType": "NONE",
"useExchangeShipmentOrders": true,
"exchangeShipmentOrderSuffix": "xyz789",
"exchangeShippingLineTitle": "xyz789",
"autoProcessExchangesOnCreation": true,
"isStoreCreditIntegrationEnabled": true,
"isStoreCreditIncentiveEnabled": false,
"storeCreditIncentivePercentage": 123.45,
"minStoreCreditIncentiveAmount": Decimal,
"maxStoreCreditIncentiveAmount": Decimal,
"isStoreCreditIncentiveRoundToNearest": false,
"resolvePartialExchangeRefundsToStoreCredit": true,
"storeCreditExpireDays": 123,
"giftCardPrefix": "abc123",
"id": 4,
"parentUrl": "xyz789",
"shopifyAdminUrl": "xyz789",
"primaryFieldBehavior": "EMAIL_ADDRESS",
"secondaryFieldBehavior": "SHOPIFY_ORDER_NUMBER",
"reauthenticateUrl": "abc123",
"hasTestModeReturns": true,
"defaultPortalUrl": "abc123",
"adminAppUrl": "abc123",
"enableRefund": false,
"refundDays": 123,
"refundDaysType": "SINCE_DELIVERY",
"refundCommentsEnabled": true,
"refundCommentsRequired": true,
"refundRequireDeliveryBeforeReturn": false,
"enableExchange": false,
"exchangeDays": 123,
"exchangeDaysType": "SINCE_DELIVERY",
"exchangeCommentsEnabled": true,
"exchangeCommentsRequired": true,
"exchangeRequireDeliveryBeforeReturn": true,
"exchangeExcludeTags": ["xyz789"],
"enableStoreCredit": false,
"storeCreditDays": 123,
"storeCreditDaysType": "SINCE_DELIVERY",
"storeCreditCommentsEnabled": true,
"storeCreditCommentsRequired": true,
"storeCreditRequireDeliveryBeforeReturn": false,
"automatedStoreCreditType": "DISCOUNT_CODE",
"notificationEmailAddress": "xyz789",
"notificationEmailAttachRma": true,
"customerEmailDisplayFromName": "xyz789",
"customerEmailReplyToAddress": "abc123",
"defaultAddress": Address,
"defaultWeight": Decimal,
"defaultWeightUnit": "abc123",
"international": true,
"internationalOriginCountry": "xyz789",
"internationalCustomsSigner": "abc123",
"internationalNonDeliveryOption": "xyz789",
"internationalExemptionCode": "abc123",
"internationalDefaultHarmonizedSystemCode": "xyz789",
"shippoApiKey": "abc123",
"stripePublishableKey": "abc123",
"stripeSecretKey": "abc123",
"subscriptionPlan": ShopSubscriptionPlan,
"features": ["abc123"],
"installedAt": "2007-12-03T10:15:30Z",
"returnReasons": [ReturnReason],
"stages": [Stage],
"notifications": [Notification],
"rules": [Rule],
"packages": [PackageType],
"dynamicTranslations": [DynamicTranslation],
"returnIntegration": false,
"missingScopes": ["xyz789"],
"sendcloudAccounts": [SendcloudAccount],
"shopifyLocations": [ShopifyLocation],
"easyPostAccount": EasyPostAccountType,
"shippoAccount": ShippoAccountType,
"shipstationAccount": ShipStationAccountType,
"refField1Source": "BLANK",
"refField2Source": "BLANK",
"storeCreditIncentiveType": "ONCE_PER_ITEM",
"restockingFeeType": "ONCE_PER_RETURN",
"webhookUrl": "xyz789",
"webhookEvents": ["RETURN_CREATED"],
"questions": [Question],
"stageShipmentStatuses": [StageShipmentStatusType],
"defaultWarehouseForPosReturns": 4,
"portalConfig": PortalConfigType,
"hasLabelIntegration": false,
"canUseStoreShippingMode": true,
"logo": "xyz789",
"logoUploadUrl": SignedUrl,
"easypostApiKey": "abc123",
"onboardingComplete": true,
"installDate": "2007-12-03T10:15:30Z",
"exchangeIntegration": false,
"storeCreditIntegration": true
}
AutomatedStoreCreditType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DISCOUNT_CODE"
BalanceInfoType
Fields
| Field Name | Description |
|---|---|
paymentMethods - [ShopPaymentMethod]
|
|
balanceSettings - BalanceSettingsType
|
|
balance - Decimal!
|
Example
{
"paymentMethods": [ShopPaymentMethod],
"balanceSettings": BalanceSettingsType,
"balance": Decimal
}
BalanceSettingsType
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
autoRechargeEnabled - Boolean!
|
Whether auto-recharge is enabled for this shop |
autoRechargeThreshold - Decimal
|
|
autoRechargeAmount - Decimal
|
|
currency - BalancesShopBalanceSettingsCurrencyChoices!
|
Currency for this shop's balance account |
currencyLockedAt - DateTime
|
When the currency was explicitly set and locked |
returnzapProcessingFeePercentage - Decimal!
|
ReturnZap processing fee percentage (e.g., 0.0375 for 3.75%) |
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"autoRechargeEnabled": false,
"autoRechargeThreshold": Decimal,
"autoRechargeAmount": Decimal,
"currency": "USD",
"currencyLockedAt": "2007-12-03T10:15:30Z",
"returnzapProcessingFeePercentage": Decimal
}
BalancesShopBalanceSettingsCurrencyChoices
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
US Dollar |
|
|
British Pound |
|
|
Euro |
Example
"USD"
BarcodeValue
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
BillingPeriodType
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
startDate - Date!
|
|
endDate - Date!
|
|
totalReturns - Int!
|
|
totalLabels - Int!
|
Number of labels generated this period |
totalLabelFeeAmountDue - Decimal!
|
|
totalOverageAmountDue - Decimal!
|
|
totalAmountDue - Decimal!
|
|
usageOverageQuantity - Int!
|
|
usageAmountCharged - Decimal
|
|
usageDescription - String
|
|
usageChargeId - String!
|
|
usageChargedAt - DateTime
|
|
billingPeriodClosedAt - DateTime
|
|
tierCountWhenClosed - Int
|
|
overagePriceWhenClosed - Decimal
|
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"startDate": "2007-12-03",
"endDate": "2007-12-03",
"totalReturns": 987,
"totalLabels": 123,
"totalLabelFeeAmountDue": Decimal,
"totalOverageAmountDue": Decimal,
"totalAmountDue": Decimal,
"usageOverageQuantity": 987,
"usageAmountCharged": Decimal,
"usageDescription": "abc123",
"usageChargeId": "xyz789",
"usageChargedAt": "2007-12-03T10:15:30Z",
"billingPeriodClosedAt": "2007-12-03T10:15:30Z",
"tierCountWhenClosed": 987,
"overagePriceWhenClosed": Decimal
}
Boolean
Description
The Boolean scalar type represents true or false.
CarryDiscountForwardType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"NONE"
CompleteOnboarding
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
|
shop - AuthenticatedShop
|
Example
{"success": true, "shop": AuthenticatedShop}
Condition
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
attr - RuleAttribute!
|
|
op - RuleOperator!
|
|
value - String!
|
|
questionId - ID
|
Use question instead. |
questionChoiceIds - [ID]
|
Use question_choices instead. |
question - ID
|
|
questionType - QuestionType
|
|
questionChoices - [ID]
|
Example
{
"id": "4",
"uuid": "abc123",
"attr": "NONE",
"op": "EQ",
"value": "abc123",
"questionId": "4",
"questionChoiceIds": ["4"],
"question": 4,
"questionType": "LONG_TEXT",
"questionChoices": [4]
}
ConditionInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
attr - RuleAttribute
|
|
op - RuleOperator
|
|
value - String!
|
|
question - ID
|
|
questionChoices - [ID]
|
Example
{
"id": "4",
"attr": "NONE",
"op": "EQ",
"value": "abc123",
"question": "4",
"questionChoices": ["4"]
}
CreateOrUpdateQuestion
Fields
| Field Name | Description |
|---|---|
question - Question
|
Example
{"question": Question}
CreateReturnStoreCreditMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
errorText - String
|
|
return - Return
|
|
storeCredit - StoreCreditType
|
Example
{
"error": "abc123",
"errorText": "xyz789",
"return": Return,
"storeCredit": StoreCreditType
}
CreateSetupIntent
Fields
| Field Name | Description |
|---|---|
setupIntent - SetupIntentResponseType
|
|
errors - [GQLErrorType]
|
Example
{
"setupIntent": SetupIntentResponseType,
"errors": [GQLErrorType]
}
CustomerPaidShippingMode
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RETURNZAP"
CustomizedTranslationType
CustomsContentValueSource
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SELL_PRICE"
DashboardMetrics
Fields
| Field Name | Description |
|---|---|
returnMetrics - [ReturnsMetricType]
|
|
stageMetrics - [StageMetricType]
|
|
policyMetrics - [PolicyMetricType]
|
|
reasonMetrics - [ReasonMetricType]
|
|
actionTakenMetrics - ActionTakenMetricType
|
|
mostReturned - ReturnProductMetricType
|
|
activeReturns - ActiveReturnsMetricType
|
|
startDate - DateTime
|
Start date of the dashboard metrics |
endDate - DateTime
|
End date of the dashboard metrics |
Example
{
"returnMetrics": [ReturnsMetricType],
"stageMetrics": [StageMetricType],
"policyMetrics": [PolicyMetricType],
"reasonMetrics": [ReasonMetricType],
"actionTakenMetrics": ActionTakenMetricType,
"mostReturned": ReturnProductMetricType,
"activeReturns": ActiveReturnsMetricType,
"startDate": "2007-12-03T10:15:30Z",
"endDate": "2007-12-03T10:15:30Z"
}
DashboardResponse
Date
Description
The Date scalar type represents a Date value as specified by iso8601.
Example
"2007-12-03"
DateFilterRange
DateTime
Description
The DateTime scalar type represents a DateTime value as specified by iso8601.
Example
"2007-12-03T10:15:30Z"
DaysType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SINCE_DELIVERY"
Decimal
Description
The Decimal scalar type represents a python Decimal.
Example
Decimal
DeleteQuestion
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": false}
DeleteReturns
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
Example
{"success": false}
DeleteTaxNumbers
Fields
| Field Name | Description |
|---|---|
errors - [GQLErrorType]
|
Example
{"errors": [GQLErrorType]}
DeleteTranslationOverride
DisposeReturn
DispositionType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MISSING"
DjangoDebug
Description
Debugging information for the current query.
Fields
| Field Name | Description |
|---|---|
sql - [DjangoDebugSQL]
|
Executed SQL queries for this API query. |
exceptions - [DjangoDebugException]
|
Raise exceptions for this API query. |
Example
{
"sql": [DjangoDebugSQL],
"exceptions": [DjangoDebugException]
}
DjangoDebugException
DjangoDebugSQL
Description
Represents a single database query made to a Django managed DB.
Fields
| Field Name | Description |
|---|---|
vendor - String!
|
The type of database being used (e.g. postrgesql, mysql, sqlite). |
alias - String!
|
The Django database alias (e.g. 'default'). |
sql - String
|
The actual SQL sent to this database. |
duration - Float!
|
Duration of this database query in seconds. |
rawSql - String!
|
The raw SQL of this query, without params. |
params - String!
|
JSON encoded database query parameters. |
startTime - Float!
|
Start time of this database query. |
stopTime - Float!
|
Stop time of this database query. |
isSlow - Boolean!
|
Whether this database query took more than 10 seconds. |
isSelect - Boolean!
|
Whether this database query was a SELECT. |
transId - String
|
Postgres transaction ID if available. |
transStatus - String
|
Postgres transaction status if available. |
isoLevel - String
|
Postgres isolation level if available. |
encoding - String
|
Postgres connection encoding if available. |
Example
{
"vendor": "xyz789",
"alias": "xyz789",
"sql": "xyz789",
"duration": 123.45,
"rawSql": "abc123",
"params": "xyz789",
"startTime": 987.65,
"stopTime": 123.45,
"isSlow": false,
"isSelect": false,
"transId": "abc123",
"transStatus": "xyz789",
"isoLevel": "abc123",
"encoding": "xyz789"
}
DynamicTranslation
DynamicTranslationInput
Example
{
"uuid": 4,
"language": "abc123",
"model": "RETURN_REASON",
"field": "abc123",
"objUuid": "abc123",
"message": "abc123",
"delete": true
}
EasyEasyPostCarrierServiceGlobalConfigUnitChoices
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
in |
|
|
cm |
Example
"IN"
EasyPostAccountCarrierServiceMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
services - [EasyPostAccountCarrierServiceType]
|
Example
{
"error": "xyz789",
"services": [EasyPostAccountCarrierServiceType]
}
EasyPostAccountCarrierServiceType
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
carrier - EasyPostCarrierType!
|
|
code - String!
|
Service code (name) from EasyPost API (e.g., 'Ground', 'Overnight') |
name - String!
|
Human-readable service name |
description - String!
|
Human-readable service description |
isActive - Boolean!
|
Whether this service is active and available for use |
alwaysDisplay - Boolean!
|
Always return this service rates despite cut off setting |
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"carrier": EasyPostCarrierType,
"code": "xyz789",
"name": "abc123",
"description": "abc123",
"isActive": true,
"alwaysDisplay": false
}
EasyPostAccountMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
easyPostAccount - EasyPostAccountType
|
Example
{
"error": "xyz789",
"easyPostAccount": EasyPostAccountType
}
EasyPostAccountType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shop - AuthenticatedShop!
|
|
managedByReturnzap - Boolean!
|
|
apiKey - String!
|
|
useIsReturn - Boolean!
|
|
originCountries - [String!]!
|
2-letter ISO 3166-1 alpha-2 country codes for origin countries. Empty means all countries. |
destinationCountries - [String!]!
|
2-letter ISO 3166-1 alpha-2 country codes for destination countries. Empty means all countries. |
services - String
|
Use EasyPostAccountCarrierServiceType.is_active field instead. |
carriers - [EasyPostCarrierType]
|
Example
{
"id": 4,
"shop": AuthenticatedShop,
"managedByReturnzap": false,
"apiKey": "xyz789",
"useIsReturn": true,
"originCountries": ["xyz789"],
"destinationCountries": ["abc123"],
"services": "abc123",
"carriers": [EasyPostCarrierType]
}
EasyPostCarrierConfig
Example
{
"carrier": "abc123",
"displayName": "abc123",
"service": "abc123",
"serviceDisplayName": "abc123",
"width": Decimal,
"height": Decimal,
"unit": "IN",
"rotate": true,
"supportsQrCode": false
}
EasyPostCarrierMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
easyPostCarriers - [EasyPostCarrierType]
|
Example
{
"error": "xyz789",
"easyPostCarriers": [EasyPostCarrierType]
}
EasyPostCarrierServiceUpdateType
EasyPostCarrierType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
externalId - String!
|
|
easypostAccount - EasyPostAccountType
|
|
name - String!
|
|
active - Boolean!
|
|
services - [EasyPostAccountCarrierServiceType]
|
Example
{
"id": 4,
"externalId": "xyz789",
"easypostAccount": EasyPostAccountType,
"name": "abc123",
"active": true,
"services": [EasyPostAccountCarrierServiceType]
}
EasyPostCarrierUpdateType
ExchangeItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
returnItem - ReturnItem
|
Use returnItemId instead
|
variantId - String!
|
The Shopify variant id for the item the customer wants to exchange |
title - String!
|
Exchange item title |
sku - String!
|
Exchange item sku |
quantity - Int
|
The quantity of the item to exchange |
imageUrl - String!
|
Exchange item image url |
presentmentOriginalAmount - Decimal
|
The variant unit amount without discounts applied in presentment currency |
presentmentDiscountedAmount - Decimal
|
Actual variant unit amount customer paid in presentment currency |
returnItemPresentmentOriginalUnitAmount - Decimal
|
The catalog price of the returned item at the time of purchasing in presentment currency |
presentmentNormalizationAdjustmentAmount - Decimal
|
Price normalization adjustment amount in presentment currency. |
presentmentCurrency - String!
|
|
releasedAt - DateTime
|
|
removedAt - DateTime
|
Date removed from consolidated order exchange |
expiredAt - DateTime
|
|
returnItemId - String
|
The id of the return item this is exchanging for |
exchangeOrderId - String
|
The id of the exchange order |
variantList - [String]
|
|
returnItemIsMissing - Boolean
|
Whether the return item is missing |
isResolved - Boolean
|
Whether the exchange item has been resolved |
status - ExchangeOrderStatus
|
Status of the exchange order |
draftOrderId - String
|
The id of the draft order in Shopify |
draftOrderNumber - String
|
The number of the draft order in Shopify |
draftOrderLink - String
|
URL Link to the draft order in Shopify |
completedOrderId - String
|
The id of the completed order in Shopify |
completedOrderNumber - String
|
The number of the completed order in Shopify |
completedOrderLink - String
|
URL Link to the completed order in Shopify |
consolidatedOrderLink - String
|
URL Link to the original order in Shopify |
statusLabel - String
|
Status label for the exchange order Use status instead |
completeOrderLink - String
|
URL Link to the completed order in Shopify |
exchangeVariantId - String
|
The Shopify variant id for the item the customer wants to receive as replacement. Use variantId instead
|
Example
{
"id": 4,
"returnItem": ReturnItem,
"variantId": "xyz789",
"title": "xyz789",
"sku": "abc123",
"quantity": 123,
"imageUrl": "abc123",
"presentmentOriginalAmount": Decimal,
"presentmentDiscountedAmount": Decimal,
"returnItemPresentmentOriginalUnitAmount": Decimal,
"presentmentNormalizationAdjustmentAmount": Decimal,
"presentmentCurrency": "abc123",
"releasedAt": "2007-12-03T10:15:30Z",
"removedAt": "2007-12-03T10:15:30Z",
"expiredAt": "2007-12-03T10:15:30Z",
"returnItemId": "abc123",
"exchangeOrderId": "abc123",
"variantList": ["abc123"],
"returnItemIsMissing": false,
"isResolved": true,
"status": "DRAFT",
"draftOrderId": "abc123",
"draftOrderNumber": "abc123",
"draftOrderLink": "abc123",
"completedOrderId": "abc123",
"completedOrderNumber": "xyz789",
"completedOrderLink": "abc123",
"consolidatedOrderLink": "xyz789",
"statusLabel": "abc123",
"completeOrderLink": "xyz789",
"exchangeVariantId": "abc123"
}
ExchangeMethod
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMMENTS"
ExchangeOrder
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime
|
|
consolidatedOrderExchange - Boolean!
|
If True, the exchange order is part of a consolidated return. It uses the Shopify return integration instead of Draft order workflow |
status - ExchangeOrderStatus
|
Status of the exchange order |
theReturn - Return
|
|
draftOrderId - String!
|
The Shopify draft order id. Created when the customer requests an exchange |
draftOrderNumber - String!
|
The Shopify draft order number e.g #D66 |
shopifyExchangeShipmentOrderId - String!
|
When we facilitate fulfillment with another order, this is the Shopify order id of that order |
shopifyExchangeShipmentOrderName - String!
|
...and this is the Shopify order name of that order |
completedOrderId - String!
|
The Shopify completed order id. This is only set when the order is completed by the shop |
completedOrderNumber - String!
|
The Shopify completed order number e.g #1218 |
completedOrderAt - DateTime
|
|
invoiceSentAt - DateTime
|
|
exchangeItems - [ExchangeItem!]
|
|
statusLabel - String
|
Status label for the exchange order |
completeOrderLink - String
|
URL Link to the completed order in Shopify |
draftOrderLink - String
|
URL Link to the draft order in Shopify |
consolidatedOrderLink - String
|
URL Link to the original order in Shopify |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"consolidatedOrderExchange": true,
"status": "DRAFT",
"theReturn": Return,
"draftOrderId": "abc123",
"draftOrderNumber": "xyz789",
"shopifyExchangeShipmentOrderId": "abc123",
"shopifyExchangeShipmentOrderName": "xyz789",
"completedOrderId": "abc123",
"completedOrderNumber": "xyz789",
"completedOrderAt": "2007-12-03T10:15:30Z",
"invoiceSentAt": "2007-12-03T10:15:30Z",
"exchangeItems": [ExchangeItem],
"statusLabel": "xyz789",
"completeOrderLink": "xyz789",
"draftOrderLink": "xyz789",
"consolidatedOrderLink": "abc123"
}
ExchangeOrderStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DRAFT"
ExpirationPeriodType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RETURN_CREATED_DATE"
ExpirationPreventionAction
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RETURN_PROCESSED"
FieldErrorKey
Description
Enum for field-level validation error keys. These keys are used for frontend internationalization.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STRIPE_INVALID_PUBLISHABLE_KEY"
FieldErrorType
Fields
| Field Name | Description |
|---|---|
field - String!
|
The field name that has the error |
key - FieldErrorKey!
|
Error key for frontend internationalization |
message - String!
|
Human readable fallback message (English) |
Example
{
"field": "abc123",
"key": "STRIPE_INVALID_PUBLISHABLE_KEY",
"message": "xyz789"
}
FiltersInput
Fields
| Input Field | Description |
|---|---|
query - String
|
|
stages - [Int]
|
|
status - ArchiveFilter
|
|
returnDate - DateFilterRange
|
|
orderDate - DateFilterRange
|
|
stageUpdatedDate - DateFilterRange
|
|
perPage - Int
|
|
currentPage - Int
|
|
sortBy - String
|
|
resolvedStatus - [ResolvedStatus]
|
|
returnItemTypes - [String]
|
|
warehouseIds - [Int]
|
Example
{
"query": "xyz789",
"stages": [987],
"status": "ACTIVE",
"returnDate": DateFilterRange,
"orderDate": DateFilterRange,
"stageUpdatedDate": DateFilterRange,
"perPage": 123,
"currentPage": 987,
"sortBy": "xyz789",
"resolvedStatus": ["RESOLVED"],
"returnItemTypes": ["xyz789"],
"warehouseIds": [123]
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GQLErrorEnum
Description
Enum for all GQL errors Important: Prefix all errors with name of the integration (e.g. RZ_, SHOPIFY_, EASYPOST_, etc)
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RZ_RULES_ERROR"
GQLErrorType
Fields
| Field Name | Description |
|---|---|
errorCode - GQLErrorEnum
|
The code for the error |
message - String
|
Human readable textual error representation (do not use for machine logic) |
traceId - String
|
Trace ID for the error, you can share this with the ReturnZap customer support |
debugTrace - String
|
Debug information for the error We don't send backend debug info to frontend. |
Example
{
"errorCode": "RZ_RULES_ERROR",
"message": "abc123",
"traceId": "xyz789",
"debugTrace": "xyz789"
}
GeneratePortalImageUploadURL
Fields
| Field Name | Description |
|---|---|
errors - [GQLErrorType]
|
|
uploadUrl - SignedUrl
|
|
imagePath - String
|
Example
{
"errors": [GQLErrorType],
"uploadUrl": SignedUrl,
"imagePath": "abc123"
}
GenerateShippingLabelUploadURL
GrapheneRestockType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ONCE_PER_RETURN"
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
Image
ImageInput
ImageUploadsSetting
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DISABLE_IMAGE_UPLOAD"
InstallStatusType
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
JSONString
Description
Allows use of a JSON String for input / output from the GraphQL schema.
Use of this type is not recommended as you lose the benefits of having a defined, static schema (one of the key benefits of GraphQL).
Example
JSONString
LedgerConnection
Fields
| Field Name | Description |
|---|---|
pageInfo - PageInfo!
|
Pagination data for this connection. |
edges - [LedgerEdge]!
|
Contains the nodes in this connection. |
Example
{
"pageInfo": PageInfo,
"edges": [LedgerEdge]
}
LedgerEdge
Description
A Relay edge containing a Ledger and its cursor.
Fields
| Field Name | Description |
|---|---|
node - LedgerNode
|
The item at the end of the edge |
cursor - String!
|
A cursor for use in pagination |
Example
{
"node": LedgerNode,
"cursor": "xyz789"
}
LedgerEntryType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MANUAL_CREDIT"
LedgerNode
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the object |
createdAt - DateTime!
|
|
amount - Decimal!
|
Positive if credit, negative if debit |
currency - String!
|
|
originalAmount - Decimal
|
|
originalCurrency - String
|
|
fxRate - Decimal
|
|
fxFee - Decimal
|
|
entryType - LedgerEntryType
|
|
description - String!
|
Human-readable description of this ledger entry |
paymentMethod - ShopPaymentMethod
|
|
settledAt - DateTime
|
When this entry was settled, if null it means it is pending |
Example
{
"id": "4",
"createdAt": "2007-12-03T10:15:30Z",
"amount": Decimal,
"currency": "xyz789",
"originalAmount": Decimal,
"originalCurrency": "xyz789",
"fxRate": Decimal,
"fxFee": Decimal,
"entryType": "MANUAL_CREDIT",
"description": "abc123",
"paymentMethod": ShopPaymentMethod,
"settledAt": "2007-12-03T10:15:30Z"
}
LengthUnit
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"INCHES"
LoadBalance
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
|
message - String
|
|
ledgerEntryId - ID
|
|
errors - [GQLErrorType]
|
Example
{
"success": true,
"message": "xyz789",
"ledgerEntryId": "4",
"errors": [GQLErrorType]
}
Money
MoneySet
Node
Description
An object with an ID
Fields
| Field Name | Description |
|---|---|
id - ID!
|
The ID of the object |
Possible Types
| Node Types |
|---|
Example
{"id": "4"}
Notification
Example
{
"id": 4,
"emailSubject": "abc123",
"emailContent": "xyz789",
"shouldAttachRmaForm": true,
"isActive": false,
"event": "STAGE_ENTRY",
"uuid": "4",
"stage": Stage
}
NotificationEvent
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"STAGE_ENTRY"
NotificationInput
Example
{
"id": 4,
"event": "STAGE_ENTRY",
"emailSubject": "abc123",
"emailContent": "abc123",
"isActive": true,
"shouldAttachRmaForm": true
}
OrderInvoiceSend
Fields
| Field Name | Description |
|---|---|
errors - [GQLErrorType!]!
|
Example
{"errors": [GQLErrorType]}
Package
Example
{
"id": 123,
"uuid": "4",
"name": "abc123",
"type": "xyz789",
"width": Decimal,
"height": Decimal,
"length": Decimal,
"weight": Decimal,
"unit": "xyz789",
"showDimensions": false
}
PackageCreate
Fields
| Field Name | Description |
|---|---|
package - PackageType
|
Example
{"package": PackageType}
PackageDelete
Fields
| Field Name | Description |
|---|---|
error - String
|
Example
{"error": "xyz789"}
PackageInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String!
|
|
type - String!
|
|
width - Decimal!
|
|
height - Decimal!
|
|
length - Decimal!
|
|
unit - ShopsPackageUnitChoices!
|
|
weight - Decimal!
|
|
weightUnit - ShopsPackageWeightUnitChoices!
|
Example
{
"id": 4,
"name": "abc123",
"type": "xyz789",
"width": Decimal,
"height": Decimal,
"length": Decimal,
"unit": "IN",
"weight": Decimal,
"weightUnit": "GRAMS"
}
PackageType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
type - String!
|
|
length - Decimal
|
|
width - Decimal
|
|
height - Decimal
|
|
unit - ShopsPackageUnitChoices!
|
|
weight - Decimal
|
|
weightUnit - ShopsPackageWeightUnitChoices!
|
|
uuid - ID
|
Example
{
"id": "4",
"name": "abc123",
"type": "xyz789",
"length": Decimal,
"width": Decimal,
"height": Decimal,
"unit": "IN",
"weight": Decimal,
"weightUnit": "GRAMS",
"uuid": 4
}
PackageUpdate
Fields
| Field Name | Description |
|---|---|
error - String
|
|
package - PackageType
|
Example
{
"error": "xyz789",
"package": PackageType
}
PageInfo
Description
The Relay compliant PageInfo type, containing data necessary to paginate this connection.
Fields
| Field Name | Description |
|---|---|
hasNextPage - Boolean!
|
When paginating forwards, are there more items? |
hasPreviousPage - Boolean!
|
When paginating backwards, are there more items? |
startCursor - String
|
When paginating backwards, the cursor to continue. |
endCursor - String
|
When paginating forwards, the cursor to continue. |
Example
{
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "xyz789",
"endCursor": "abc123"
}
PaymentMethodType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"CARD"
PaymentSetupStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PENDING"
Policy
Example
{
"returnType": "REFUND",
"days": 123,
"daysType": "SINCE_DELIVERY",
"message": "abc123",
"comments": true,
"commentsRequired": false,
"displayOrder": 987,
"requireDeliveryBeforeReturn": true
}
PolicyMetricType
PortalConfigType
Description
Portal configuration for a shop, accessible to both public and authenticated users.
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
lookupSideImageSameWidthAsLookupForm - Boolean!
|
Make the side image have the same width as the lookup form |
uuid - ID!
|
|
logo - Image
|
|
logoDark - Image
|
|
lookupSideImage - Image
|
|
lookupSideImageDark - Image
|
|
logoUploadUrl - SignedUrl
|
|
Arguments
|
|
logoDarkUploadUrl - SignedUrl
|
|
Arguments
|
|
lookupSideImageUploadUrl - SignedUrl
|
|
Arguments
|
|
lookupSideImageDarkUploadUrl - SignedUrl
|
|
Arguments
|
|
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"lookupSideImageSameWidthAsLookupForm": false,
"uuid": 4,
"logo": Image,
"logoDark": Image,
"lookupSideImage": Image,
"lookupSideImageDark": Image,
"logoUploadUrl": SignedUrl,
"logoDarkUploadUrl": SignedUrl,
"lookupSideImageUploadUrl": SignedUrl,
"lookupSideImageDarkUploadUrl": SignedUrl
}
PortalExchangeSelectionMethod
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SEARCH"
PortalVisualExchangeType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
PrimaryFieldBehavior
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"EMAIL_ADDRESS"
ProductReasonMetricType
PublicShop
Fields
| Field Name | Description |
|---|---|
url - String!
|
|
timezone - String!
|
IANA timezone string (e.g. America/New_York) |
portalTheme - String!
|
|
portalLanguage - String!
|
|
portalFrenchUseAlternative - Boolean!
|
Use informal French |
portalGermanUseAlternative - Boolean!
|
Use informal German |
portalItalianUseAlternative - Boolean!
|
Use formal Italian |
portalCustomizations - JSONString!
|
|
shouldDisplayFeesInPortal - Boolean!
|
|
refundPortalDisplayOrder - Int!
|
|
creditPortalDisplayOrder - Int!
|
|
exchangePortalDisplayOrder - Int!
|
|
showPortalSummary - Boolean!
|
|
portalExchangeSelectionMethod - PortalExchangeSelectionMethod
|
|
portalVisualExchangeType - PortalVisualExchangeType
|
|
exchangeUpsellEnabled - Boolean!
|
|
exchangeUpsellDiscountPercentage - Decimal
|
Percentage discount for upsell exchanges |
minFilesPerReturn - Int!
|
Minimum number of files required when creating a return |
maxFilesPerReturn - Int
|
Maximum number of files allowed when creating a return |
prepaidShippingFee - Decimal
|
|
paidShippingFee - Decimal
|
|
selfShippingFee - Decimal
|
|
isDefaultFeeEqualsShippingCost - Boolean!
|
|
restockingFeeDefinedAsPercentage - Boolean!
|
|
defaultRefundFee - Decimal
|
|
defaultExchangeFee - Decimal
|
|
defaultStoreCreditFee - Decimal
|
|
allowGiftReturns - Boolean!
|
|
giftReturnsExchangeEnabled - Boolean!
|
|
giftReturnsStoreCreditEnabled - Boolean!
|
|
preventReturnsFromDifferentFulfillments - Boolean!
|
Prevent items which shipped in different fulfillments from being returned together |
exchangeMethod - ExchangeMethod
|
|
isInlineExchangeEnabled - Boolean!
|
Allow the shop customer to exchange items in the portal |
isFullCatalogExchangeEnabled - Boolean!
|
Allow the shop customer to exchange any item in the catalog |
useConsolidatedOrderExchanges - Boolean!
|
|
isExchangeDifferentialPricingEnabled - Boolean!
|
Allow the shop customer to exchange items with different prices |
allowOutOfStockExchanges - Boolean
|
This field is deprecated and will be removed in a future version. |
isStoreCreditIncentiveEnabled - Boolean!
|
|
storeCreditIncentivePercentage - Float!
|
Percentage between 0 and 100 |
minStoreCreditIncentiveAmount - Decimal
|
|
maxStoreCreditIncentiveAmount - Decimal
|
|
isStoreCreditIncentiveRoundToNearest - Boolean!
|
|
resolvePartialExchangeRefundsToStoreCredit - Boolean!
|
If True, partial refunds from exchanges are issued to store credit. If False, they are issued as refunds. |
portalCustomAppProxy - String!
|
Default proxy path is /a/returnzap. If customer has customized it, save their custom path here. |
portalExposeEmailInvoiceOption - Boolean!
|
|
portalVisualExchangeHideVariant - Boolean!
|
If true, it will hide the option to hide variant exchange |
restockingFeeType - GrapheneRestockType
|
|
useAsyncReturnProcessing - Boolean!
|
Process returns asynchronously while portal user waits on Return Status page. |
exchangeSamePriceOnly - Boolean!
|
Only show product variants with the same price as the original product |
storeCreditIncentiveType - StoreCreditIncentiveType
|
|
id - ID!
|
|
showBranding - Boolean
|
|
active - Boolean!
|
|
customerServiceEmail - String!
|
|
primaryFieldBehavior - PrimaryFieldBehavior!
|
|
secondaryFieldBehavior - SecondaryFieldBehavior!
|
|
shipFree - Boolean!
|
Whether or not shop offers free prepaid labels. |
shipPay - Boolean!
|
Whether or not shop allows customers to purchase their own labels. |
shipSelf - Boolean!
|
Whether or not shop allows customers to ship via their own carrier. |
acceptInternational - Boolean
|
|
destinationCountry - String
|
|
approvalRequiredForAll - Boolean!
|
|
policies - [Policy]!
|
|
reasons - [Reason]!
|
|
usePackages - Boolean!
|
|
packages - [Package]!
|
|
rules - [Rule]!
|
|
translationOverrides - [TranslationOverride]
|
|
questions - [Question]
|
|
shippingRateSelectLowestRate - Boolean!
|
|
portalConfig - PortalConfigType!
|
|
dynamicTranslations - [DynamicTranslation]
|
Example
{
"url": "xyz789",
"timezone": "xyz789",
"portalTheme": "xyz789",
"portalLanguage": "xyz789",
"portalFrenchUseAlternative": false,
"portalGermanUseAlternative": false,
"portalItalianUseAlternative": true,
"portalCustomizations": JSONString,
"shouldDisplayFeesInPortal": false,
"refundPortalDisplayOrder": 123,
"creditPortalDisplayOrder": 987,
"exchangePortalDisplayOrder": 123,
"showPortalSummary": false,
"portalExchangeSelectionMethod": "SEARCH",
"portalVisualExchangeType": "NONE",
"exchangeUpsellEnabled": false,
"exchangeUpsellDiscountPercentage": Decimal,
"minFilesPerReturn": 123,
"maxFilesPerReturn": 987,
"prepaidShippingFee": Decimal,
"paidShippingFee": Decimal,
"selfShippingFee": Decimal,
"isDefaultFeeEqualsShippingCost": false,
"restockingFeeDefinedAsPercentage": false,
"defaultRefundFee": Decimal,
"defaultExchangeFee": Decimal,
"defaultStoreCreditFee": Decimal,
"allowGiftReturns": true,
"giftReturnsExchangeEnabled": true,
"giftReturnsStoreCreditEnabled": true,
"preventReturnsFromDifferentFulfillments": false,
"exchangeMethod": "COMMENTS",
"isInlineExchangeEnabled": true,
"isFullCatalogExchangeEnabled": true,
"useConsolidatedOrderExchanges": true,
"isExchangeDifferentialPricingEnabled": true,
"allowOutOfStockExchanges": true,
"isStoreCreditIncentiveEnabled": true,
"storeCreditIncentivePercentage": 987.65,
"minStoreCreditIncentiveAmount": Decimal,
"maxStoreCreditIncentiveAmount": Decimal,
"isStoreCreditIncentiveRoundToNearest": true,
"resolvePartialExchangeRefundsToStoreCredit": false,
"portalCustomAppProxy": "abc123",
"portalExposeEmailInvoiceOption": false,
"portalVisualExchangeHideVariant": true,
"restockingFeeType": "ONCE_PER_RETURN",
"useAsyncReturnProcessing": false,
"exchangeSamePriceOnly": false,
"storeCreditIncentiveType": "ONCE_PER_ITEM",
"id": 4,
"showBranding": false,
"active": false,
"customerServiceEmail": "xyz789",
"primaryFieldBehavior": "EMAIL_ADDRESS",
"secondaryFieldBehavior": "SHOPIFY_ORDER_NUMBER",
"shipFree": false,
"shipPay": false,
"shipSelf": false,
"acceptInternational": true,
"destinationCountry": "xyz789",
"approvalRequiredForAll": true,
"policies": [Policy],
"reasons": [Reason],
"usePackages": true,
"packages": [Package],
"rules": [Rule],
"translationOverrides": [TranslationOverride],
"questions": [Question],
"shippingRateSelectLowestRate": true,
"portalConfig": PortalConfigType,
"dynamicTranslations": [DynamicTranslation]
}
PutTaxNumbers
Fields
| Field Name | Description |
|---|---|
errors - [GQLErrorType]
|
|
taxNumbers - [TaxNumberOutput]
|
Example
{
"errors": [GQLErrorType],
"taxNumbers": [TaxNumberOutput]
}
Question
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
questionType - QuestionType
|
|
order - Int!
|
|
text - String!
|
|
isRequired - Boolean!
|
|
dependentOnReturnReason - Boolean!
|
Only show after a return reason is selected |
dependentOnQuestion - Question
|
|
choices - [QuestionChoice]
|
|
dependentOnReturnReasons - [ReturnReason]
|
|
dependentOnQuestionChoices - [QuestionChoice]
|
|
isActive - Boolean
|
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"questionType": "LONG_TEXT",
"order": 123,
"text": "xyz789",
"isRequired": true,
"dependentOnReturnReason": true,
"dependentOnQuestion": Question,
"choices": [QuestionChoice],
"dependentOnReturnReasons": [ReturnReason],
"dependentOnQuestionChoices": [QuestionChoice],
"isActive": false
}
QuestionChoice
QuestionChoiceInput
QuestionInput
Example
{
"id": 4,
"order": 987,
"questionType": "LONG_TEXT",
"text": "xyz789",
"isRequired": true,
"isActive": false,
"deleted": true,
"choices": [QuestionChoiceInput],
"dependentOnReturnReasons": [4],
"dependentOnQuestion": 4,
"dependentOnQuestionChoices": [4]
}
QuestionType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"LONG_TEXT"
Reason
Example
{
"id": 123,
"uuid": 4,
"order": 123,
"label": "abc123",
"message": "xyz789",
"imageUploads": "DISABLE_IMAGE_UPLOAD"
}
ReasonMetricType
ReceivedReturn
RefFieldSource
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"BLANK"
RefundReturn
Fields
| Field Name | Description |
|---|---|
error - String
|
|
return - Return
|
|
refund - RefundType
|
Example
{
"error": "xyz789",
"return": Return,
"refund": RefundType
}
RefundType
Fields
| Field Name | Description |
|---|---|
shopifyRefundId - String!
|
|
requestedTotalRefundAmount - Decimal
|
|
requestedCurrencyCode - String!
|
|
presentmentTotalAmountRefunded - Decimal
|
|
presentmentCurrencyCode - String!
|
|
presentmentSubtotalRefundAmount - Decimal
|
|
presentmentTaxRefundAmount - Decimal
|
|
presentmentShippingSubtotalRefundAmount - Decimal
|
|
presentmentShippingTaxRefundAmount - Decimal
|
|
shopTotalAmountRefunded - Decimal
|
|
shopRefundCurrencyCode - String!
|
|
shopSubtotalRefundAmount - Decimal
|
|
shopTaxRefundAmount - Decimal
|
|
shopShippingSubtotalRefundAmount - Decimal
|
|
shopShippingTaxRefundAmount - Decimal
|
|
currencyCode - String
|
Use presentmentCurrencyCode instead
|
totalAmountRefunded - Decimal
|
Use presentmentTotalAmountRefunded instead
|
Example
{
"shopifyRefundId": "xyz789",
"requestedTotalRefundAmount": Decimal,
"requestedCurrencyCode": "abc123",
"presentmentTotalAmountRefunded": Decimal,
"presentmentCurrencyCode": "xyz789",
"presentmentSubtotalRefundAmount": Decimal,
"presentmentTaxRefundAmount": Decimal,
"presentmentShippingSubtotalRefundAmount": Decimal,
"presentmentShippingTaxRefundAmount": Decimal,
"shopTotalAmountRefunded": Decimal,
"shopRefundCurrencyCode": "xyz789",
"shopSubtotalRefundAmount": Decimal,
"shopTaxRefundAmount": Decimal,
"shopShippingSubtotalRefundAmount": Decimal,
"shopShippingTaxRefundAmount": Decimal,
"currencyCode": "xyz789",
"totalAmountRefunded": Decimal
}
RegisterUser
Description
This mutation takes a session token from the frontend and uses it to retrieve more details about the user. Those details are then used to create or update the user's profile.
Fields
| Field Name | Description |
|---|---|
user - ShopifyUser
|
Example
{"user": ShopifyUser}
RejectReturn
ReleaseExchangeItemsMutation
Fields
| Field Name | Description |
|---|---|
errors - [String]
|
|
exchangeOrders - [ExchangeOrder]
|
Use exchange_items instead |
exchangeItems - [ExchangeItem]
|
|
return_ - Return
|
Example
{
"errors": ["xyz789"],
"exchangeOrders": [ExchangeOrder],
"exchangeItems": [ExchangeItem],
"return_": Return
}
ResendRMAForm
Fields
| Field Name | Description |
|---|---|
error - String
|
Example
{"error": "xyz789"}
ResolutionStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTO"
ResolvedStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"RESOLVED"
RestockingFeeType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ONCE_PER_RETURN"
Return
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
adminReturn - Boolean!
|
|
testMode - Boolean!
|
|
returnIntegration - Boolean!
|
|
usesConsolidatedOrderExchanges - Boolean
|
True if there's at least one exchange that uses consolidated order exchanges. |
traceId - String
|
|
customerFirstName - String!
|
|
customerLastName - String!
|
|
customerEmail - String!
|
|
rmaNumber - String!
|
|
stageLabel - String!
|
|
stageUpdatedDate - DateTime
|
|
approvalRequired - Boolean
|
|
approvedAt - DateTime
|
|
rejectedAt - DateTime
|
|
rejectionReason - String
|
|
allowResubmission - Boolean
|
When True, this return's items are excluded from returnable quantity enforcement in the portal. |
receivedAt - DateTime
|
|
isArchived - Boolean
|
|
expiredAt - DateTime
|
|
shippingMethod - ShippingMethod
|
|
giftReturn - Boolean
|
|
giftReturnEmailAddress - String
|
|
trackingNumber - String!
|
|
deliveryDate - DateTime
|
|
deliveryStatus - String!
|
|
labelCurrency - String!
|
|
shopCurrency - String!
|
|
noShippingRequired - Boolean!
|
|
feesSentThroughReturnIntegration - Boolean!
|
In issue #1545 we started sending shipping and restocking fees to Shopify when creating a return. |
defaultRefundFee - Decimal
|
|
defaultStoreCreditFee - Decimal
|
|
originalHandlingFeeCharged - Decimal
|
The handling fee charged to the customer when the return was created |
actualHandlingFeeCharged - Decimal
|
The handling fee actually charged to the customer through ReturnZap resolutions |
restockingFeeType - RestockingFeeType
|
|
originalRestockingFeeCharged - Decimal
|
The restocking fee charged to the customer when the return was created |
actualRestockingFeeCharged - Decimal
|
The restocking fee actually charged to the customer through ReturnZap resolutions |
shopifyReturnId - String
|
|
shopifyReturnName - String!
|
|
shopifyReturnSyncError - ReturnSyncError
|
|
shopifyOrderId - String!
|
|
shopifyOrderDate - DateTime
|
|
exchangeBalanceDue - Decimal
|
The balance due for the exchange |
exchangeBalancePaidAt - DateTime
|
|
estimatedBalance - Decimal
|
The estimated amount show to the customer in the portal. If positive, the shop owes the customer this amount. If negative, the customer owes the shop this amount. Added in 2025-04 and not backfilled. |
shopifyOrderNumber - String!
|
|
shopifyOrderUrl - String!
|
|
shopifyCustomerUrl - String!
|
|
customerAddress - ReturnAddressType
|
|
destinationAddress - ReturnAddressType
|
|
giftReturnAddress - ReturnAddressType
|
|
rmaFormUrl - String
|
|
stageId - ID
|
|
systemStage - Int
|
|
statusId - String
|
|
statusLabel - String
|
|
labelUrl - String
|
|
qrCodeUrl - String
|
|
labelCost - Decimal
|
|
totalWeightGrams - Decimal
|
|
createdAt - DateTime
|
|
refunds - [RefundType]
|
|
logs - [ReturnLog!]!
|
|
next - String
|
Use nextReturn instead
|
previous - String
|
Use previousReturn instead
|
nextReturn - Return
|
|
previousReturn - Return
|
|
exchangeOrders - [ExchangeOrder!]
|
|
shipment - Shipment
|
|
appliedRules - [String]
|
Use appliedRulesDetailed instead for structured rule data
|
appliedRulesDetailed - [AppliedRuleType]
|
|
suggestionRefund - SuggestionRefundType
|
Use suggestedRefund instead
|
suggestedRefund - SuggestedRefundType
|
|
hasValidCustomerPaymentPending - Boolean
|
|
warehouseName - String
|
|
shippedTo - String
|
Use warehouseName |
warehouse - WarehouseType
|
|
storeCredits - [StoreCreditType]
|
|
externalShippingLabelUrl - String
|
|
items - [ReturnItem]
|
|
exchangeItems - [ExchangeItem]
|
|
handlingFeeCharged - Decimal
|
Use (actual|original)_handling_fee_charged instead
|
restockingFeeCharged - Decimal
|
Use (actual|original)_restocking_fee_charged instead
|
shopifyOrderFulfillments - [ShopifyFulfillmentType]
|
|
shopifyOrderTotalQuantityOrdered - Int
|
|
shopifyOrderTotalQuantityReturnItems - Int
|
|
shopifyOrderTags - [String]
|
|
shopifyOrderCustomerTags - [String]
|
|
shopifyReturnSyncStatus - ShopifyReturnSyncStatus
|
|
orderId - String!
|
Use shopifyOrderId instead
|
orderNumber - String!
|
Use shopifyOrderNumber instead
|
orderDate - DateTime
|
Use shopifyOrderDate instead
|
returnDate - DateTime
|
Use createdAt instead
|
isActive - Boolean
|
Use isArchived instead
|
unitQuantity - Int
|
|
returnValueAmount - Decimal
|
Sum of items (item quantity * item discounted amount) |
resolvedStatus - ResolvedStatus
|
Status indicating the resolution state of the return items |
returnItemTypes - [String]
|
List of return item types e.g. ["REFUND", "CREDIT", "EXCHANGE"] |
returnTypeLabels - [String]
|
List of return item type labels e.g. ["Refund", "Store Credit", "Exchange"] |
Example
{
"id": "4",
"uuid": "xyz789",
"adminReturn": false,
"testMode": true,
"returnIntegration": true,
"usesConsolidatedOrderExchanges": false,
"traceId": "abc123",
"customerFirstName": "abc123",
"customerLastName": "xyz789",
"customerEmail": "xyz789",
"rmaNumber": "abc123",
"stageLabel": "abc123",
"stageUpdatedDate": "2007-12-03T10:15:30Z",
"approvalRequired": false,
"approvedAt": "2007-12-03T10:15:30Z",
"rejectedAt": "2007-12-03T10:15:30Z",
"rejectionReason": "xyz789",
"allowResubmission": true,
"receivedAt": "2007-12-03T10:15:30Z",
"isArchived": true,
"expiredAt": "2007-12-03T10:15:30Z",
"shippingMethod": "FREE",
"giftReturn": false,
"giftReturnEmailAddress": "abc123",
"trackingNumber": "abc123",
"deliveryDate": "2007-12-03T10:15:30Z",
"deliveryStatus": "abc123",
"labelCurrency": "xyz789",
"shopCurrency": "xyz789",
"noShippingRequired": false,
"feesSentThroughReturnIntegration": true,
"defaultRefundFee": Decimal,
"defaultStoreCreditFee": Decimal,
"originalHandlingFeeCharged": Decimal,
"actualHandlingFeeCharged": Decimal,
"restockingFeeType": "ONCE_PER_RETURN",
"originalRestockingFeeCharged": Decimal,
"actualRestockingFeeCharged": Decimal,
"shopifyReturnId": "xyz789",
"shopifyReturnName": "xyz789",
"shopifyReturnSyncError": "UNKNOWN_ERROR",
"shopifyOrderId": "abc123",
"shopifyOrderDate": "2007-12-03T10:15:30Z",
"exchangeBalanceDue": Decimal,
"exchangeBalancePaidAt": "2007-12-03T10:15:30Z",
"estimatedBalance": Decimal,
"shopifyOrderNumber": "xyz789",
"shopifyOrderUrl": "abc123",
"shopifyCustomerUrl": "xyz789",
"customerAddress": ReturnAddressType,
"destinationAddress": ReturnAddressType,
"giftReturnAddress": ReturnAddressType,
"rmaFormUrl": "abc123",
"stageId": 4,
"systemStage": 987,
"statusId": "abc123",
"statusLabel": "xyz789",
"labelUrl": "xyz789",
"qrCodeUrl": "abc123",
"labelCost": Decimal,
"totalWeightGrams": Decimal,
"createdAt": "2007-12-03T10:15:30Z",
"refunds": [RefundType],
"logs": [ReturnLog],
"next": "xyz789",
"previous": "abc123",
"nextReturn": Return,
"previousReturn": Return,
"exchangeOrders": [ExchangeOrder],
"shipment": Shipment,
"appliedRules": ["abc123"],
"appliedRulesDetailed": [AppliedRuleType],
"suggestionRefund": SuggestionRefundType,
"suggestedRefund": SuggestedRefundType,
"hasValidCustomerPaymentPending": true,
"warehouseName": "abc123",
"shippedTo": "abc123",
"warehouse": WarehouseType,
"storeCredits": [StoreCreditType],
"externalShippingLabelUrl": "xyz789",
"items": [ReturnItem],
"exchangeItems": [ExchangeItem],
"handlingFeeCharged": Decimal,
"restockingFeeCharged": Decimal,
"shopifyOrderFulfillments": [ShopifyFulfillmentType],
"shopifyOrderTotalQuantityOrdered": 987,
"shopifyOrderTotalQuantityReturnItems": 987,
"shopifyOrderTags": ["xyz789"],
"shopifyOrderCustomerTags": ["abc123"],
"shopifyReturnSyncStatus": "UNSYNCABLE",
"orderId": "abc123",
"orderNumber": "abc123",
"orderDate": "2007-12-03T10:15:30Z",
"returnDate": "2007-12-03T10:15:30Z",
"isActive": true,
"unitQuantity": 123,
"returnValueAmount": Decimal,
"resolvedStatus": "RESOLVED",
"returnItemTypes": ["xyz789"],
"returnTypeLabels": ["abc123"]
}
ReturnAddressType
Example
{
"name": "abc123",
"company": "xyz789",
"street1": "xyz789",
"street2": "abc123",
"city": "abc123",
"state": "abc123",
"zip": "abc123",
"phone": "abc123",
"email": "xyz789",
"country": "abc123",
"warehouseId": 4
}
ReturnExport
ReturnItem
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shopifyVariantId - String!
|
|
sku - String!
|
|
barcode - String
|
|
productTitle - String!
|
|
variantTitle - String!
|
|
variantDisplayName - String!
|
|
quantity - Int!
|
|
value - Decimal
|
Full unit price in shop currency |
presentmentOriginalAmount - Decimal
|
The variant unit amount without discounts applied in presentment currency |
discountedAmount - Decimal
|
Actual amount customer paid in shop currency |
presentmentDiscountedAmount - Decimal
|
Actual amount customer paid per unit in presentment currency |
presentmentCurrency - String!
|
|
vendor - String!
|
The name of the vendor who made the variant from Shopify. |
returnReason - String!
|
|
comment - String!
|
|
exchangeOrder - ExchangeOrder
|
The exchange order created for this return item |
isMissing - Boolean!
|
Is missing from return package |
isResolvedManually - Boolean!
|
Is resolved manually |
skipRestock - Boolean!
|
Flag indicating whether to temporarily skip restocking for the returned item. This item may be restocked in the future, depending on the disposition status. |
restockingFee - Decimal
|
The current shop restocking fee applied to the item |
handlingFee - Decimal
|
The current shop handling fee applied to the item |
storeCreditIncentiveAmount - Decimal
|
The current shop store credit's incentive amount applied to the item |
expiredAt - DateTime
|
|
actuallyResolvedAt - DateTime
|
Date the admin has resolved this item. |
autoResolvedAt - DateTime
|
Date the system has automatically resolved this item. |
returnEligibilityExpiresAt - DateTime
|
|
variant - String
|
Use variantTitle instead |
title - String
|
Use variantDisplayName instead |
titleClean - String
|
Use productTitle instead |
returnType - ReturnType
|
|
returnTypeLabel - String
|
|
returnReasonId - Int
|
|
returnReasonLabel - String
|
|
images - [String]
|
|
files - [ReturnItemFileType]
|
|
answers - [ReturnItemAnswerType]
|
|
isRefunded - Boolean
|
|
currency - String
|
Shop currency code e.g. USD |
dispositionType - String
|
Disposition type that was set on the return item on Shopify e.g. restock, missing |
imageUrl - String
|
|
variants - [String!]!
|
|
exchangeItem - ExchangeItem
|
|
resolvedAt - DateTime
|
|
resolutionStatus - ResolutionStatus
|
|
productHsCode - String
|
|
productCountryOfOrigin - String
|
|
totalWeightGrams - Decimal
|
Example
{
"id": "4",
"shopifyVariantId": "abc123",
"sku": "abc123",
"barcode": "xyz789",
"productTitle": "abc123",
"variantTitle": "abc123",
"variantDisplayName": "xyz789",
"quantity": 123,
"value": Decimal,
"presentmentOriginalAmount": Decimal,
"discountedAmount": Decimal,
"presentmentDiscountedAmount": Decimal,
"presentmentCurrency": "abc123",
"vendor": "xyz789",
"returnReason": "xyz789",
"comment": "xyz789",
"exchangeOrder": ExchangeOrder,
"isMissing": false,
"isResolvedManually": false,
"skipRestock": true,
"restockingFee": Decimal,
"handlingFee": Decimal,
"storeCreditIncentiveAmount": Decimal,
"expiredAt": "2007-12-03T10:15:30Z",
"actuallyResolvedAt": "2007-12-03T10:15:30Z",
"autoResolvedAt": "2007-12-03T10:15:30Z",
"returnEligibilityExpiresAt": "2007-12-03T10:15:30Z",
"variant": "abc123",
"title": "abc123",
"titleClean": "xyz789",
"returnType": "REFUND",
"returnTypeLabel": "abc123",
"returnReasonId": 123,
"returnReasonLabel": "abc123",
"images": ["xyz789"],
"files": [ReturnItemFileType],
"answers": [ReturnItemAnswerType],
"isRefunded": true,
"currency": "xyz789",
"dispositionType": "xyz789",
"imageUrl": "xyz789",
"variants": ["xyz789"],
"exchangeItem": ExchangeItem,
"resolvedAt": "2007-12-03T10:15:30Z",
"resolutionStatus": "AUTO",
"productHsCode": "abc123",
"productCountryOfOrigin": "abc123",
"totalWeightGrams": Decimal
}
ReturnItemAnswerChoiceType
ReturnItemAnswerType
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
questionType - QuestionType
|
|
order - Int!
|
|
questionText - String!
|
|
answer - String!
|
|
questionId - String
|
|
isRequired - Boolean
|
|
response - AnswerResponseType
|
|
answerChoices - [ReturnItemAnswerChoiceType]
|
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"questionType": "LONG_TEXT",
"order": 123,
"questionText": "abc123",
"answer": "abc123",
"questionId": "xyz789",
"isRequired": false,
"response": AnswerResponseType,
"answerChoices": [ReturnItemAnswerChoiceType]
}
ReturnItemBulkDelete
ReturnItemBulkUpdate
ReturnItemBulkUpdateInput
Fields
| Input Field | Description |
|---|---|
returnType - ReturnType!
|
|
returnReason - ID!
|
Example
{
"returnType": "REFUND",
"returnReason": "4"
}
ReturnItemDelete
ReturnItemFileType
ReturnItemUpdate
ReturnItemUpdateInput
Fields
| Input Field | Description |
|---|---|
returnType - ReturnType!
|
|
returnReason - Int
|
|
quantity - Int!
|
|
comment - String!
|
Example
{
"returnType": "REFUND",
"returnReason": 987,
"quantity": 987,
"comment": "abc123"
}
ReturnItemUpdateSkipRestock
ReturnLog
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
message - String!
|
|
context - ReturnLogContext!
|
|
comment - String!
|
|
type - ReturnLogType!
|
|
messageCode - String
|
|
moment - DateTime!
|
|
returnItems - [ReturnItem!]!
|
|
exchangeItems - [ExchangeItem!]!
|
Example
{
"id": "4",
"message": "xyz789",
"context": ReturnLogContext,
"comment": "abc123",
"type": "LEGACY",
"messageCode": "xyz789",
"moment": "2007-12-03T10:15:30Z",
"returnItems": [ReturnItem],
"exchangeItems": [ExchangeItem]
}
ReturnLogContext
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
comment - String
|
|
userFirstName - String
|
|
userLastName - String
|
|
stageLabel - String
|
|
itemsCount - Int
|
|
externalShipmentId - String
|
|
notificationType - String
|
|
to - String
|
|
shopifyOrderName - String
|
|
shopifyOrderId - String
|
|
amount - String
|
|
currency - String
|
|
rejectionReason - String
|
Example
{
"id": "4",
"comment": "abc123",
"userFirstName": "xyz789",
"userLastName": "abc123",
"stageLabel": "xyz789",
"itemsCount": 123,
"externalShipmentId": "abc123",
"notificationType": "xyz789",
"to": "xyz789",
"shopifyOrderName": "abc123",
"shopifyOrderId": "xyz789",
"amount": "abc123",
"currency": "abc123",
"rejectionReason": "xyz789"
}
ReturnLogType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"LEGACY"
ReturnLogUpdate
ReturnProductDetailMetricType
Fields
| Field Name | Description |
|---|---|
name - String
|
|
count - Int
|
|
url - String
|
|
reasons - [ProductReasonMetricType]
|
Example
{
"name": "xyz789",
"count": 123,
"url": "abc123",
"reasons": [ProductReasonMetricType]
}
ReturnProductMetricType
Fields
| Field Name | Description |
|---|---|
products - [ReturnProductDetailMetricType]
|
|
variants - [ReturnProductDetailMetricType]
|
Example
{
"products": [ReturnProductDetailMetricType],
"variants": [ReturnProductDetailMetricType]
}
ReturnReason
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
uuid - ID
|
|
reason - String!
|
|
imageUploads - ImageUploadsSetting
|
|
order - Int
|
Example
{
"id": 123,
"uuid": "4",
"reason": "abc123",
"imageUploads": "DISABLE_IMAGE_UPLOAD",
"order": 987
}
ReturnReasonInput
ReturnRuleActiveToggle
Fields
| Field Name | Description |
|---|---|
error - String
|
Example
{"error": "abc123"}
ReturnRuleCreateOrUpdate
ReturnRuleDelete
Fields
| Field Name | Description |
|---|---|
error - String
|
Example
{"error": "xyz789"}
ReturnSyncError
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN_ERROR"
ReturnTransitionStage
ReturnType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"REFUND"
ReturnUpdateStatus
ReturnsDeleteTestMode
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
|
shop - AuthenticatedShop
|
Example
{"success": false, "shop": AuthenticatedShop}
ReturnsMetricType
Rule
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
uuid - String!
|
|
isActive - Boolean
|
|
name - String!
|
|
rule - String
|
Human readable version. Use description instead. |
description - String
|
Human readable version. |
when - RuleWhen!
|
|
conditions - [Condition]!
|
|
action - RuleAction!
|
|
actionOption - RuleActionOption
|
|
unit - RuleUnit
|
|
value - String
|
|
message - String!
|
|
warehouseName - String
|
|
warehouseId - ID
|
|
destinationCountry - String
|
|
question - ID
|
|
questionChoices - [ID]
|
|
questionId - ID
|
Use question instead. |
questionChoiceId - ID
|
Use question_choices instead. |
windowDays - Int
|
Use value instead. |
Example
{
"id": "4",
"uuid": "abc123",
"isActive": false,
"name": "xyz789",
"rule": "xyz789",
"description": "abc123",
"when": "AND",
"conditions": [Condition],
"action": "DENY_RETURN",
"actionOption": "ALL",
"unit": "SHOP_DEFAULT_CURRENCY",
"value": "xyz789",
"message": "xyz789",
"warehouseName": "abc123",
"warehouseId": 4,
"destinationCountry": "abc123",
"question": 4,
"questionChoices": [4],
"questionId": 4,
"questionChoiceId": "4",
"windowDays": 123
}
RuleAction
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"DENY_RETURN"
RuleActionOption
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
RuleAttribute
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NONE"
RuleInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String!
|
|
isActive - Boolean
|
|
when - RuleWhen!
|
|
conditions - [ConditionInput]!
|
|
action - RuleAction!
|
|
actionOption - RuleActionOption!
|
|
message - String
|
|
warehouseId - ID
|
|
value - String
|
|
unit - RuleUnit
|
|
question - ID
|
|
questionChoices - [ID]
|
Example
{
"id": "4",
"name": "xyz789",
"isActive": true,
"when": "AND",
"conditions": [ConditionInput],
"action": "DENY_RETURN",
"actionOption": "ALL",
"message": "abc123",
"warehouseId": 4,
"value": "xyz789",
"unit": "SHOP_DEFAULT_CURRENCY",
"question": "4",
"questionChoices": ["4"]
}
RuleOperator
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EQ"
RuleUnit
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SHOP_DEFAULT_CURRENCY"
RuleWhen
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"AND"
SecondaryFieldBehavior
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SHOPIFY_ORDER_NUMBER"
SelectedChoiceType
SendcloudAccount
SetupIntentResponseType
Fields
| Field Name | Description |
|---|---|
clientSecret - String!
|
Example
{"clientSecret": "abc123"}
ShipStationAccountCarrierMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
carriers - [ShipStationAccountCarrierType]
|
Example
{
"error": "abc123",
"carriers": [ShipStationAccountCarrierType]
}
ShipStationAccountCarrierServiceMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
services - [ShipStationAccountCarrierServiceType]
|
Example
{
"error": "abc123",
"services": [ShipStationAccountCarrierServiceType]
}
ShipStationAccountCarrierServiceType
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
carrier - ShipStationAccountCarrierType!
|
|
code - String!
|
Service code from ShipStation API |
name - String!
|
Human-readable service name |
description - String!
|
Human-readable service description |
isActive - Boolean!
|
Whether this service is active and available for use |
alwaysDisplay - Boolean!
|
Always return this rate option despite cut off setting |
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"carrier": ShipStationAccountCarrierType,
"code": "abc123",
"name": "xyz789",
"description": "abc123",
"isActive": false,
"alwaysDisplay": false
}
ShipStationAccountCarrierType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
account - ShipStationAccountType
|
|
isActive - Boolean!
|
|
shipstationShippingProviderId - Int!
|
|
shipstationCarrier - String!
|
|
shipstationCarrierName - String!
|
|
services - [ShipStationAccountCarrierServiceType]
|
Example
{
"id": 4,
"account": ShipStationAccountType,
"isActive": false,
"shipstationShippingProviderId": 123,
"shipstationCarrier": "abc123",
"shipstationCarrierName": "abc123",
"services": [ShipStationAccountCarrierServiceType]
}
ShipStationAccountMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
fieldErrors - [FieldErrorType]
|
|
account - ShipStationAccountType
|
Example
{
"error": "xyz789",
"fieldErrors": [FieldErrorType],
"account": ShipStationAccountType
}
ShipStationAccountType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shop - PublicShop
|
|
apiKey - String!
|
|
apiSecret - String
|
|
services - String
|
Use ShipStationAccountCarrierServiceType.is_active field instead. |
carriers - [ShipStationAccountCarrierType]
|
Example
{
"id": "4",
"shop": PublicShop,
"apiKey": "xyz789",
"apiSecret": "xyz789",
"services": "abc123",
"carriers": [ShipStationAccountCarrierType]
}
ShipStationCarrierServiceConfig
Fields
| Field Name | Description |
|---|---|
carrier - String!
|
Raw carrier value. |
displayName - String!
|
|
service - String!
|
|
serviceDisplayName - String!
|
|
serviceDescription - String!
|
|
width - Decimal
|
|
height - Decimal
|
|
unit - ShipstationShipStationCarrierServiceGlobalConfigUnitChoices
|
|
rotate - Boolean!
|
Applied after resize. |
Example
{
"carrier": "abc123",
"displayName": "abc123",
"service": "abc123",
"serviceDisplayName": "abc123",
"serviceDescription": "xyz789",
"width": Decimal,
"height": Decimal,
"unit": "IN",
"rotate": false
}
ShipStationCarrierServiceUpdateType
ShipStationCarrierUpdateType
Shipment
ShipmentStatus
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNKNOWN"
ShippingMethod
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"FREE"
ShippoAccountCarrierMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
carriers - [ShippoAccountCarrierType]
|
Example
{
"error": "abc123",
"carriers": [ShippoAccountCarrierType]
}
ShippoAccountCarrierServiceMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
services - [ShippoAccountCarrierServiceType]
|
Example
{
"error": "xyz789",
"services": [ShippoAccountCarrierServiceType]
}
ShippoAccountCarrierServiceType
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
carrier - ShippoAccountCarrierType!
|
|
code - String!
|
Service token from Shippo API |
name - String!
|
Human-readable service name |
description - String!
|
Human-readable service description |
isActive - Boolean!
|
Whether this service is active and available for use |
alwaysDisplay - Boolean!
|
Always return this rate option despite cut off setting |
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"carrier": ShippoAccountCarrierType,
"code": "abc123",
"name": "abc123",
"description": "xyz789",
"isActive": true,
"alwaysDisplay": true
}
ShippoAccountCarrierType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
account - ShippoAccountType
|
|
isActive - Boolean!
|
|
shippoObjectId - String!
|
Carrier account ID from Shippo API |
shippoCarrier - String!
|
Carrier code from Shippo API |
shippoCarrierName - String!
|
|
services - [ShippoAccountCarrierServiceType]
|
Example
{
"id": 4,
"account": ShippoAccountType,
"isActive": false,
"shippoObjectId": "abc123",
"shippoCarrier": "xyz789",
"shippoCarrierName": "xyz789",
"services": [ShippoAccountCarrierServiceType]
}
ShippoAccountMutation
Fields
| Field Name | Description |
|---|---|
error - String
|
|
account - ShippoAccountType
|
Example
{
"error": "abc123",
"account": ShippoAccountType
}
ShippoAccountType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
shop - PublicShop
|
|
useIsReturn - Boolean!
|
|
services - String
|
Use ShippoAccountCarrierServiceType.is_active field instead. |
carriers - [ShippoAccountCarrierType]
|
Example
{
"id": "4",
"shop": PublicShop,
"useIsReturn": false,
"services": "abc123",
"carriers": [ShippoAccountCarrierType]
}
ShippoCarrierServiceConfig
Example
{
"carrier": "abc123",
"displayName": "abc123",
"service": "abc123",
"serviceDisplayName": "xyz789",
"width": Decimal,
"height": Decimal,
"unit": "IN",
"rotate": false
}
ShippoCarrierServiceUpdateType
ShippoCarrierUpdateType
ShippoShippoCarrierServiceGlobalConfigUnitChoices
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
in |
|
|
cm |
Example
"IN"
ShipstationShipStationCarrierServiceGlobalConfigUnitChoices
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
in |
|
|
cm |
Example
"IN"
ShopPaymentMethod
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
createdAt - DateTime!
|
|
stripePaymentMethodId - String!
|
Stripe payment method ID (pm_...) |
paymentMethodType - PaymentMethodType
|
|
brand - String!
|
Card brand (visa, mastercard) or bank name |
lastFour - String!
|
Last 4 digits of card or account number |
expMonth - Int
|
Expiration month for cards (1-12) |
expYear - Int
|
Expiration year for cards |
bankName - String!
|
Bank name for ACH payments |
isActive - Boolean!
|
Whether this payment method is active and can be used |
isDefault - Boolean!
|
Whether this is the default payment method for auto-recharge |
status - PaymentSetupStatus
|
|
isExpired - Boolean
|
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"createdAt": "2007-12-03T10:15:30Z",
"stripePaymentMethodId": "xyz789",
"paymentMethodType": "CARD",
"brand": "xyz789",
"lastFour": "abc123",
"expMonth": 123,
"expYear": 123,
"bankName": "xyz789",
"isActive": false,
"isDefault": false,
"status": "PENDING",
"isExpired": false
}
ShopSubscriptionPlan
Fields
| Field Name | Description |
|---|---|
id - Int
|
|
uuid - String!
|
|
subscriptionType - SubscriptionType
|
|
price - Decimal
|
|
perLabelFee - Decimal
|
|
tiered - Boolean
|
|
tierCount - Int
|
|
overagePrice - Decimal
|
|
customQuoteSubscriptionType - SubscriptionType
|
|
customQuoteTierCount - Int
|
|
customQuoteMonthlyPrice - Decimal
|
|
customQuoteOveragePrice - Decimal
|
|
customQuoteAcceptedAt - DateTime
|
|
name - String
|
|
features - [SubscriptionFeature]
|
|
featuresInUse - [SubscriptionFeature]
|
|
hasValidSubscriptionCharge - Boolean
|
|
forceSelectSubscriptionPlan - Boolean
|
|
freeTrialDaysRemaining - Int
|
|
customQuoteSubscribeUrl - String
|
|
onCustomPlan - Boolean
|
|
billingPeriods - [BillingPeriodType]
|
Example
{
"id": 123,
"uuid": "abc123",
"subscriptionType": "FREE",
"price": Decimal,
"perLabelFee": Decimal,
"tiered": true,
"tierCount": 123,
"overagePrice": Decimal,
"customQuoteSubscriptionType": "FREE",
"customQuoteTierCount": 987,
"customQuoteMonthlyPrice": Decimal,
"customQuoteOveragePrice": Decimal,
"customQuoteAcceptedAt": "2007-12-03T10:15:30Z",
"name": "xyz789",
"features": ["ADJUST_RETURN_WINDOWS"],
"featuresInUse": ["ADJUST_RETURN_WINDOWS"],
"hasValidSubscriptionCharge": true,
"forceSelectSubscriptionPlan": false,
"freeTrialDaysRemaining": 123,
"customQuoteSubscribeUrl": "xyz789",
"onCustomPlan": true,
"billingPeriods": [BillingPeriodType]
}
ShopifyFulfillmentType
Example
{
"id": "xyz789",
"name": "abc123",
"status": "abc123",
"deliveredAt": "2007-12-03T10:15:30Z",
"totalQuantity": 987,
"trackingInfo": [ShopifyTrackingInfoType]
}
ShopifyLocation
ShopifyReturnSyncStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"UNSYNCABLE"
ShopifyTrackingInfoType
ShopifyUser
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
uuid - String!
|
|
accountOwner - Boolean!
|
|
preferredLocale - String
|
|
isAdmin - Boolean!
|
|
canManageUsers - Boolean!
|
|
canModifySettings - Boolean!
|
|
canProcessReturns - Boolean!
|
|
shopifyId - String
|
|
email - String!
|
|
firstName - String!
|
|
lastName - String!
|
|
locale - String!
|
|
isActive - Boolean!
|
|
chatHash - String
|
|
shouldUpdate - Boolean
|
|
isDeleted - Boolean!
|
|
shopifyRoles - String
|
Not used anymore |
Example
{
"id": "4",
"uuid": "abc123",
"accountOwner": true,
"preferredLocale": "xyz789",
"isAdmin": true,
"canManageUsers": true,
"canModifySettings": false,
"canProcessReturns": true,
"shopifyId": "xyz789",
"email": "abc123",
"firstName": "xyz789",
"lastName": "xyz789",
"locale": "xyz789",
"isActive": false,
"chatHash": "abc123",
"shouldUpdate": false,
"isDeleted": true,
"shopifyRoles": "xyz789"
}
ShopifyUserUpdateInput
ShopifyUsersBulkUpdate
Fields
| Field Name | Description |
|---|---|
users - [ShopifyUser]
|
|
errors - [String]
|
Example
{
"users": [ShopifyUser],
"errors": ["xyz789"]
}
ShopifyUsersResponse
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
users - [ShopifyUser]!
|
|
totalCount - Int!
|
Example
{"id": 4, "users": [ShopifyUser], "totalCount": 123}
ShopsPackageUnitChoices
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
in |
|
|
cm |
Example
"IN"
ShopsPackageWeightUnitChoices
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
GRAMS |
|
|
KILOGRAMS |
|
|
OUNCES |
|
|
POUNDS |
Example
"GRAMS"
SignedUrl
Stage
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
systemStage - SystemStage
|
|
label - String!
|
|
notification - Notification
|
|
createShopifyReturn - Boolean!
|
ReturnZap will create the Shopify return when the return's stage is changed to this one. |
tags - [String!]!
|
Tags to apply to the Shopify Order when return is moved to this stage. |
uuid - ID!
|
|
archived - Boolean!
|
|
shipmentStatus - ShipmentStatus
|
Use shipment_statuses instead. |
shipmentStatuses - [ShipmentStatus]
|
Example
{
"id": "4",
"systemStage": "AUTOMATICALLY_APPROVED",
"label": "xyz789",
"notification": Notification,
"createShopifyReturn": true,
"tags": ["xyz789"],
"uuid": "4",
"archived": false,
"shipmentStatus": "UNKNOWN",
"shipmentStatuses": ["UNKNOWN"]
}
StageInput
Example
{
"id": "4",
"uuid": "4",
"systemStage": "AUTOMATICALLY_APPROVED",
"label": "abc123",
"generateLabel": true,
"createShopifyReturn": false,
"tags": ["abc123"],
"archived": false,
"deleted": false
}
StageMetricType
StageShipmentStatusInput
Fields
| Input Field | Description |
|---|---|
shipmentStatus - ShipmentStatus!
|
|
stageId - ID!
|
Example
{"shipmentStatus": "UNKNOWN", "stageId": 4}
StageShipmentStatusType
Fields
| Field Name | Description |
|---|---|
stage - Stage
|
|
shipmentStatus - ShipmentStatus
|
Example
{"stage": Stage, "shipmentStatus": "UNKNOWN"}
StoreCreditIncentiveType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ONCE_PER_ITEM"
StoreCreditType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
created - DateTime
|
|
storeCreditType - AutomatedStoreCreditType
|
|
shopifyId - String!
|
Shopify id of the corresponding shopify object, dependent on store credit type |
code - String!
|
|
shopAmount - Decimal!
|
|
shopCurrency - String!
|
|
presentmentAmount - Decimal
|
|
presentmentCurrency - String!
|
|
returnItems - [ReturnItem!]!
|
|
amount - Decimal
|
Amount in shop currency (alias for shop_amount) |
currency - String
|
Currency code (alias for shop_currency) |
Example
{
"id": "4",
"created": "2007-12-03T10:15:30Z",
"storeCreditType": "DISCOUNT_CODE",
"shopifyId": "abc123",
"code": "abc123",
"shopAmount": Decimal,
"shopCurrency": "abc123",
"presentmentAmount": Decimal,
"presentmentCurrency": "abc123",
"returnItems": [ReturnItem],
"amount": Decimal,
"currency": "abc123"
}
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"xyz789"
SubscriptionFeature
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADJUST_RETURN_WINDOWS"
SubscriptionPlan
Fields
| Field Name | Description |
|---|---|
id - Int!
|
|
uuid - ID!
|
|
subscriptionType - SubscriptionType!
|
|
tiered - Boolean!
|
|
name - String!
|
|
features - [SubscriptionFeature]!
|
|
exclusiveFeatures - [SubscriptionFeature]!
|
|
featuresWouldBeLost - [SubscriptionFeature]!
|
|
tiers - [SubscriptionPlanTierType]!
|
|
price - Decimal
|
Use monthlyPrice on tiers instead |
published - Boolean
|
Only published plans are visible to customers |
subscribeUrl - String
|
Use subscribe_url on tiers instead |
Example
{
"id": 987,
"uuid": "4",
"subscriptionType": "FREE",
"tiered": false,
"name": "abc123",
"features": ["ADJUST_RETURN_WINDOWS"],
"exclusiveFeatures": ["ADJUST_RETURN_WINDOWS"],
"featuresWouldBeLost": ["ADJUST_RETURN_WINDOWS"],
"tiers": [SubscriptionPlanTierType],
"price": Decimal,
"published": false,
"subscribeUrl": "abc123"
}
SubscriptionPlanTierType
SubscriptionType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FREE"
SuggestedRefundType
Fields
| Field Name | Description |
|---|---|
productsSet - MoneySet
|
|
taxesSet - MoneySet
|
|
subtotalSet - MoneySet
|
|
exchangesSet - MoneySet
|
|
normalizationAdjustmentSet - MoneySet
|
Price normalization adjustment. Positive = price increased (reduces cost), Negative = price decreased (increases cost) |
shippingSet - MoneySet
|
|
availableForRefundSet - MoneySet
|
|
suggestedRefundSet - MoneySet
|
|
handlingFeeChargedSet - MoneySet
|
|
handlingFeeSuggestedSet - MoneySet
|
|
restockingFeeChargedSet - MoneySet
|
|
restockingFeeSuggestedSet - MoneySet
|
|
storeCreditIncentiveAmountSet - MoneySet
|
Example
{
"productsSet": MoneySet,
"taxesSet": MoneySet,
"subtotalSet": MoneySet,
"exchangesSet": MoneySet,
"normalizationAdjustmentSet": MoneySet,
"shippingSet": MoneySet,
"availableForRefundSet": MoneySet,
"suggestedRefundSet": MoneySet,
"handlingFeeChargedSet": MoneySet,
"handlingFeeSuggestedSet": MoneySet,
"restockingFeeChargedSet": MoneySet,
"restockingFeeSuggestedSet": MoneySet,
"storeCreditIncentiveAmountSet": MoneySet
}
SuggestionRefundType
Fields
| Field Name | Description |
|---|---|
taxesIncluded - Boolean
|
Whether taxes are included in the subtotal price of the order. |
currency - String
|
Currency code e.g. USD |
shopCurrency - String
|
Shop currency code e.g. USD |
discountedSubtotalAmount - Decimal
|
The sum of all the discounted prices of the line items being refunded. |
shopDiscountedSubtotalAmount - Decimal
|
The sum of all the discounted prices of the line items being refunded in Shop currency. |
totalTaxAmount - Decimal
|
Total tax amount on original order |
shopTotalTaxAmount - Decimal
|
Total tax amount on original order in shop currency |
totalTaxAmountForReturnedItems - Decimal
|
Total tax amount for the items being returned |
shopTotalTaxAmountForReturnedItems - Decimal
|
Total tax amount for the items being returned in shop currency |
shippingAmount - Decimal
|
Shipping amount to refund for the selected line items |
shopShippingAmount - Decimal
|
Shipping shop amount to refund for the selected line items |
shippingTaxAmount - Decimal
|
Shipping tax amount to refund for the selected line items |
shopTaxShippingAmount - Decimal
|
Shipping shop tax amount to refund for the selected line items |
shippingTaxAmountForReturnedItems - Decimal
|
Shipping tax amount for the items being returned |
shopShippingTaxAmountForReturnedItems - Decimal
|
Shipping shop tax amount for the items being returned in shop currency |
totalAmount - Decimal
|
Total amount to refund for the selected line items + shipping amount |
shopTotalAmount - Decimal
|
Total shop amount to refund for the selected line items + shipping amount |
suggestedAmountForReturnedItems - Decimal
|
Suggested refund for the returned items |
shopSuggestedAmountForReturnedItems - Decimal
|
Suggested refund for the returned items in shop currency |
Example
{
"taxesIncluded": true,
"currency": "xyz789",
"shopCurrency": "xyz789",
"discountedSubtotalAmount": Decimal,
"shopDiscountedSubtotalAmount": Decimal,
"totalTaxAmount": Decimal,
"shopTotalTaxAmount": Decimal,
"totalTaxAmountForReturnedItems": Decimal,
"shopTotalTaxAmountForReturnedItems": Decimal,
"shippingAmount": Decimal,
"shopShippingAmount": Decimal,
"shippingTaxAmount": Decimal,
"shopTaxShippingAmount": Decimal,
"shippingTaxAmountForReturnedItems": Decimal,
"shopShippingTaxAmountForReturnedItems": Decimal,
"totalAmount": Decimal,
"shopTotalAmount": Decimal,
"suggestedAmountForReturnedItems": Decimal,
"shopSuggestedAmountForReturnedItems": Decimal
}
SystemStage
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AUTOMATICALLY_APPROVED"
TaxNumberInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
taxNumberType - TaxNumberType!
|
|
country - String!
|
|
value - String!
|
Example
{
"id": "4",
"taxNumberType": "VAT",
"country": "abc123",
"value": "abc123"
}
TaxNumberOutput
Fields
| Field Name | Description |
|---|---|
id - UUID!
|
|
taxNumberType - TaxNumberType!
|
|
country - String!
|
|
value - String!
|
|
errors - [GQLErrorType]
|
Example
{
"id": "b3ff60d6-c196-4d40-8663-75ff30ce4bec",
"taxNumberType": "VAT",
"country": "xyz789",
"value": "xyz789",
"errors": [GQLErrorType]
}
TaxNumberType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"VAT"
TranslatableMessageType
Description
Combined view of base translation + overrides for admin UI
Fields
| Field Name | Description |
|---|---|
key - String!
|
|
category - String!
|
|
englishMessage - String!
|
|
exposeForCustomization - Boolean!
|
|
translations - [TranslationVariantType]
|
|
customizedTranslations - [CustomizedTranslationType]
|
Example
{
"key": "abc123",
"category": "xyz789",
"englishMessage": "abc123",
"exposeForCustomization": true,
"translations": [TranslationVariantType],
"customizedTranslations": [CustomizedTranslationType]
}
TranslatedModel
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"RETURN_REASON"
TranslationOverride
TranslationOverrideInput
TranslationVariantType
UUID
Description
Leverages the internal Python implementation of UUID (uuid.UUID) to provide native UUID objects in fields, resolvers and input.
Example
"b3ff60d6-c196-4d40-8663-75ff30ce4bec"
UpdateBalanceSettings
Fields
| Field Name | Description |
|---|---|
balanceSettings - BalanceSettingsType
|
|
errors - [GQLErrorType]
|
Example
{
"balanceSettings": BalanceSettingsType,
"errors": [GQLErrorType]
}
UpdateMissingReturnItems
UpdatePaymentMethod
Fields
| Field Name | Description |
|---|---|
paymentMethod - ShopPaymentMethod
|
|
success - Boolean
|
|
errors - [GQLErrorType]
|
Example
{
"paymentMethod": ShopPaymentMethod,
"success": true,
"errors": [GQLErrorType]
}
UpdatePortalConfig
Fields
| Field Name | Description |
|---|---|
portalConfig - PortalConfigType
|
|
error - String
|
Example
{
"portalConfig": PortalConfigType,
"error": "xyz789"
}
UpdateResolveReturnItems
UpdateReturn
UpdateSettings
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
|
error - String
|
|
fieldErrors - [FieldErrorType]
|
|
shop - AuthenticatedShop
|
Example
{
"success": true,
"error": "abc123",
"fieldErrors": [FieldErrorType],
"shop": AuthenticatedShop
}
UpdateTranslationOverride
Description
Update multiple customized translations for a shop
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
|
error - String
|
|
customizedTranslations - [CustomizedTranslationType]
|
Example
{
"success": true,
"error": "xyz789",
"customizedTranslations": [CustomizedTranslationType]
}
UpdateUserPreferences
Description
This mutation updates the user preferences
Fields
| Field Name | Description |
|---|---|
success - Boolean
|
|
user - ShopifyUser
|
Example
{"success": true, "user": ShopifyUser}
VoidShipment
WarehouseAddressInput
Example
{
"userName": "xyz789",
"company": "xyz789",
"street1": "abc123",
"phone": "abc123",
"street2": "xyz789",
"country": "xyz789",
"city": "abc123",
"zip": "xyz789",
"state": "abc123"
}
WarehouseCreate
Fields
| Field Name | Description |
|---|---|
error - String
|
|
warehouse - WarehouseType
|
Example
{
"error": "abc123",
"warehouse": WarehouseType
}
WarehouseDelete
Fields
| Field Name | Description |
|---|---|
error - String
|
Example
{"error": "xyz789"}
WarehouseInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
|
name - String!
|
|
address - WarehouseAddressInput
|
Example
{
"id": "4",
"name": "xyz789",
"address": WarehouseAddressInput
}
WarehouseType
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
address - AddressType
|
Example
{
"id": "4",
"name": "abc123",
"address": AddressType
}
WarehouseUpdate
Fields
| Field Name | Description |
|---|---|
error - String
|
|
warehouse - WarehouseType
|
Example
{
"error": "xyz789",
"warehouse": WarehouseType
}
WebhookEventType
Description
An enumeration.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"RETURN_CREATED"