Skip to main content

API v1.4.0

✨ New

Catalog
Unpublish variants from storefront

Added more control over the visibility of product variants in the storefront through the API. To accomplish this, a new isPublished field has been added to the variant object.

This field behaves similarly to the same field for products to control the visibility of each variant in your storefront. When the isPublished flag is set to true, the variant will be displayed to your customers. Conversely, setting the flag to false will hide the variant from the storefront.

mutation {
productVariantUpdate(
id: "UHJvZHVjdFZhcmlhbnQ6MzU0Mg=="
input: { isPublished: false }
) {
productVariant {
name
id
description
isPublished
product {
name
id
isPublished
}
}
}
}

The parent product's published status takes precedence over all variants' published status. In other words, if a product has its isPublished flag set to false, regardless of the isPublished value of its variants, all variants will remain hidden from the storefront until the product itself is published.

Catalog
Validation logic for product and variant deletion

Added validation logic to prevent the deletion of a product or variant if it is associated with an active order, including draft, quote, or offer orders. An order is considered active when it is not in the fulfilled, delivered, or cancelled state.

Payouts
Query a single payout

Added the vendorPayout query to return information about a single vendor payout.

{
vendorPayout(id: "VmVuZG9yUGF5b3V0OjY4") {
seller {
id
companyName
}
gross
taxes
net
shipping
commission
payoutAmount
currency
status
statusMessage
orders(first: 15) {
totalCount
edges {
node {
lines {
productName
}
}
}
}
}
}
Show more ↓
Integrations
Retrieve Avalara customer tax certificate

The customerTaxCertificates query can now return the download URL for an image of a customer's Avalara tax certificate.

query {
customerTaxCertificates(
id: "VXNlcjox"
)
{
documentExists
id
filename
downloadUrl
}
}

💎 Changed

Webhooks
Order fulfilled webhook updated with seller and warehouse data

The ORDER_FULFILLED webhook payload has been updated to return information about the associated seller and warehouse.

🪲 Fixed

Catalog

Fixed an issue where editing product descriptions could lead to errors with the DescriptionHTML field when paragraphs were not wrapped in a <p> tag.

Integrations

Fixed an issue with ShipStation integrations where orders could be blocked from being created or updated in certain circumstances.

Integrations

Fixed an issue with Avalara integrations where the tax_included value sent to Avalara was not respecting the marketplace global tax treatment setting.

Integrations

Fixed an issue where the taxRate for order lines could be slightly rounded, due to supporting a numeric value with only two decimal points of precision. Now, tax rates are returned with six decimal point precision.

Was this page helpful?