Documentation

Shopify Create Replacement Order

Inputs

NameTypeDescription
Shopify TokenSensitiveStringShopify API token
Shopify DomainStringShopify domain
Order IDStringShopify order ID
Replacement ReasonStringReason for replacement
Check for Previous ReplacementsBooleanWhether to check for previous replacements for the order customer
Billing AddressOptional ObjectBilling address for the replacement order
Shipping AddressOptional ObjectShipping address for the replacement orde
Line ItemsOptional ListLine items to be replaced
Discount CodesOptional ObjectA list of Shopify discounts if using discount type of custom
Discount TypeString100% or custom. Custom will take into consideration the Discount Codes input.
Shipping LinesOptional ListShopify shipping lines, if not provided, then would copy the shipping line title, code, and source from original order and set price to zero
Hour LimitOptional NumberHour limit for replacements created
Twelve Hour LimitOptional NumberTwelve hours limit for replacements created
Twenty Four Hour LimitOptional NumberTwenty four hours limit for replacements created

📘

Billing Address, Shipping Address, Line Items, Shipping Lines are all optional inputs. In case they are not provided the data will be copied from the original order.

📘

Discount Codes is also an optional input and will be considered only if the Discount Type is custom.

📘

Hour Limit, Twelve Hour Limit, Twenty Four Hour Limit are also optional inputs and will be considered only if the Check for Previous Replacements input is set to true. They also have default values of 10, 30 and 50 respectively.

Outputs

NameTypeDescription
Replacement Order CreatedBooleanWhether the replacement order was created
Replacement Metaobject CreatedBooleanWhether the replacement metaobject was created
Replacement Note CreatedBooleanWhether the replacement note was created
Replacement Metafields CreatedBooleanWhether the replacement metafields were created
Blocked by Safety ChecksBooleanWhether the replacement was blocked by safety checks
Order IDNumberReplacement order ID
OrderObjectReplacement order

📘

Replacement Order Created does depend on the initial Replacement Metaobject Created.

📘

Blocked by Safety Checks will return true whenever the order creation was blocked by metafields checks or limit checks.