API changes — 2026-10-31
This release includes 120 additions, 3 changes. 2 breaking changes — action required.
Breaking changes — action required
This release removes endpoints or tightens request requirements. Review the Breaking changes section below before upgrading your integration.
📖 Full endpoint details are in the API reference.
⚠️ Breaking changes
Incompatible changes
Reference Data (Read-Only)
- Changed
GET /api/v2/return-reasons— List Return Reasons- removed parameter(s):
archived,limit,page,search,sort
- removed parameter(s):
Sales Credits
- Changed
GET /api/v2/sales-credits— List Sales Credits- new parameter(s):
per_page - removed parameter(s):
archived,excluded[],included[],limit,search,sort
- new parameter(s):
Added
Amazon Business Pricing
GET /api/v2/products/{product}/amazon-business-usages— List Product Amazon Business Quantity Break UsagesGET /api/v2/sales-channels/{integrationInstance}/prices/business— Get Amazon Business PricingPATCH /api/v2/sales-channels/{integrationInstance}/prices/business/marketplaces/{countryCode}— Update Amazon Business Marketplace OwnerGET /api/v2/sales-channels/{integrationInstance}/prices/business/offers— List Amazon Business OffersDELETE /api/v2/sales-channels/{integrationInstance}/prices/business/overrides— Clear Amazon Business OverridesGET /api/v2/sales-channels/{integrationInstance}/prices/business/overrides— List Amazon Business Overrides
Customers
GET /api/customers/{customer}/tax-exemption-certificates— List Customer Tax Exemption CertificatesPOST /api/customers/{customer}/tax-exemption-certificates— Create Customer Tax Exemption CertificateGET /api/tax-exemption-certificates— List Tax Exemption CertificatesPOST /api/tax-exemption-certificates/export— Export Tax Exemption CertificatesGET /api/tax-exemption-certificates/export/download— Download Tax Exemption Certificates ExportPOST /api/tax-exemption-certificates/request-renewal— Bulk Request Tax Exemption Certificate RenewalsGET /api/tax-exemption-certificates/summary— Get Tax Exemption Certificate SummaryGET /api/tax-exemption-certificates/{certificate}— Get Tax Exemption CertificateGET /api/tax-exemption-certificates/{certificate}/activity— Get Tax Exemption Certificate ActivityPOST /api/tax-exemption-certificates/{certificate}/approve— Approve Tax Exemption CertificateGET /api/tax-exemption-certificates/{certificate}/document— Download Tax Exemption Certificate DocumentPOST /api/tax-exemption-certificates/{certificate}/document— Replace Tax Exemption Certificate DocumentPOST /api/tax-exemption-certificates/{certificate}/reject— Reject Tax Exemption CertificatePOST /api/tax-exemption-certificates/{certificate}/renew— Renew Tax Exemption CertificatePOST /api/tax-exemption-certificates/{certificate}/revoke— Revoke Tax Exemption Certificate
Inventory Intelligence
GET /api/cash-buying/headroom— Get Weekly HeadroomGET /api/cash-buying/position— Get Cash PositionPOST /api/cash-buying/position— Enter Cash PositionPOST /api/cash-buying/position/read— Read Accounting Book BalancePOST /api/cash-buying/position/{snapshot}/confirm— Confirm Cash PositionPOST /api/cash-buying/rank— Rank Forecast BuildsGET /api/cash-buying/reserve-periods— List Reserve PeriodsPOST /api/cash-buying/reserve-periods— Create Reserve PeriodDELETE /api/cash-buying/reserve-periods/{reservePeriod}— Delete Reserve PeriodGET /api/cash-buying/settings— Get Cash Buying SettingsGET /api/forecast-runs/{run}/cash-plan— Get Forecast Run Cash PlanPOST /api/forecast-runs/{run}/cash-plan/recut— Recut Forecast Run Cash PlanPATCH /api/forecast-runs/{run}/lines/{line}/cash-pin— Pin Forecast Run LinePOST /api/inventory-forecasting/otb-guardrail— Apply Open-to-Buy Across Supplier BuildsGET /api/v2/cash-flow/month— Get Cash Flow MonthGET /api/v2/cash-flow/projection— Get Cash Flow Projection
Merchandise Planning
GET /api/open-to-buy/merchandise-plans/plan-vs-actual— List Plan vs Actual For A PeriodGET /api/open-to-buy/merchandise-plans/{merchandisePlan}/overrides— List Guardrail OverridesPOST /api/open-to-buy/merchandise-plans/{merchandisePlan}/overrides— Create Guardrail OverrideDELETE /api/open-to-buy/merchandise-plans/{merchandisePlan}/overrides/{override}— Delete Guardrail OverrideGET /api/open-to-buy/merchandise-plans/{merchandisePlan}/plan-vs-actual— Get Plan vs Actual
POS / Register
GET /api/pos/register-sessions/{registerSession}/customers/{customer}/tax-exemption— Get Customer Tax Exemption at Register
Price Sync
GET /api/v2/sales-channels/{integrationInstance}/prices/runs/{run}/feeds— List Price Push Run Feeds
Products
GET /api/products/{product}/videos— List Product VideosPOST /api/products/{product}/videos/uploads— Start Product Video UploadDELETE /api/products/{product}/videos/{video}— Delete Product VideoPATCH /api/products/{product}/videos/{video}— Update Product VideoPOST /api/products/{product}/videos/{video}/complete— Complete Product Video UploadPOST /api/products/{product}/videos/{video}/optimize— Optimize Product Video for TikTokGET /api/v2/products/{product}/variant-stock-grid— Get Variant Stock GridGET /api/videos/{video}— Get VideoGET /api/videos/{video}/upload-urls— Get Video Upload URLs
Purchase Orders
POST /api/purchase-orders/from-document/upload— Upload Order DocumentDELETE /api/purchase-orders/from-document/{id}— Delete Order DocumentGET /api/purchase-orders/from-document/{id}— Get Order DocumentPOST /api/purchase-orders/from-document/{id}/create-purchase-order— Create Draft PO from Order DocumentGET /api/purchase-orders/from-document/{id}/file— Download Original Order DocumentPOST /api/purchase-orders/from-document/{id}/rematch— Re-match Order Document LinesDELETE /api/purchase-orders/{purchaseOrder}/financial-lines/{financialLine}/settle-billing— Clear PO Cost Line Not Billed MarkPOST /api/purchase-orders/{purchaseOrder}/financial-lines/{financialLine}/settle-billing— Mark PO Cost Line Not BilledGET /api/purchase-orders/{purchase_order}/stale-lines— Get PO Stale LinesPOST /api/purchasing/quick-reorder— Create Quick Reorder Purchase OrdersPOST /api/purchasing/quick-reorder/preview— Preview Quick Reorder
Reporting
GET /api/reports/size-sales— Get Sales by Size ReportGET /api/reports/size-sales/export— Export Sales by Size ReportGET /api/sourcing/sales-by-channel— Get Sales by Channel
Returns & RMAs
POST /api/return-receipts/quick-damage-capture— Capture Damaged UnitGET /api/return-receipts/quick-damage-capture/vendor-claim-defaults— Get Vendor Claim Defaults
Sales Orders
POST /api/sales-orders/{salesOrder}/channel-shipping-labels/retry— Retry Sales Channel Shipping Label PurchasePOST /api/sales-orders/{salesOrder}/channel-shipping-labels/{label}/skip— Send Without Sales Channel Shipping LabelPOST /api/sales-orders/{salesOrder}/channel-shipping-labels/{label}/void— Void Sales Channel Shipping Label
Size Profiles
GET /api/merchandising/size-profiles— List Size ProfilesPOST /api/merchandising/size-profiles— Create Size ProfilePOST /api/merchandising/size-profiles/derive— Derive Size Profile From Sales HistoryDELETE /api/merchandising/size-profiles/{sizeProfile}— Delete Size ProfileGET /api/merchandising/size-profiles/{sizeProfile}— Get Size Profile
TikTok Posting
GET /api/products/{product}/tiktok-posts— List Product TikTok PostsGET /api/tiktok-posting/accounts— List TikTok Accounts by StoreDELETE /api/tiktok-posting/accounts/oauth/confirm-replace— Cancel TikTok Account ReplacementPOST /api/tiktok-posting/accounts/oauth/confirm-replace— Confirm TikTok Account ReplacementPOST /api/tiktok-posting/accounts/oauth/init— Start TikTok Account ConnectionDELETE /api/tiktok-posting/accounts/{tikTokAccount}— Disconnect TikTok AccountGET /api/tiktok-posting/accounts/{tikTokAccount}— Get TikTok AccountGET /api/tiktok-posting/accounts/{tikTokAccount}/creator-info— Get TikTok Creator InfoPOST /api/tiktok-posting/caption-suggestions— Suggest TikTok CaptionGET /api/tiktok-posting/insights— Get TikTok InsightsGET /api/tiktok-posting/posts— List TikTok PostsPOST /api/tiktok-posting/posts— Create TikTok PostGET /api/tiktok-posting/posts/{tikTokPost}— Get TikTok PostPATCH /api/tiktok-posting/posts/{tikTokPost}— Update TikTok PostPOST /api/tiktok-posting/posts/{tikTokPost}/approve— Approve TikTok PostPOST /api/tiktok-posting/posts/{tikTokPost}/cancel— Cancel TikTok PostPOST /api/tiktok-posting/posts/{tikTokPost}/duplicate— Duplicate TikTok PostGET /api/tiktok-posting/posts/{tikTokPost}/metrics— Get TikTok Post MetricsGET /api/tiktok-posting/settings— Get TikTok Posting SettingsDELETE /api/tiktok-posting/shop-creator/connections/{tikTokShopCreatorConnection}— Disconnect TikTok Shop Official AccountGET /api/tiktok-posting/shop-creator/stores/{store}— Get Store Shoppable Video StatusGET /api/tiktok-posting/shop-creator/stores/{store}/products— Search TikTok Shop Products for Shoppable Videos
Walmart
GET /api/walmart/{integrationInstance}/sww-label-settings— Get 3PL Order Label Settings
…plus 20 more (see the API reference).
Changed
Suppliers
GET /api/v2/suppliers— List Suppliers- new parameter(s):
page,per_page
- new parameter(s):
Spec version 1.0.0 → 1.0.0.