shopify: appmixer.shopify.discounts.GetDiscountCode

Basic Information

Name

appmixer.shopify.discounts.GetDiscountCode

Version

1.0.0

Visibility

Public

Description

Get the discount a discount code belongs to: its terms, status and codes.

Input Ports

in

Field	Type	Description
Discount Code	text	The discount code to look up, e.g. SUMMER15. Codes are not case-sensitive.

Output Ports

out

Field	Type	Description
Discount ID	string	-
Discount Type	string	-
Title	string	-
Status	string	-
Starts At	string	-
Ends At	string	-
Usage Limit	integer	-
Once Per Customer	boolean	-
Usage Count	integer	-
Created At	string	-
Updated At	string	-
Combines With	object	-
Codes	array	-
Summary	string	-
Customer Gets	object	-
Minimum Requirement	object	-

Full Metadata

#metadata-viewer { display: none; }{ "name": "appmixer.shopify.discounts.GetDiscountCode", "description": "Get the discount a discount code belongs to: its terms, status and codes.", "author": "Appmixer <info@appmixer.com>", "private": false, "auth": { "service": "appmixer:shopify", "scope": [ "read_discounts" ] }, "quota": { "manager": "appmixer:shopify", "resources": "requests", "scope": { "userId": "{{userId}}" } }, "inPorts": [ { "name": "in", "schema": { "type": "object", "properties": { "code": { "type": "string" } }, "required": [ "code" ] }, "inspector": { "inputs": { "code": { "type": "text", "label": "Discount Code", "index": 0, "tooltip": "The discount code to look up, e.g. <b>SUMMER15</b>. Codes are not case-sensitive." } } } } ], "outPorts": [ { "name": "out", "schema": { "type": "object", "required": [ "id", "discountType", "title", "status", "startsAt", "appliesOncePerCustomer", "asyncUsageCount", "createdAt", "updatedAt", "combinesWith", "codes" ], "properties": { "id": { "type": "string", "title": "Discount ID", "example": "gid://shopify/DiscountCodeNode/2382143062097" }, "discountType": { "type": "string", "title": "Discount Type", "example": "DiscountCodeBasic" }, "title": { "type": "string", "title": "Title", "example": "Autumn sale" }, "status": { "type": "string", "title": "Status", "example": "ACTIVE" }, "startsAt": { "type": "string", "title": "Starts At", "example": "2026-10-05T08:23:12Z", "format": "date-time" }, "endsAt": { "type": "string", "title": "Ends At", "example": "2026-11-04T08:23:12Z", "format": "date-time" }, "usageLimit": { "type": "integer", "title": "Usage Limit", "example": 10 }, "appliesOncePerCustomer": { "type": "boolean", "title": "Once Per Customer", "example": false }, "asyncUsageCount": { "type": "integer", "title": "Usage Count", "example": 0 }, "createdAt": { "type": "string", "title": "Created At", "example": "2026-10-05T08:23:13Z", "format": "date-time" }, "updatedAt": { "type": "string", "title": "Updated At", "example": "2026-10-05T08:23:13Z", "format": "date-time" }, "combinesWith": { "type": "object", "title": "Combines With", "required": [ "orderDiscounts", "productDiscounts", "shippingDiscounts" ], "properties": { "orderDiscounts": { "type": "boolean", "title": "Combines With.Order Discounts", "example": false }, "productDiscounts": { "type": "boolean", "title": "Combines With.Product Discounts", "example": false }, "shippingDiscounts": { "type": "boolean", "title": "Combines With.Shipping Discounts", "example": false } } }, "codes": { "type": "array", "title": "Codes", "items": { "type": "object", "required": [ "id", "code", "asyncUsageCount", "createdAt" ], "properties": { "id": { "type": "string", "title": "ID", "example": "gid://shopify/DiscountRedeemCode/34881968013393" }, "code": { "type": "string", "title": "Code", "example": "AUTUMN15" }, "asyncUsageCount": { "type": "integer", "title": "Usage Count", "example": 0 }, "createdAt": { "type": "string", "title": "Created At", "example": "2026-10-05T08:23:13Z", "format": "date-time" } } }, "example": [ { "id": "gid://shopify/DiscountRedeemCode/34881968013393", "code": "AUTUMN15", "asyncUsageCount": 0, "createdAt": "2026-10-05T08:23:13Z" } ] }, "summary": { "type": "string", "title": "Summary", "example": "15% off one-time purchase products • Minimum purchase of $50.00" }, "customerGets": { "type": "object", "title": "Customer Gets", "required": [ "value" ], "properties": { "value": { "type": "object", "title": "Customer Gets.Value", "properties": { "percentage": { "type": "number", "title": "Customer Gets.Value.Percentage", "example": 0.15 }, "amount": { "type": "object", "title": "Customer Gets.Value.Amount", "required": [ "amount", "currencyCode" ], "properties": { "amount": { "type": "string", "title": "Customer Gets.Value.Amount.Amount", "example": "5.0" }, "currencyCode": { "type": "string", "title": "Customer Gets.Value.Amount.Currency Code", "example": "USD" } } }, "appliesOnEachItem": { "type": "boolean", "title": "Customer Gets.Value.Applies on Each Item", "example": false } } } } }, "minimumRequirement": { "type": "object", "title": "Minimum Requirement", "properties": { "greaterThanOrEqualToSubtotal": { "type": "object", "title": "Minimum Requirement.Minimum Subtotal", "required": [ "amount", "currencyCode" ], "properties": { "amount": { "type": "string", "title": "Minimum Requirement.Minimum Subtotal.Amount", "example": "50.0" }, "currencyCode": { "type": "string", "title": "Minimum Requirement.Minimum Subtotal.Currency Code", "example": "USD" } } }, "greaterThanOrEqualToQuantity": { "type": "string", "title": "Minimum Requirement.Minimum Quantity", "example": "2" } } } } } } ], "icon": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiA/PjwhRE9DVFlQRSBzdmcgIFBVQkxJQyAnLS8vVzNDLy9EVEQgU1ZHIDEuMS8vRU4nICAnaHR0cDovL3d3dy53My5vcmcvR3JhcGhpY3MvU1ZHLzEuMS9EVEQvc3ZnMTEuZHRkJz48c3ZnIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDEyOCAxMjgiIGlkPSJTb2NpYWxfSWNvbnMiIHZlcnNpb249IjEuMSIgdmlld0JveD0iMCAwIDEyOCAxMjgiIHhtbDpzcGFjZT0icHJlc2VydmUiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiPjxnIGlkPSJfeDM3X19zdHJva2UiPjxnIGlkPSJTaG9waWZ5Ij48cmVjdCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGZpbGw9Im5vbmUiIGZpbGwtcnVsZT0iZXZlbm9kZCIgaGVpZ2h0PSIxMjgiIHdpZHRoPSIxMjgiLz48cGF0aCBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik03MC40NSwxOS41NjhjMC0wLjQzNiwwLjAwNC0wLjg2NCwwLjAwNC0xLjMzMiAgICBjMC00LjA4LTAuNTY1LTcuMzY4LTEuNDY5LTkuOTcyYzMuNjM0LDAuNDU2LDYuMDU0LDQuNjEyLDcuNjEsOS4zOTJDNzQuNzczLDE4LjIyNCw3Mi42OTksMTguODY4LDcwLjQ1LDE5LjU2OHogTTYyLjQyNiw2MC4yNDggICAgYzAsMC00LjI1MS0yLjI4LTkuNDYxLTIuMjhjLTcuNjQyLDAtOC4wMjgsNC44Mi04LjAyOCw2LjAzMmMwLDYuNjI4LDE3LjE4Nyw5LjE2OCwxNy4xODcsMjQuNjg4ICAgIGMwLDEyLjIwOC03LjcwNiwyMC4wNzItMTguMDk4LDIwLjA3MmMtMTIuNDcsMC0xOC44NDYtNy44LTE4Ljg0Ni03LjhsMy4zMzktMTEuMDg0YzAsMCw2LjU1NSw1LjY1NiwxMi4wODgsNS42NTYgICAgYzMuNjEsMCw1LjA4My0yLjg2LDUuMDgzLTQuOTQ4YzAtOC42NDQtMTQuMTAyLTkuMDMyLTE0LjEwMi0yMy4yMzZjMC0xMS45NTIsOC41MzgtMjMuNTIsMjUuNzcyLTIzLjUyICAgIGM2LjYzOSwwLDkuOTIzLDEuOTEyLDkuOTIzLDEuOTEyTDYyLjQyNiw2MC4yNDh6IE01OS41OTYsNC40MjhjMC43MTIsMCwxLjQyNSwwLjI0NCwyLjExLDAuNzE2ICAgIGMtNS4yNjYsMi40ODgtMTAuOTA2LDguNzYtMTMuMjksMjEuMjhjLTMuNDgzLDEuMDg0LTYuODg2LDIuMTQ0LTEwLjAzNCwzLjEyNEM0MS4xNzEsMTkuOTk2LDQ3Ljc5OCw0LjQyOCw1OS41OTYsNC40Mjh6ICAgICBNNjYuMTQ3LDIwLjE5MmMwLDAuMjUyLTAuMDA0LDAuNDg0LTAuMDA0LDAuNzE2Yy00LDEuMjQ0LTguMzQzLDIuNTk2LTEyLjY5NywzLjk1MkM1NS44OSwxNS4zOCw2MC40NzIsMTAuOCw2NC40OCw5LjA3MiAgICBDNjUuNDg3LDExLjYxNiw2Ni4xNDcsMTUuMjY4LDY2LjE0NywyMC4xOTJ6IE04NS4wNTgsMTUuMDk3Yy0wLjI2LDAuMDM0LTAuNDg1LDAuMDg1LTAuNjQyLDAuMTMxICAgIGMtMC4wODQsMC4wMjQtMS40ODUsMC40Ni0zLjgwNSwxLjE4Qzc4LjMzOSw5Ljg0LDc0LjMzMSwzLjgwNCw2Ny4yODIsMy44MDRjLTAuMTk1LDAtMC4zOTgsMC4wMDgtMC41OTcsMC4wMiAgICBDNjQuNjc5LDEuMTYsNjIuMTk1LDAsNjAuMDUsMEM0My42MjMsMCwzNS43NzQsMjAuNjQsMzMuMzE0LDMxLjEyNGMtNi4zODQsMS45ODgtMTAuOTE4LDMuNC0xMS40OTUsMy41ODQgICAgYy0zLjU2NiwxLjEyNC0zLjY3OCwxLjIzNi00LjE0Myw0LjYwOEMxNy4zMjIsNDEuODcyLDgsMTE0LjMyNCw4LDExNC4zMjRMODAuNjM5LDEyOGwwLjA3Ny0wLjAxN0w4NS4wNTgsMTUuMDk3eiBNOTAuMjU5LDE4LjY1MiAgICBjMi4wOTcsMi4wOTMsNC40NzUsNC40NjQsNC40NzUsNC40NjRzOS43ODcsMC43MjgsMTAuMjQ5LDAuNzY4YzAuNDY2LDAuMDQsMS4wMjcsMC4zOTYsMS4xMTQsMS4wNCAgICBjMC4wODgsMC42NDQsMTMuOTAzLDk0LjUyLDEzLjkwMyw5NC41MmwtMzMuOTAxLDcuMzY5TDkwLjI1OSwxOC42NTJ6IiBmaWxsPSIjODFCRjM3IiBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGlkPSJTaG9waWZ5XzFfIi8+PC9nPjwvZz48L3N2Zz4=" }