Shopify Functions

https://shopify.dev/docs/api/functions/latest
Admin
Shopify Functions allow developers to customize Shopify's backend logic during checkout by running...
Tokens:288,914
Snippets:2,139
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### cart.delivery-options.transform.run

Source: https://shopify.dev/docs/api/functions/latest/delivery-customization

Documentation for the cart.delivery-options.transform.run function, including its input fields, output schema, and an example entrypoint in Rust.

```APIDOC
## [FUNCTION] cart.delivery-options.transform.run

### Description
This function processes input data to generate a standardized list of operations that generate delivery customizations. Each operation specifies a delivery customization that Shopify processes to modify delivery options during checkout.

### Function
cart.delivery-options.transform.run

### Input
- **Input.deliveryCustomization.metafield.jsonValue** (JSON) - The assigned field value in JSON format.
- **Input.deliveryCustomization.metafield.key** (String!) - The object key of this field.
- **Input.deliveryCustomization.metafield.type** (String!) - The type of the field.
- **Input.deliveryCustomization.metafield.value** (String) - The assigned field value, always stored as a string regardless of the field type.
- **Input.deliveryCustomization.handle** (String!) - The unique handle of the metaobject, useful as a custom ID.
- **Input.deliveryCustomization.type** (String!) - The type of the metaobject.

### Output
- **CartDeliveryOptionsTransformRunResult** (OBJECT) - The output of the function run target. Contains the operations to apply to delivery options in checkout.
  - **operations** ([Operation!]!) - The ordered list of operations to apply to the list of delivery options.
    - **deliveryOptionHide** (DeliveryOptionHideOperation) - An operation that hides a delivery option from a list that's offered to customers at checkout.
      - **deliveryOptionHandle** (Handle!) - The handle of the delivery option to hide.
    - **deliveryOptionMove** (DeliveryOptionMoveOperation) - An operation that sorts a list of delivery options that are offered to customers at checkout.
      - **deliveryOptionHandle** (Handle!) - The handle of the delivery option to move.
      - **index** (Int!) - The target index within the delivery group to move the delivery option to.
    - **deliveryOptionRename** (DeliveryOptionRenameOperation) - An operation that renames a delivery option that's offered to customers at checkout.
      - **deliveryOptionHandle** (Handle!) - The handle of the delivery option to rename.
      - **title** (String!) - The new name for the delivery option.

### Example
#### Entrypoint (Rust)
```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_delivery_options_transform_run;

#[typegen("./schema.graphql")]
pub mod schema {
    #[query("src/cart_delivery_options_transform_run.graphql", custom_scalar_overrides = {
        "Input.deliveryCustomization.metafield.jsonValue" => super::cart_delivery_options_transform_run::Configuration,
    })]
    pub mod cart_delivery_options_transform_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```
```

--------------------------------

### Rust entrypoint for cart.lines.discounts.generate.run

Source: https://shopify.dev/docs/api/functions/latest/discount

Rust entrypoint for a Shopify function that applies a per-item discount with quantity limits. It defines the schema module and aborts if invoked directly.

```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_lines_discounts_generate_run;

#[typegen("schema.graphql")]
pub mod schema {
    #[query("src/cart_lines_discounts_generate_run.graphql", custom_scalar_overrides = {"Input.discount.metafield.jsonValue" => super::cart_lines_discounts_generate_run::Configuration})]
    pub mod cart_lines_discounts_generate_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```

--------------------------------

### Rust input object for Buy X get Y discount

Source: https://shopify.dev/docs/api/functions/latest/discount

Example input object for the Rust version of the Buy X get Y discount function, showing two cart lines with product IDs 123456 and 123457.

```json
{
  "cart": {
    "lines": [
      {
        "id": "gid://shopify/CartLine/1",
        "merchandise": {
          "__typename": "ProductVariant",
          "product": {
            "id": "gid://shopify/Product/123456"
          }
        }
      },
      {
        "id": "gid://shopify/CartLine/2",
        "merchandise": {
          "__typename": "ProductVariant",
          "product": {
            "id": "gid://shopify/Product/123457"
          }
        }
      }
    ]
  }
}
```

--------------------------------

### Rust entrypoint for cart.lines.discounts.generate.run

Source: https://shopify.dev/docs/api/functions/latest/discount

Rust entrypoint for a Shopify discount function. It declares the cart_lines_discounts_generate_run module, sets up the schema typegen, and aborts if main is invoked directly.

```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_lines_discounts_generate_run;

#[typegen("schema.graphql")]
pub mod schema {
    #[query("src/cart_lines_discounts_generate_run.graphql")]
    pub mod cart_lines_discounts_generate_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}

```

--------------------------------

### Rust input object example

Source: https://shopify.dev/docs/api/functions/latest/order-discount

Example input object for the Rust function, showing a cart line with a product variant that has the 'new_collection' tag.

```json
{
    "cart": {
      "lines": [
        {
          "merchandise": {
            "__typename": "ProductVariant",
            "id": "gid://shopify/ProductVariant/46711460495653",
            "product": {
              "hasAnyTag": true
            }
          }
        }
      ]
    }
  }
```

--------------------------------

### JSON input example for cart field

Source: https://shopify.dev/docs/api/functions/latest

Example JSON input data matching the GraphQL query. It provides a sample value for the cart_field property.

```json
{
  "cart": {
    "cart_field": {
      "property": "bar"
    }
  }
}
```

--------------------------------

### Output JSON (Rust) for delivery discount function

Source: https://shopify.dev/docs/api/functions/latest/discount

Example output JSON for a Rust implementation of the delivery discount function. Shows the operations structure with selectionStrategy "ALL" and two candidates with fixedAmount discounts.

```json
{
  "operations": [
    {
      "deliveryDiscountsAdd": {
        "selectionStrategy": "ALL",
        "candidates": [
          {
            "message": "Free shipping for members",
            "targets": [
              {
                "deliveryOption": {
                  "handle": "cae179072e1b0a565f51700b666b62c5-b514e01af8655a9229f7a04405396118"
                }
              }
            ],
            "value": {
              "fixedAmount": {
                "amount": "1.0"
              }
            }
          },
          {
            "message": "$5 off shipping for members",
            "targets": [
              {
                "deliveryOption": {
                  "handle": "cae179072e1b0a565f51700b666b62c5-fbcaff8dd39a68820109eb990460be0a"
                }
              }
            ],
            "value": {
              "fixedAmount": {
                "amount": "5.0"
              }
            }
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Input Query Cost Example

Source: https://shopify.dev/docs/api/functions/latest

An example GraphQL input query for a Shopify Function, demonstrating how the query cost is calculated based on the field cost table.

```APIDOC
## Input Query Cost Example

### Description
An example GraphQL input query for a Shopify Function, demonstrating how the query cost is calculated based on the field cost table.

### Method
GraphQL Query

### Endpoint
N/A (Function input query)

### Parameters
#### Query Variables
- **customerTag** (String) - Optional - Default: "VIP" - A tag used in the `hasTags` field.

### Request Example
```graphql
query RunInput($customerTag: String! = "VIP") {
  cart {
    lines {
      id
      quantity
    }
    buyerIdentity {
      customer {
        hasTags(tags: [$customerTag]) {
          hasTag
        }
      }
    }
  }
  discount {
    metafield(namespace: "$app:example", key: "function-configuration") {
      jsonValue
    }
  }
}
```

### Cost Breakdown
| Selection | Cost |
| - | - |
| `id` and `quantity` on `lines` | 2 |
| `hasTags` on `customer` | 3 |
| `metafield` on `discount` | 3 |
| Container fields, and the fields on the `HasTagResponse` and `Metafield` objects | 0 |
| **Total** | **8 of 30** |
```

--------------------------------

### Output JSON for fixed amount discount (Rust)

Source: https://shopify.dev/docs/api/functions/latest/product-discount

Example output JSON for the fixed amount discount function, showing a discount of 10.0 applied to 2 items of a product variant.

```json
{
  "discountApplicationStrategy": "FIRST",
  "discounts": [
    {
      "message": "Discount applied",
      "targets": [
        {
          "productVariant": {
            "id": "gid://shopify/ProductVariant/1",
            "quantity": 2
          }
        }
      ],
      "value": {
        "fixedAmount": {
          "amount": "10.0",
          "appliesToEachItem": true
        }
      }
    }
  ]
}
```

--------------------------------

### Input Object (JavaScript)

Source: https://shopify.dev/docs/api/functions/latest/shipping-discount

Example input object for the JavaScript function. Contains a cart with one delivery group to Ottawa, offering Standard (free) and Express ($21.9) delivery options. The handle values differ from the Rust input example.

```json
{
  "cart": {
    "deliveryGroups": [
      {
        "id": "gid://shopify/CartDeliveryGroup/0",
        "deliveryAddress": {
          "city": "Ottawa"
        },
        "deliveryOptions": [
          {
            "handle": "ddba6f20f9fbc5983257805852308679-b1a2fe47040bfe8f971ccb0abbcf8ea1",
            "title": "Standard",
            "cost": {
              "amount": "0.0"
            }
          },
          {
            "handle": "ddba6f20f9fbc5983257805852308679-71c568b7bd38c0bc23d9e7457ab6aa3b",
            "title": "Express",
            "cost": {
              "amount": "21.9"
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Input Object for cart.delivery-options.discounts.generate.run

Source: https://shopify.dev/docs/api/functions/latest/discount

Example input object for the delivery options discount function. It shows a cart with a subtotal of $120.00 and two delivery options, plus a configuration metafield with tiered thresholds and percentages.

```json
{
  "cart": {
    "cost": {
      "subtotalAmount": {
        "amount": "120.00",
        "currencyCode": "USD"
      }
    },
    "deliveryGroups": [
      {
        "deliveryOptions": [
          {
            "handle": "standard",
            "cost": {
              "amount": "10.00",
              "currencyCode": "USD"
            }
          },
          {
            "handle": "express",
            "cost": {
              "amount": "20.00",
              "currencyCode": "USD"
            }
          }
        ]
      }
    ]
  },
  "discount": {
    "metafield": {
      "jsonValue": {
        "tiers": [
          {
            "threshold": 50,
            "percentage": 10
          },
          {
            "threshold": 100,
            "percentage": 15
          }
        ]
      }
    }
  }
}
```

--------------------------------

### Input Object (Rust)

Source: https://shopify.dev/docs/api/functions/latest/shipping-discount

Example input object for the Rust function. Contains a cart with one delivery group to Ottawa, offering Standard (free) and Express ($21.9) delivery options. The handle values differ from the JavaScript input example.

```json
{
  "cart": {
    "deliveryGroups": [
      {
        "id": "gid://shopify/CartDeliveryGroup/0",
        "deliveryAddress": {
          "city": "Ottawa"
        },
        "deliveryOptions": [
          {
            "handle": "0d8a74c6e309668ff67eef9d765741ec-b1a2fe47040bfe8f971ccb0abbcf8ea1",
            "title": "Standard",
            "cost": {
              "amount": "0.0"
            }
          },
          {
            "handle": "0d8a74c6e309668ff67eef9d765741ec-71c568b7bd38c0bc23d9e7457ab6aa3b",
            "title": "Express",
            "cost": {
              "amount": "21.9"
            }
          }
        ]
      }
    ]
  }
}
```

--------------------------------

### Output JSON for Rust implementation

Source: https://shopify.dev/docs/api/functions/latest/discount

Example output JSON for the Rust implementation of the custom product discount function. Shows the expected structure with a productDiscountsAdd operation and a percentage value of 20.0.

```json
{
  "operations": [
    {
      "productDiscountsAdd": {
        "candidates": [
          {
            "message": "20% OFF CUSTOM PRODUCT",
            "targets": [
              {
                "cartLine": {
                  "id": "gid://shopify/CartLine/0"
                }
              }
            ],
            "value": {
              "percentage": {
                "value": "20.0"
              }
            }
          }
        ],
        "selectionStrategy": "ALL"
      }
    }
  ]
}
```

--------------------------------

### Output JSON for JavaScript cart transform

Source: https://shopify.dev/docs/api/functions/latest/cart-transform

Example output JSON for a JavaScript cart transform function. Shows the linesMerge operation with three cart lines, parent variant, bundle title, and a 10% price decrease. Unlike the Rust output, this example omits the attributes field.

```json
{
  "operations": [
    {
      "linesMerge": {
        "cartLines": [
          {
            "cartLineId": "gid://shopify/CartLine/1",
            "quantity": 1
          },
          {
            "cartLineId": "gid://shopify/CartLine/2",
            "quantity": 1
          },
          {
            "cartLineId": "gid://shopify/CartLine/3",
            "quantity": 1
          }
        ],
        "parentVariantId": "gid://shopify/ProductVariant/200",
        "title": "Morning Routine Bundle",
        "price": {
          "percentageDecrease": {
            "value": "10.0"
          }
        }
      }
    }
  ]
}
```

--------------------------------

### cart.transform.run

Source: https://shopify.dev/docs/api/functions/latest/cart-transform

Documentation for the cart.transform.run function, including its input, operations, and example implementation.

```APIDOC
## cart.transform.run

### Description
This is the entrypoint for a Cart Transform function. It is invoked by Shopify when a cart is being transformed. The function receives the cart input and returns a list of operations to apply to the cart.

### Method
Function invocation (Cart Transform API)

### Endpoint
cart.transform.run

### Parameters
#### Input
- **cart** (CartInput) - Required - The cart to be transformed.
  - **lines** (List of CartLineInput) - The cart lines.
    - **merchandise** (Merchandise) - The merchandise of the line.
      - **product** (Product) - The product of the merchandise.
        - **giftWrapCost** (Money) - The cost of gift wrapping (custom scalar override).
- **cartTransform** (CartTransformInput) - The configuration for the cart transform.
  - **configuration** (Configuration) - The configuration object (custom scalar override).

### Request Example
```graphql
query CartTransformRun($input: Input!) {
  cartTransformRun(input: $input) {
    operations {
      ... on CartTransformOperation {
        expand {
          cartLines {
            cartLineId
            quantity
            merchandise {
              productVariantId
            }
            price {
              adjustment {
                type
                value
              }
            }
            title
            image {
              url
            }
          }
        }
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **operations** (List of CartTransformOperation) - The operations to apply to the cart.
  - **expand** (ExpandOperation) - An operation that expands a cart line into multiple lines.
    - **cartLines** (List of CartLineInput) - The cart lines to merge.
      - **cartLineId** (ID!) - The globally-unique ID of the cart line.
      - **quantity** (Int!) - The quantity of the cart line to be merged. Max quantity is 2000.
      - **image** (ImageInput) - The image that replaces the existing image for the group of cart line items.
      - **parentVariantId** (ID!) - The globally-unique ID of the product variant that represents the collection of cart line items.
      - **price** (PriceAdjustment) - A change to the original price of a group of items.
      - **title** (String) - The title that replaces the existing title for a group of cart line items.
  - **update** (LineUpdateOperation) - An operation that allows you to override the price, title, and image of a cart line item. Only stores on a Shopify Plus plan can use apps with `update` operations.
    - **cartLineId** (ID!) - The globally-unique ID of the cart line.
    - **image** (ImageInput) - The image that replaces the existing image for the cart line item.
    - **price** (LineUpdateOperationPriceAdjustment) - A change to an item's original price.
    - **title** (String) - The title that replaces the existing title for the cart line item.

### Error Handling
- If the function is not invoked with a named export, it will abort with an error.

### Example
#### Add gift wrapping to cart items
This example demonstrates how to implement an optional gift-wrapping add-on using the Cart Transform expand operation.

1. A customer adds an item to their cart with the "Gift Wrap" attribute.
2. The cart transform function checks for this attribute.
3. The cart line is expanded to add the $5 gift wrap add-on.

#### Entrypoint (Rust)
```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_transform_run;

#[typegen("./schema.graphql")]
pub mod schema {
    #[query("./src/cart_transform_run.graphql",
        custom_scalar_overrides = {
            "Input.cart.lines.merchandise.product.giftWrapCost.jsonValue" => super::cart_transform_run::Money,
            "Input.cartTransform.configuration.jsonValue" => super::cart_transform_run::Configuration,
        }
    )]
    pub mod cart_transform_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```
```

--------------------------------

### Output JSON (Rust) for purchase.product-discount.run

Source: https://shopify.dev/docs/api/functions/latest/product-discount

JSON output for the Rust function, showing a 20% discount on the first cart line.

```json
{
  "discountApplicationStrategy": "FIRST",
  "discounts": [
    {
      "message": "20% off first item",
      "targets": [
        {
          "cartLine": {
            "id": "gid://shopify/CartLine/1"
          }
        }
      ],
      "value": {
        "percentage": {
          "value": "20.0"
        }
      }
    }
  ]
}
```

--------------------------------

### Output JSON for discount operations

Source: https://shopify.dev/docs/api/functions/latest/discount

Example output JSON for a Shopify Functions discount run, containing both productDiscountsAdd and orderDiscountsAdd operations with percentage values and selection strategy FIRST.

```json
{
  "operations": [
    {
      "productDiscountsAdd": {
        "candidates": [
          {
            "message": "15% OFF PRODUCT",
            "targets": [
              {
                "cartLine": {
                  "id": "gid://shopify/CartLine/1"
                }
              }
            ],
            "value": {
              "percentage": {
                "value": 15
              }
            }
          }
        ],
        "selectionStrategy": "FIRST"
      }
    },
    {
      "orderDiscountsAdd": {
        "candidates": [
          {
            "message": "10% OFF ORDER",
            "targets": [
              {
                "orderSubtotal": {
                  "excludedCartLineIds": []
                }
              }
            ],
            "value": {
              "percentage": {
                "value": 10
              }
            }
          }
        ],
        "selectionStrategy": "FIRST"
      }
    }
  ]
}
```

--------------------------------

### Input query cost example (GraphQL)

Source: https://shopify.dev/docs/api/functions/latest

Example input query for Shopify Functions with a calculated cost of 8 out of 30. It selects fields on cart lines, customer tags, and a discount metafield, with inline comments showing the cost contribution of each field. Use this as a reference for staying within the maximum query cost of 30.

```graphql
query RunInput($customerTag: String! = "VIP") {
  cart {                                  # Container field: 0
    lines {                               # Container field: 0
      id                                  # Other leaf node: 1
      quantity                            # Other leaf node: 1
    }
    buyerIdentity {                       # Container field: 0
      customer {                          # Container field: 0
        hasTags(tags: [$customerTag]) {   # hasTags: 3
          hasTag                          # Field on a HasTagResponse object: 0
        }
      }
    }
  }
  discount {                              # Container field: 0
    metafield(namespace: "$app:example", key: "function-configuration") {   # Field that returns a Metafield object: 3
      jsonValue                           # Field on a Metafield object: 0
    }
  }
}
```

--------------------------------

### Rust Entrypoint for Configurable Discount Function

Source: https://shopify.dev/docs/api/functions/latest/discount

Rust entrypoint for a Shopify Discount Function that reads configuration from a discount metafield. It declares two modules for cart lines and delivery options discounts, sets up GraphQL type generation with custom scalar overrides for the metafield JSON value, and aborts if invoked without a named export.

```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_delivery_options_discounts_generate_run;
pub mod cart_lines_discounts_generate_run;

#[typegen("./schema.graphql")]
pub mod schema {
    #[query("src/cart_lines_discounts_generate_run.graphql", custom_scalar_overrides = {
        "Input.discount.metafield.jsonValue" => super::cart_lines_discounts_generate_run::Configuration,
    })]
    pub mod cart_lines_discounts_generate_run {}
    #[query("src/cart_delivery_options_discounts_generate_run.graphql", custom_scalar_overrides = {
        "Input.discount.metafield.jsonValue" => super::cart_delivery_options_discounts_generate_run::Configuration,
    })]
    pub mod cart_delivery_options_discounts_generate_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```

--------------------------------

### CartValidationsGenerateRun

Source: https://shopify.dev/docs/api/functions/latest/cart-and-checkout-validation

Documentation for the CartValidationsGenerateRun function run target, including its output schema and an example implementation.

```APIDOC
## [Function] cart-validations-generate-run

### Description
This function processes input data to generate a standardized list of operations that apply to the cart or checkout. Each operation specifies validations to apply. When a validation error is returned, Shopify processes the response to add error messages to targeted fields during checkout.

### Method
Function run target

### Endpoint
CartValidationsGenerateRun

### Parameters
#### Input
- **input** (object) - Required - The input data for the function run.

#### Output
- **operations** (array of Operation) - Required - An ordered list of operations to be executed for the validations associated with the cart and checkout processes.

### Request Example
```graphql
query CartValidationsGenerateRun($input: CartValidationsGenerateRunInput!) {
  cartValidationsGenerateRun(input: $input) {
    operations {
      validationAdd {
        errors {
          message
          target
        }
      }
    }
  }
}
```

### Response
#### Success Response (200)
- **operations** (array of Operation) - The list of operations to be executed.
  - **validationAdd** (ValidationAddOperation) - An operation that adds validations to the cart and checkout.
    - **errors** (array of ValidationError) - The validation errors that block a customer from proceeding through checkout.
      - **message** (String) - A description of the validation error.
      - **target** (String) - The identifier in `shopify.extension.toml` that specifies where you're injecting code in the checkout process.

#### Response Example
```json
{
  "operations": [
    {
      "validationAdd": {
        "errors": [
          {
            "message": "The product is out of stock",
            "target": "cart"
          }
        ]
      }
    }
  ]
}
```
```

--------------------------------

### Output JSON (Rust) for cart.lines.discounts.generate.run

Source: https://shopify.dev/docs/api/functions/latest/discount

Example output JSON for the Rust implementation of the cart.lines.discounts.generate.run function. Shows the operations array with order and product discount candidates, using string values for percentages and the cart line ID 'gid://shopify/CartLine/2'.

```json
{
  "operations": [
    {
      "orderDiscountsAdd": {
        "candidates": [
          {
            "message": "10% OFF ORDER",
            "targets": [
              {
                "orderSubtotal": {
                  "excludedCartLineIds": []
                }
              }
            ],
            "value": {
              "percentage": {
                "value": "10.0"
              }
            }
          }
        ],
        "selectionStrategy": "FIRST"
      }
    },
    {
      "productDiscountsAdd": {
        "candidates": [
          {
            "message": "20% OFF PRODUCT",
            "targets": [
              {
                "cartLine": {
                  "id": "gid://shopify/CartLine/2"
                }
              }
            ],
            "value": {
              "percentage": {
                "value": "20.0"
              }
            }
          }
        ],
        "selectionStrategy": "FIRST"
      }
    }
  ]
}
```

--------------------------------

### Input object for bundle grouping (Rust)

Source: https://shopify.dev/docs/api/functions/latest/fulfillment-constraints

Example input object with deliverable lines and bundle attributes.

```json
{
  "cart": {
    "deliverableLines": [
      {
        "id": "gid://shopify/CartLine/1",
        "attribute": {
          "key": "bundle",
          "value": "bundle-123"
        }
      },
      {
        "id": "gid://shopify/CartLine/2",
        "attribute": {
          "key": "bundle",
          "value": "bundle-123"
        }
      },
      {
        "id": "gid://shopify/CartLine/3",
        "attribute": null
      }
    ]
  }
}
```

--------------------------------

### Rust entrypoint for cart.lines.discounts.generate.run

Source: https://shopify.dev/docs/api/functions/latest/discount

Rust entrypoint for a Shopify discount function that declares the cart_lines_discounts_generate_run module and schema. The main function logs a message and aborts, expecting the named export to be invoked.

```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_lines_discounts_generate_run;

#[typegen("schema.graphql")]
pub mod schema {
    #[query("src/cart_lines_discounts_generate_run.graphql")]
    pub mod cart_lines_discounts_generate_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```

--------------------------------

### Input Object (Rust)

Source: https://shopify.dev/docs/api/functions/latest/payment-customization

Example input object for the Rust version, showing the configuration metafield with a renameMap.

```json
{
  "paymentMethods": [
    {
      "id": "gid://shopify/PaymentCustomizationPaymentMethod/1",
      "name": "Credit Card"
    },
    {
      "id": "gid://shopify/PaymentCustomizationPaymentMethod/2",
      "name": "PayPal"
    }
  ],
  "paymentCustomization": {
    "metafield": {
      "jsonValue": {
        "renameMap": {
          "Credit Card": "Visa/MasterCard",
          "PayPal": "PayPal Express"
        }
      }
    }
  }
}
```

--------------------------------

### Rust entrypoint for Buy X get Y discount

Source: https://shopify.dev/docs/api/functions/latest/discount

Rust entrypoint for a Shopify Discount Function that declares the cart lines and delivery options discount run modules and aborts if not invoked as a named export.

```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_delivery_options_discounts_generate_run;
pub mod cart_lines_discounts_generate_run;

#[typegen("schema.graphql")]
pub mod schema {
    #[query("src/cart_lines_discounts_generate_run.graphql")]
    pub mod cart_lines_discounts_generate_run {}

    #[query("src/cart_delivery_options_discounts_generate_run.graphql")]
    pub mod cart_delivery_options_discounts_generate_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```

--------------------------------

### Output JSON for fixed-amount discount (Rust)

Source: https://shopify.dev/docs/api/functions/latest/product-discount

Example output JSON for the fixed-amount discount function, showing a discount of 10.0 applied to one cart line with the FIRST strategy.

```json
{
  "discountApplicationStrategy": "FIRST",
  "discounts": [
    {
      "message": "Discount applied",
      "targets": [
        {
          "cartLine": {
            "id": "gid://shopify/CartLine/1",
            "quantity": 1
          }
        }
      ],
      "value": {
        "fixedAmount": {
          "amount": "10.0",
          "appliesToEachItem": true
        }
      }
    }
  ]
}
```

--------------------------------

### Output JSON (Rust)

Source: https://shopify.dev/docs/api/functions/latest/cart-and-checkout-validation

Example output JSON for the Rust function. Shows a validation error with a message and target.

```json
{
  "operations": [
    {
      "validationAdd": {
        "errors": [
          {
            "message": "You can only purchase up to 5 units of this product.",
            "target": "$.cart"
          }
        ]
      }
    }
  ]
}
```

--------------------------------

### Input object (Rust)

Source: https://shopify.dev/docs/api/functions/latest/payment-customization

Example input object for the Rust function, showing a B2B buyer with a purchasing company.

```json
{
  "cart": {
    "buyerIdentity": {
      "purchasingCompany": {
        "company": {
          "id": "gid://Shopify/Company/1"
        }
      }
    }
  }
}
```

--------------------------------

### Output JSON (Rust)

Source: https://shopify.dev/docs/api/functions/latest/discount

Example output JSON for the Rust function, showing the delivery discount operation with a 100% percentage value and ALL selection strategy.

```json
{
  "operations": [
    {
      "deliveryDiscountsAdd": {
        "candidates": [
          {
            "message": "FREE DELIVERY",
            "targets": [
              {
                "deliveryGroup": {
                  "id": "gid://shopify/CartDeliveryGroup/1"
                }
              }
            ],
            "value": {
              "percentage": {
                "value": "100.0"
              }
            }
          }
        ],
        "selectionStrategy": "ALL"
      }
    }
  ]
}
```

--------------------------------

### Input Object (JavaScript)

Source: https://shopify.dev/docs/api/functions/latest/payment-customization

Example input object for the JavaScript version, showing the configuration metafield with a direct mapping.

```json
{
  "paymentMethods": [
    {
      "id": "gid://shopify/PaymentCustomizationPaymentMethod/1",
      "name": "Credit Card"
    },
    {
      "id": "gid://shopify/PaymentCustomizationPaymentMethod/2",
      "name": "PayPal"
    }
  ],
  "paymentCustomization": {
    "metafield": {
      "jsonValue": {
        "Credit Card": "Visa/MasterCard",
        "PayPal": "PayPal Express"
      }
    }
  }
}
```

--------------------------------

### Input Object (Rust) for cart.delivery-options.discounts.generate.run

Source: https://shopify.dev/docs/api/functions/latest/discount

Example input object for the cart.delivery-options.discounts.generate.run function in Rust, showing a shipping discount class and a triggering discount code.

```json
{
  "discount": {
    "discountClasses": [
      "SHIPPING"
    ],
    "metafield": null
  },
  "triggeringDiscountCode": "50%OFF",
  "cart": {
    "deliveryGroups": [
      {
        "id": "gid://shopify/CartDeliveryGroup/1"
      }
    ]
  }
}
```

--------------------------------

### Input Object (Rust)

Source: https://shopify.dev/docs/api/functions/latest/discount

Example input object for the Rust function, showing the structure with delivery groups and discount classes.

```json
{
  "cart": {
    "deliveryGroups": [
      {
        "id": "gid://shopify/CartDeliveryGroup/1"
      }
    ]
  },
  "discount": {
    "discountClasses": [
      "SHIPPING"
    ],
    "metafield": null
  }
}
```

--------------------------------

### Rust entrypoint for order discount with exclusions

Source: https://shopify.dev/docs/api/functions/latest/discount

Rust entrypoint for a Shopify Discount Function that applies a 10% order discount with exclusions. Declares modules for cart lines and delivery options discount runs, sets up typegen with custom scalar overrides for the configuration metafield, and aborts if main is invoked directly.

```rust
use shopify_function::prelude::*;
use std::process;

pub mod cart_delivery_options_discounts_generate_run;
pub mod cart_lines_discounts_generate_run;

#[typegen("schema.graphql")]
pub mod schema {
    #[query("src/cart_lines_discounts_generate_run.graphql", custom_scalar_overrides = {
        "Input.discount.metafield.jsonValue" => super::cart_lines_discounts_generate_run::Configuration
    })]
    pub mod cart_lines_discounts_generate_run {}

    #[query("src/cart_delivery_options_discounts_generate_run.graphql", custom_scalar_overrides = {
        "Input.discount.metafield.jsonValue" => super::cart_delivery_options_discounts_generate_run::Configuration
    })]
    pub mod cart_delivery_options_discounts_generate_run {}
}

fn main() {
    log!("Please invoke a named export.");
    process::abort();
}
```

--------------------------------

### Output JSON for percentage discount function

Source: https://shopify.dev/docs/api/functions/latest/product-discount

Example output JSON for the percentage discount function, showing a FIRST strategy with two discounts for specific product variants. This output is identical for both Rust and JavaScript implementations.

```json
{
  "discountApplicationStrategy": "FIRST",
  "discounts": [
    {
      "message": "15% off Small / Black!",
      "targets": [
        {
          "productVariant": {
            "id": "gid://shopify/ProductVariant/1234567890",
            "quantity": 2
          }
        }
      ],
      "value": {
        "percentage": {
          "value": "15.0"
        }
      }
    },
    {
      "message": "15% off Medium / Blue!",
      "targets": [
        {
          "productVariant": {
            "id": "gid://shopify/ProductVariant/9876543210",
            "quantity": 1
          }
        }
      ],
      "value": {
        "percentage": {
          "value": "15.0"
        }
      }
    }
  ]
}
```

--------------------------------

### Output JSON (Rust)

Source: https://shopify.dev/docs/api/functions/latest/discount

Example output JSON for the Rust function, showing the structure of the HTTP request returned by the function.

```json
{
  "request": {
    "headers": [
      {
        "name": "accept",
        "value": "application/json"
      },
      {
        "name": "Content-Type",
        "value": "application/json"
      }
    ],
    "jsonBody": {
      "enteredDiscountCodes": [
        "FREESHIP"
      ]
    },
    "method": "POST",
    "policy": {
      "readTimeoutMs": 2000
    },
    "url": "<external-server-url>/api"
  }
}
```
Tokens:
Raw