The Firmhouse Logo [FH]
Developer Docs

createOrderedProductV2

Creates an ordered product on subscription identified via `X-Subscription-Token` or `X-Project-Access-Token`.

Arguments

ArgumentDescription
input (CreateOrderedProductV2Input!)
Parameters for CreateOrderedProductV2

CreateOrderedProductV2Input Arguments

ArgumentDescription
metadata (JSON)
Metadata that can be used by developers to store additional information on objects.
id (ID)
ID of this ordered product. This will be ignored on create action.
productId (ID)
ID for the related product
quantity (Int)
The quantity for this ordered product.
customPriceCents (Int)
A custom price in cents for this ordered product, if left blank the default product price will be used
shipmentDate (ISO8601Date)
The next date on which a new order should get initiated
interval (Int)
The amount of time in units between shipments of this order
intervalUnitOfMeasureType (OrderedProductIntervalUnitOfMeasure)
The time measure for interval units
ensureNewRecord (Boolean)
subscriptionId (ID)
ID of the subscription to create this OrderedProduct for. Required if authenticated via a project access token
sku (String)
Use this field to look up the associated product based on SKU.
slug (String)
Use this field to look up the associated product based on slug.
shopifyVariantId (ID)
Use this field to look up the associated product based on Shopify Variant ID.

Return Fields

errors ([String!]!)
orderedProduct (OrderedProduct)
subscription (Subscription)