Change Updates

Do not miss any Jetti API changes, ever again

Subscribe to the Jetti API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
313 structure changes including:
103 Additions
210 Modifications
Modified 210 Breaking
POST /purchases.json
  • Body
  • application/json content type Modified
    • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
POST /purchase-shipping-rates.json
  • Body
  • application/json content type Modified
    • serviceCode, targetPrice, tax properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • serviceCode, targetPrice, tax properties Added
POST /purchase-notifications.json
  • Body
  • application/json content type Modified
    • statusProblem property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statusProblem property Added
POST /purchase-items.json
  • Body
  • application/json content type Modified
    • dropshipProviderInventoryFeedVariantId, priceBase, priceDisplay, priceExtended properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderInventoryFeedVariantId, priceBase, priceDisplay, priceExtended properties Added
POST /purchase-invoices.json
  • Body
  • application/json content type Modified
    • accountingProblem, invoiceShippingProblem, invoiceShippingSource, saleReturnId, saleReturnInvoiceShippingSource, saleReturnItemId, transactionId properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accountingProblem, invoiceShippingProblem, invoiceShippingSource, saleReturnId, saleReturnInvoiceShippingSource, saleReturnItemId, transactionId properties Added
POST /purchase-invoice-payments.json
  • Body
  • application/json content type Modified
    • totals property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totals property Added
POST /price-lists.json
  • Body
  • application/json content type Modified
    • cacheImport, comparePrevious, delimiter, importSeconds properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cacheImport, comparePrevious, delimiter, importSeconds properties Added
POST /payment-methods.json
  • Body
  • application/json content type Modified
    • showNotes property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • showNotes property Added
POST /magento-stores.json
  • Body
  • application/json content type Modified
    • apiPassword property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • apiPassword property Modified
        • Full types went from string to string | null
        • Property is no longer required
    • archiveReason, resourcePath, sourceLocation properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • apiPassword property Modified
        • Full types went from string to string | null
        • Property is no longer required
      • archiveReason, resourcePath, sourceLocation properties Added
POST /landed-cost-purchase-invoices.json
  • Body
  • application/json content type Modified
    • exchangeIso, exchangeRate properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exchangeIso, exchangeRate properties Added
POST /landed-cost-purchase-invoice-items.json
  • Body
  • application/json content type Modified
    • exchangeIso, exchangeRate properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exchangeIso, exchangeRate properties Added
POST /inventory-imports.json
  • Body
  • application/json content type Modified
    • archiveReason property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason property Added
POST /inventory-feeds.json
  • Body
  • application/json content type Modified
    • archiveReason, automatedFetching, automaticallyConnectChannelVariant, automaticallyConnectOptionValues, cacheChanges, decimalNotation, diffPrevious, exportSkuThreshold, fetchCleanup, fetchFrequencyReason, forceAllInventoryUpdates, hash, hookdeckId, inlineInventoryUpdates, inventoryEndpoint, inventoryFeedMappingUrl, inventoryLocationMetafields, inventoryPolicySync, limitHandling, locationFetch, manualFetchFrequency, metaFieldTagDelimiters, negativeInventoryBuffer, persistConnections, prestashopBarcodeField, preventConnectDuplicates, priceUpliftEndpoint, priceVisibility, proxyUri, reviewApprovedEndpoint, reviewRejectedEndpoint, skuImportStrategy, skuImportStrategyOption, skuImportStrategySearch, sourceLocation, strippedTags, syncEqualCompareAtPrice, syncWeightZero, taxableOverride, useInventoryEndpoint, usePriceUpliftEndpoint, useReviewApprovedEndpoint, useReviewRejectedEndpoint, xmlMapping, xmlPath, zeroNullPrices properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, automatedFetching, automaticallyConnectChannelVariant, automaticallyConnectOptionValues, cacheChanges, decimalNotation, diffPrevious, exportSkuThreshold, fetchCleanup, fetchFrequencyReason, forceAllInventoryUpdates, hash, hookdeckId, inlineInventoryUpdates, inventoryEndpoint, inventoryFeedMappingUrl, inventoryLocationMetafields, inventoryPolicySync, limitHandling, locationFetch, manualFetchFrequency, metaFieldTagDelimiters, negativeInventoryBuffer, persistConnections, prestashopBarcodeField, preventConnectDuplicates, priceUpliftEndpoint, priceVisibility, proxyUri, reviewApprovedEndpoint, reviewRejectedEndpoint, skuImportStrategy, skuImportStrategyOption, skuImportStrategySearch, sourceLocation, strippedTags, syncEqualCompareAtPrice, syncWeightZero, taxableOverride, useInventoryEndpoint, usePriceUpliftEndpoint, useReviewApprovedEndpoint, useReviewRejectedEndpoint, xmlMapping, xmlPath, zeroNullPrices properties Added
POST /inventory-feed-variants/{id}/publish.json
  • Body
  • application/json content type Modified
    • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
POST /inventory-feed-variants.json
  • Body
  • application/json content type Modified
    • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
POST /inventory-feed-channels.json
  • Body
  • application/json content type Modified
    • externalLocationId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • externalLocationId property Added
POST /inventory-exports.json
  • Body
  • application/json content type Modified
    • scheduledType property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scheduledType property Added
POST /importers.json
  • Body
  • application/json content type Modified
    • eoriNumber property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eoriNumber property Added
POST /errors.json
  • Body
  • application/json content type Modified
    • problem property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • problem property Added
POST /channels/{id}/import-connector-variant-batch.json
  • Body
  • application/json content type Modified
    • packingDepth, packingHeight, packingWidth properties Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
    • imagesRaw, minimumGuidePrice, mpn properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
PUT /sale-returns/{id}/default-label.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Added
POST /users.json
  • Body
  • application/json content type Modified
    • archiveReason, credentialCycles, throttleParity properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, credentialCycles, throttleParity properties Added
POST /transfers.json
  • Body
  • application/json content type Modified
    • resendExternalIds, resends properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resendExternalIds, resends properties Added
POST /transactions.json
  • Body
  • application/json content type Modified
    • purchaseId, purchaseInvoiceId properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • purchaseId, purchaseInvoiceId properties Added
POST /templates.json
  • Body
  • application/json content type Modified
    • customDelimiter, xmlDateDormat properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customDelimiter, xmlDateDormat properties Added
POST /template-mappings.json
  • Body
  • application/json content type Modified
    • stateFormat property Modified
      • Property is now required
        Breaking
      • stateFormat property Modified
        • Property is now required
          Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • stateFormat property Modified
        • Property is now required
          Breaking
POST /shopify-stores.json
  • Body
  • application/json content type Modified
    • archiveReason, facebookUnpaidOrders, hookdeckId, importArchivedOrdersFulfilled, importMetaFields, locationIds, orderMetafields, orderMetafieldsKey, orderMetafieldsValue, overwriteScope, productImport, unpaidAllowList properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, facebookUnpaidOrders, hookdeckId, importArchivedOrdersFulfilled, importMetaFields, locationIds, orderMetafields, orderMetafieldsKey, orderMetafieldsValue, overwriteScope, productImport, unpaidAllowList properties Added
POST /shipping-rates.json
  • Body
  • application/json content type Modified
    • allowList, integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allowList, integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Added
POST /shipping-rate-zones.json
  • Body
  • application/json content type Modified
    • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint, variantScope properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint, variantScope properties Added
POST /shipping-rate-carriers.json
  • Body
  • application/json content type Modified
    • shippingRateId property Modified
      • Full types went from integer(int32) to integer(int32) | null
      • Property is no longer required
      • shippingRateId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
    • dropshipProviderId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shippingRateId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
      • dropshipProviderId property Added
POST /shipping-integrations.json
  • Body
  • application/json content type Modified
    • refundEndpoint property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • refundEndpoint property Added
POST /sales/{id}/post-to-channel.json
  • Body
  • application/json content type Modified
    • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
POST /sales/{id}/clone.json
  • Body
  • application/json content type Modified
    • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
POST /sales/{id}/cancel.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /sales.json
  • Body
  • application/json content type Modified
    • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
POST /sale-shipping-rates.json
  • Body
  • application/json content type Modified
    • basePrice, serviceCode, tax properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basePrice, serviceCode, tax properties Added
POST /sale-returns.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Added
POST /sale-items.json
  • Body
  • application/json content type Modified
    • basePrice, displayTax, dropshipProviderAddressId, priceBase, priceDisplay, priceExtended properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basePrice, displayTax, dropshipProviderAddressId, priceBase, priceDisplay, priceExtended properties Added
POST /sale-invoices.json
  • Body
  • application/json content type Modified
    • accountingProblem property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accountingProblem property Added
POST /purchases/{id}/ship.json
  • Body
  • application/json content type Modified
    • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
POST /channels.json
  • Body
  • application/json content type Modified
    • bundleInventorySync, cacheRates, checkDropshipAt, disableVariantInventorySync, dropshipAllowTags, enforceRefundLimits, eoriNumber, externalFulfillmentTrigger, finalizationDelay, importChannelFulfillments, inhouseBrandNames, inventorySyncTrigger, lockIso, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, optionValueTarget, orderRoutingEndpoint, publishAdditionalTags, publishThrottle, reverseSplitShipping, saleCustomFields, saleCustomFieldsScope, syncCustomerNotes, syncSingleVariantMetafields, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, useVariantImage, variantImportScope properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bundleInventorySync, cacheRates, checkDropshipAt, disableVariantInventorySync, dropshipAllowTags, enforceRefundLimits, eoriNumber, externalFulfillmentTrigger, finalizationDelay, importChannelFulfillments, inhouseBrandNames, inventorySyncTrigger, lockIso, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, optionValueTarget, orderRoutingEndpoint, publishAdditionalTags, publishThrottle, reverseSplitShipping, saleCustomFields, saleCustomFieldsScope, syncCustomerNotes, syncSingleVariantMetafields, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, useVariantImage, variantImportScope properties Added
POST /channel-variants.json
  • Body
  • application/json content type Modified
    • externalId property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • externalId property Modified
        • Full types went from string to string | null
        • Property is no longer required
    • cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • externalId property Modified
        • Full types went from string to string | null
        • Property is no longer required
      • cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
POST /channel-variant-updates.json
  • Body
  • application/json content type Modified
    • retries, retry properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • retries, retry properties Added
POST /channel-variant-imports.json
  • Body
  • application/json content type Modified
    • costPrice, grams, inventoryPolicy, sku properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • costPrice, grams, inventoryPolicy, sku properties Added
POST /channel-shipment-updates.json
  • Body
  • application/json content type Modified
    • statusProblem property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statusProblem property Added
POST /channel-commission-rates.json
  • Body
  • application/json content type Modified
    • filterType, tags properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • filterType, tags properties Added
POST /big-commerce-stores.json
  • Body
  • application/json content type Modified
    • archiveReason, authenticationType, externalChannelId, importCancelledOrders, orderPolling, singleVariantPricingUpdate, storeHash, useTotalTax properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, authenticationType, externalChannelId, importCancelledOrders, orderPolling, singleVariantPricingUpdate, storeHash, useTotalTax properties Added
GET /woo-commerce-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, suffix properties Added
GET /warehouses/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Added
GET /variants/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packingDepth, packingHeight, packingWidth properties Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
      • imagesRaw, minimumGuidePrice, mpn properties Added
GET /users/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, credentialCycles, throttleParity properties Added
GET /transfers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resendExternalIds, resends properties Added
GET /transactions/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • purchaseId, purchaseInvoiceId properties Added
GET /templates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • customDelimiter, xmlDateDormat properties Added
GET /template-mappings/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • stateFormat property Modified
        • Property is now required
          Breaking
GET /shopify-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, facebookUnpaidOrders, hookdeckId, importArchivedOrdersFulfilled, importMetaFields, locationIds, orderMetafields, orderMetafieldsKey, orderMetafieldsValue, overwriteScope, productImport, unpaidAllowList properties Added
GET /shipping-rates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allowList, integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Added
GET /shipping-rate-zones/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint, variantScope properties Added
GET /dropshipments/{id}/regenerate-label.json
  • Body
  • application/json content type Modified
    • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
POST /dropshipments.json
  • Body
  • application/json content type Modified
    • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
POST /dropshipment-imports.json
  • Body
  • application/json content type Modified
    • dropshipmentId property Modified
      • Full types went from integer(int32) to integer(int32) | null
      • Property is no longer required
      • dropshipmentId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
    • dropshipProviderId, problem, purchaseId properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipmentId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
      • dropshipProviderId, problem, purchaseId properties Added
POST /dropship-providers/{id}/settle-invoices.json
  • Body
  • application/json content type Modified
    • resendExternalIds, resends properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • resendExternalIds, resends properties Added
POST /dropship-providers.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from string | null to integer(int32) | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
    • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
      • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
POST /dropship-provider-shipping-fields.json
  • Body
  • application/json content type Modified
    • columnType property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • columnType property Added
POST /dropship-provider-addresses.json
  • Body
  • application/json content type Modified
    • eoriNumber, shippingRateId, taxId properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eoriNumber, shippingRateId, taxId properties Added
POST /data-imports.json
  • Body
  • application/json content type Modified
    • queueName, statusProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, statusProblem properties Added
POST /data-exports.json
  • Body
  • application/json content type Modified
    • queueName, retries, statusProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, retries, statusProblem properties Added
POST /customers.json
  • Body
  • application/json content type Modified
    • token property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Added
POST /custom-field-vendors.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-variants.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-sales.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-sale-returns.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-sale-return-items.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-sale-items.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-resellers.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-dropshipments.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-field-dropship-providers.json
  • Body
  • application/json content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
POST /custom-channels.json
  • Body
  • application/json content type Modified
    • cloneOrderNotifications, enabled, inventoryEndpointPrice, priceEndpointInventory, priceListEndpoint, publishingAcknowledgement, publishingEndpoint, webhookHash properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cloneOrderNotifications, enabled, inventoryEndpointPrice, priceEndpointInventory, priceListEndpoint, publishingAcknowledgement, publishingEndpoint, webhookHash properties Added
POST /channels/{id}/manual-sale.json
  • Body
  • application/json content type Modified
    • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
PUT /sale-returns/{id}.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Added
PUT /sale-items/{id}.json
  • Body
  • application/json content type Modified
    • basePrice, displayTax, dropshipProviderAddressId, priceBase, priceDisplay, priceExtended properties Added
PUT /sale-invoices/{id}.json
  • Body
  • application/json content type Modified
    • accountingProblem property Added
PUT /purchases/{id}/send.json
  • Body
  • application/json content type Modified
    • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
PUT /purchases/{id}/move-dropship-provider.json
  • Body
  • application/json content type Modified
    • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
PUT /purchases/{id}/default-label.json
  • Body
  • application/json content type Modified
    • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
PUT /purchases/{id}/cancel.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Added
PUT /purchases/{id}.json
  • Body
  • application/json content type Modified
    • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
PUT /purchase-shipping-rates/{id}.json
  • Body
  • application/json content type Modified
    • serviceCode, targetPrice, tax properties Added
PUT /purchase-notifications/{id}.json
  • Body
  • application/json content type Modified
    • statusProblem property Added
PUT /purchase-items/{id}.json
  • Body
  • application/json content type Modified
    • dropshipProviderInventoryFeedVariantId, priceBase, priceDisplay, priceExtended properties Added
PUT /purchase-invoices/{id}.json
  • Body
  • application/json content type Modified
    • accountingProblem, invoiceShippingProblem, invoiceShippingSource, saleReturnId, saleReturnInvoiceShippingSource, saleReturnItemId, transactionId properties Added
PUT /purchase-invoice-payments/{id}.json
  • Body
  • application/json content type Modified
    • totals property Added
PUT /price-lists/{id}.json
  • Body
  • application/json content type Modified
    • cacheImport, comparePrevious, delimiter, importSeconds properties Added
PUT /payment-methods/{id}.json
  • Body
  • application/json content type Modified
    • showNotes property Added
PUT /magento-stores/{id}.json
  • Body
  • application/json content type Modified
    • apiPassword property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • apiPassword property Modified
        • Full types went from string to string | null
        • Property is no longer required
    • archiveReason, resourcePath, sourceLocation properties Added
PUT /landed-cost-purchase-invoices/{id}.json
  • Body
  • application/json content type Modified
    • exchangeIso, exchangeRate properties Added
PUT /landed-cost-purchase-invoice-items/{id}.json
  • Body
  • application/json content type Modified
    • exchangeIso, exchangeRate properties Added
PUT /custom-field-sale-returns/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /woo-commerce-stores/{id}.json
  • Body
  • application/json content type Modified
    • archiveReason, suffix properties Added
PUT /warehouses/{id}/import-adjustments.json
  • Body
  • application/json content type Modified
    • queueName, statusProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, statusProblem properties Added
PUT /warehouses/{id}.json
  • Body
  • application/json content type Modified
    • status property Added
PUT /variants/{id}/set-level.json
  • Body
  • application/json content type Modified
    • packingDepth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingDepth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingHeight property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingHeight property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingWidth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingWidth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • imagesRaw, minimumGuidePrice, mpn properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packingDepth, packingHeight, packingWidth properties Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
      • imagesRaw, minimumGuidePrice, mpn properties Added
PUT /variants/{id}/push-channel-inventory.json
  • Body
  • application/json content type Modified
    • packingDepth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingDepth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingHeight property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingHeight property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingWidth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingWidth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • imagesRaw, minimumGuidePrice, mpn properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packingDepth, packingHeight, packingWidth properties Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
      • imagesRaw, minimumGuidePrice, mpn properties Added
PUT /variants/{id}/push-channel-cost-price.json
  • Body
  • application/json content type Modified
    • packingDepth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingDepth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingHeight property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingHeight property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingWidth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingWidth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • imagesRaw, minimumGuidePrice, mpn properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packingDepth, packingHeight, packingWidth properties Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
      • imagesRaw, minimumGuidePrice, mpn properties Added
PUT /variants/{id}.json
  • Body
  • application/json content type Modified
    • packingDepth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingDepth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingHeight property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingHeight property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingWidth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingWidth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • imagesRaw, minimumGuidePrice, mpn properties Added
PUT /users/{id}.json
  • Body
  • application/json content type Modified
    • archiveReason, credentialCycles, throttleParity properties Added
PUT /transfers/{id}.json
  • Body
  • application/json content type Modified
    • resendExternalIds, resends properties Added
PUT /transactions/{id}/refund.json
  • Body
  • application/json content type Modified
    • purchaseId, purchaseInvoiceId properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • purchaseId, purchaseInvoiceId properties Added
PUT /transactions/{id}.json
  • Body
  • application/json content type Modified
    • purchaseId, purchaseInvoiceId properties Added
PUT /templates/{id}.json
  • Body
  • application/json content type Modified
    • customDelimiter, xmlDateDormat properties Added
PUT /template-mappings/{id}.json
  • Body
  • application/json content type Modified
    • stateFormat property Modified
      • Property is now required
        Breaking
      • stateFormat property Modified
        • Property is now required
          Breaking
PUT /shopify-stores/{id}.json
  • Body
  • application/json content type Modified
    • archiveReason, facebookUnpaidOrders, hookdeckId, importArchivedOrdersFulfilled, importMetaFields, locationIds, orderMetafields, orderMetafieldsKey, orderMetafieldsValue, overwriteScope, productImport, unpaidAllowList properties Added
PUT /shipping-rates/{id}.json
  • Body
  • application/json content type Modified
    • allowList, integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Added
PUT /shipping-rate-zones/{id}.json
  • Body
  • application/json content type Modified
    • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint, variantScope properties Added
PUT /shipping-rate-carriers/{id}.json
  • Body
  • application/json content type Modified
    • shippingRateId property Modified
      • Full types went from integer(int32) to integer(int32) | null
      • Property is no longer required
      • shippingRateId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
    • dropshipProviderId property Added
PUT /shipping-integrations/{id}.json
  • Body
  • application/json content type Modified
    • refundEndpoint property Added
PUT /sales/{id}.json
  • Body
  • application/json content type Modified
    • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
PUT /sale-shipping-rates/{id}.json
  • Body
  • application/json content type Modified
    • basePrice, serviceCode, tax properties Added
PUT /custom-field-sale-return-items/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-field-sale-items/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-field-resellers/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-field-dropshipments/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-field-dropship-providers/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-channels/{id}.json
  • Body
  • application/json content type Modified
    • cloneOrderNotifications, enabled, inventoryEndpointPrice, priceEndpointInventory, priceListEndpoint, publishingAcknowledgement, publishingEndpoint, webhookHash properties Added
PUT /channels/{id}/acknowledge-variant.json
  • Body
  • application/json content type Modified
    • externalId property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • externalId property Modified
        • Full types went from string to string | null
        • Property is no longer required
    • cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • externalId property Modified
        • Full types went from string to string | null
        • Property is no longer required
      • cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
PUT /channels/{id}.json
  • Body
  • application/json content type Modified
    • bundleInventorySync, cacheRates, checkDropshipAt, disableVariantInventorySync, dropshipAllowTags, enforceRefundLimits, eoriNumber, externalFulfillmentTrigger, finalizationDelay, importChannelFulfillments, inhouseBrandNames, inventorySyncTrigger, lockIso, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, optionValueTarget, orderRoutingEndpoint, publishAdditionalTags, publishThrottle, reverseSplitShipping, saleCustomFields, saleCustomFieldsScope, syncCustomerNotes, syncSingleVariantMetafields, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, useVariantImage, variantImportScope properties Added
PUT /channel-variants/{id}.json
  • Body
  • application/json content type Modified
    • externalId property Modified
      • Full types went from string to string | null
      • Property is no longer required
      • externalId property Modified
        • Full types went from string to string | null
        • Property is no longer required
    • cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
PUT /channel-variant-updates/{id}.json
  • Body
  • application/json content type Modified
    • retries, retry properties Added
PUT /channel-variant-imports/{id}.json
  • Body
  • application/json content type Modified
    • costPrice, grams, inventoryPolicy, sku properties Added
PUT /channel-shipment-updates/{id}.json
  • Body
  • application/json content type Modified
    • statusProblem property Added
PUT /channel-commission-rates/{id}.json
  • Body
  • application/json content type Modified
    • filterType, tags properties Added
PUT /big-commerce-stores/{id}.json
  • Body
  • application/json content type Modified
    • archiveReason, authenticationType, externalChannelId, importCancelledOrders, orderPolling, singleVariantPricingUpdate, storeHash, useTotalTax properties Added
POST /woo-commerce-stores.json
  • Body
  • application/json content type Modified
    • archiveReason, suffix properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, suffix properties Added
POST /warehouses.json
  • Body
  • application/json content type Modified
    • status property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status property Added
POST /vendors/{id}/dropship.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from string | null to integer(int32) | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
    • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
      • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from string | null to integer(int32) | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
    • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
      • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
POST /variants.json
  • Body
  • application/json content type Modified
    • packingDepth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingDepth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingHeight property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingHeight property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • packingWidth property Modified
      • Full types went from integer(int32) | null to number | null
        Breaking
      • packingWidth property Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
    • imagesRaw, minimumGuidePrice, mpn properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • packingDepth, packingHeight, packingWidth properties Modified
        • Full types went from integer(int32) | null to number | null
          Breaking
      • imagesRaw, minimumGuidePrice, mpn properties Added
PUT /inventory-imports/{id}.json
  • Body
  • application/json content type Modified
    • archiveReason property Added
PUT /inventory-feeds/{id}/publish-all.json
  • Body
  • application/json content type Modified
    • queueName, statusProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, statusProblem properties Added
PUT /inventory-feeds/{id}.json
  • Body
  • application/json content type Modified
    • archiveReason, automatedFetching, automaticallyConnectChannelVariant, automaticallyConnectOptionValues, cacheChanges, decimalNotation, diffPrevious, exportSkuThreshold, fetchCleanup, fetchFrequencyReason, forceAllInventoryUpdates, hash, hookdeckId, inlineInventoryUpdates, inventoryEndpoint, inventoryFeedMappingUrl, inventoryLocationMetafields, inventoryPolicySync, limitHandling, locationFetch, manualFetchFrequency, metaFieldTagDelimiters, negativeInventoryBuffer, persistConnections, prestashopBarcodeField, preventConnectDuplicates, priceUpliftEndpoint, priceVisibility, proxyUri, reviewApprovedEndpoint, reviewRejectedEndpoint, skuImportStrategy, skuImportStrategyOption, skuImportStrategySearch, sourceLocation, strippedTags, syncEqualCompareAtPrice, syncWeightZero, taxableOverride, useInventoryEndpoint, usePriceUpliftEndpoint, useReviewApprovedEndpoint, useReviewRejectedEndpoint, xmlMapping, xmlPath, zeroNullPrices properties Added
PUT /inventory-feed-variants/{id}.json
  • Body
  • application/json content type Modified
    • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
PUT /inventory-feed-channels/{id}.json
  • Body
  • application/json content type Modified
    • externalLocationId property Added
PUT /inventory-exports/{id}.json
  • Body
  • application/json content type Modified
    • scheduledType property Added
PUT /importers/{id}.json
  • Body
  • application/json content type Modified
    • eoriNumber property Added
PUT /fulfillments/{id}/move-to-dropship.json
  • Body
  • application/json content type Modified
    • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
PUT /errors/{id}.json
  • Body
  • application/json content type Modified
    • problem property Added
PUT /dropshipments/{id}.json
  • Body
  • application/json content type Modified
    • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
PUT /dropshipment-imports/{id}.json
  • Body
  • application/json content type Modified
    • dropshipmentId property Modified
      • Full types went from integer(int32) to integer(int32) | null
      • Property is no longer required
      • dropshipmentId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
    • dropshipProviderId, problem, purchaseId properties Added
PUT /dropship-providers/{id}.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from string | null to integer(int32) | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
    • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
PUT /dropship-provider-shipping-fields/{id}.json
  • Body
  • application/json content type Modified
    • columnType property Added
PUT /dropship-provider-addresses/{id}.json
  • Body
  • application/json content type Modified
    • eoriNumber, shippingRateId, taxId properties Added
PUT /data-imports/{id}.json
  • Body
  • application/json content type Modified
    • queueName, statusProblem properties Added
PUT /data-exports/{id}.json
  • Body
  • application/json content type Modified
    • queueName, retries, statusProblem properties Added
PUT /customers/{id}.json
  • Body
  • application/json content type Modified
    • token property Added
PUT /custom-field-vendors/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-field-variants/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
PUT /custom-field-sales/{id}.json
  • Body
  • application/json content type Modified
    • object property Added
GET /dropshipments/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelPrintStatus, labelProblem, pickupProblem, sendShippingUpdateProblem properties Added
GET /dropshipment-imports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipmentId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
      • dropshipProviderId, problem, purchaseId properties Added
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from string | null to integer(int32) | null
          Breaking
      • applyReturnPenalty, commissionGrossTax, commissionPriceInventoryFeedId, commissionRateBase, commissionRateEndpointHash, commissionRateShipping, commissionReverseTaxIncluded, currencyId, customCarriers, dailyEmailBatches, defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, eoriNumber, generatePayloadEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, invoiceIssuer, invoiceReturnShipping, invoiceReturnShippingType, invoiceShippingSources, invoiceShippingTax, invoiceTaxSource, magentoAgreementId, monthlyPaymentDay, orderSplittingEndpoint, packagingWeight, packingSlipFromLabel, paymentScheduler, pdfEndpoint, platformDiscount, platformLocation, platformNotes, platformPriceFallback, platformPriceListId, platformStateCode, platformTaxIncluded, platformTrackingCompanyRequirement, platformTrackingRequirement, restrictionDays, restrictionDaysScope, restrictionTags, restrictionTagsScope, returnDropshipProviderAddressId, returnShipmentTrigger, returnShippingRateId, reverseShippingInvoice, sendTransferNotification, shipmentFetchFrequency, shippingEndpointImportSeconds, shippingEndpointLastFetchedAt, shippingEndpointProblem, shippingReminderAdmin, shippingTaxRateCountries, shippingTaxRateId, shippingTaxRateScope, shippingUpdateExtension, shippingUpdateExtensionDuration, shippingUpdateSchedule, shipstationPartnerKey, stripeFlow, syncCompanyTag, syncDropshipTag, syncInternalShipmentsToPlatform, syncOrderWeight, syncReferenceTag, transferTerms, updateOrderNotes, useDropshipmentSplittingEndpoint, useGeneratePayloadEndpoint, useInternalReferenceTemplate, usePdfEndpoint, vendorPortalShowInvoices properties Added
GET /dropship-provider-shipping-fields/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • columnType property Added
GET /dropship-provider-addresses/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eoriNumber, shippingRateId, taxId properties Added
GET /data-imports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, statusProblem properties Added
GET /data-exports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, retries, statusProblem properties Added
GET /customers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Added
GET /custom-field-vendors/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-variants/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-sales/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-sale-returns/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-sale-return-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-sale-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-resellers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-dropshipments/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-field-dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Added
GET /custom-channels/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cloneOrderNotifications, enabled, inventoryEndpointPrice, priceEndpointInventory, priceListEndpoint, publishingAcknowledgement, publishingEndpoint, webhookHash properties Added
GET /channels/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • bundleInventorySync, cacheRates, checkDropshipAt, disableVariantInventorySync, dropshipAllowTags, enforceRefundLimits, eoriNumber, externalFulfillmentTrigger, finalizationDelay, importChannelFulfillments, inhouseBrandNames, inventorySyncTrigger, lockIso, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, optionValueTarget, orderRoutingEndpoint, publishAdditionalTags, publishThrottle, reverseSplitShipping, saleCustomFields, saleCustomFieldsScope, syncCustomerNotes, syncSingleVariantMetafields, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, useVariantImage, variantImportScope properties Added
GET /channel-variants/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • externalId property Modified
        • Full types went from string to string | null
        • Property is no longer required
      • cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
GET /channel-variant-updates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • retries, retry properties Added
GET /channel-variant-imports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • costPrice, grams, inventoryPolicy, sku properties Added
GET /channel-shipment-updates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statusProblem property Added
GET /channel-commission-rates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • filterType, tags properties Added
GET /big-commerce-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, authenticationType, externalChannelId, importCancelledOrders, orderPolling, singleVariantPricingUpdate, storeHash, useTotalTax properties Added
DELETE /inventory-feeds/{id}/remove-by-external-id.json
  • Body
  • application/json content type Modified
    • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
GET /shipping-rate-carriers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • shippingRateId property Modified
        • Full types went from integer(int32) to integer(int32) | null
        • Property is no longer required
      • dropshipProviderId property Added
GET /shipping-integrations/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • refundEndpoint property Added
GET /sales/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
GET /sale-shipping-rates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basePrice, serviceCode, tax properties Added
GET /sale-returns/{id}/weight.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Added
GET /sale-returns/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Added
GET /sale-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • basePrice, displayTax, dropshipProviderAddressId, priceBase, priceDisplay, priceExtended properties Added
GET /sale-invoices/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accountingProblem property Added
GET /purchases/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
GET /purchase-shipping-rates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • serviceCode, targetPrice, tax properties Added
GET /purchase-notifications/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • statusProblem property Added
GET /purchase-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderInventoryFeedVariantId, priceBase, priceDisplay, priceExtended properties Added
GET /purchase-invoices/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • accountingProblem, invoiceShippingProblem, invoiceShippingSource, saleReturnId, saleReturnInvoiceShippingSource, saleReturnItemId, transactionId properties Added
GET /errors/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • problem property Added
GET /importers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • eoriNumber property Added
GET /inventory-exports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scheduledType property Added
GET /inventory-exports/{id}/export.json
  • Body
  • application/json content type Modified
    • queueName, retries, statusProblem properties Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • queueName, retries, statusProblem properties Added
GET /inventory-feed-channels/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • externalLocationId property Added
GET /inventory-feed-variants/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • allocationBufferOverride, countryOfOrigin, distanceUnit, externalUrl, hsCode, inventoryQuantityOverride, inventoryUpdatedAt, locations, manualInventoryPolicy, manualInventoryQuantity, mpn, originalCompareAtPrice, originalInventoryQuantity, originalRetailPrice, packingDepth, packingHeight, packingWidth, priceUpdatedAt, pricingOverride, pricingOverrideUplift, publishProblem, retriedPublishingAt, retriedPublishingTimes, retryPublishing, retryPublishingParams, reviewReasonId, reviewStatus, taxable properties Added
GET /inventory-feeds/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason, automatedFetching, automaticallyConnectChannelVariant, automaticallyConnectOptionValues, cacheChanges, decimalNotation, diffPrevious, exportSkuThreshold, fetchCleanup, fetchFrequencyReason, forceAllInventoryUpdates, hash, hookdeckId, inlineInventoryUpdates, inventoryEndpoint, inventoryFeedMappingUrl, inventoryLocationMetafields, inventoryPolicySync, limitHandling, locationFetch, manualFetchFrequency, metaFieldTagDelimiters, negativeInventoryBuffer, persistConnections, prestashopBarcodeField, preventConnectDuplicates, priceUpliftEndpoint, priceVisibility, proxyUri, reviewApprovedEndpoint, reviewRejectedEndpoint, skuImportStrategy, skuImportStrategyOption, skuImportStrategySearch, sourceLocation, strippedTags, syncEqualCompareAtPrice, syncWeightZero, taxableOverride, useInventoryEndpoint, usePriceUpliftEndpoint, useReviewApprovedEndpoint, useReviewRejectedEndpoint, xmlMapping, xmlPath, zeroNullPrices properties Added
GET /inventory-imports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • archiveReason property Added
GET /landed-cost-purchase-invoice-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exchangeIso, exchangeRate properties Added
GET /landed-cost-purchase-invoices/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • exchangeIso, exchangeRate properties Added
GET /magento-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • apiPassword property Modified
        • Full types went from string to string | null
        • Property is no longer required
      • archiveReason, resourcePath, sourceLocation properties Added
GET /payment-methods/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • showNotes property Added
GET /price-lists/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • cacheImport, comparePrevious, delimiter, importSeconds properties Added
GET /purchase-invoice-payments/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • totals property Added
Added 103
GET /inventory-feed-payloads/{id}.json
GET /dropship-provider-warehouses/{id}.json
GET /dropship-provider-shipment-imports/{id}.json
GET /dropship-provider-platform-actions/{id}.json
GET /dropship-provider-inventory-feed-variants/{id}.json
GET /dropship-locations/{id}.json
GET /custom-field-purchases/{id}.json
GET /custom-field-purchase-items/{id}.json
GET /custom-field-dropshipment-items/{id}.json
GET /channels/{id}/variant-levels.json
GET /channel-sites/{id}.json
GET /channel-price-lists/{id}.json
GET /channel-dropship-provider-tax-rates/{id}.json
GET /inventory-feed-variant-connections/{id}.json
GET /label-payloads/{id}.json
GET /portal-links/{id}.json
GET /price-list-imports/{id}.json
GET /price-list-variants/{id}.json
GET /review-reasons/{id}.json
GET /sale-item-commissions/{id}.json
GET /sale-item-routings/{id}.json
GET /saleor-stores/{id}.json
GET /shipping-rate-zone-variants/{id}.json
GET /variant-hs-codes/{id}.json
GET /webhook-payloads/{id}.json
PUT /channel-dropship-provider-tax-rates/{id}.json
DELETE /channel-dropship-locations/{id}.json
DELETE /channel-dropship-provider-tax-rates/{id}.json
DELETE /channel-price-lists/{id}.json
DELETE /channel-sites/{id}.json
DELETE /custom-field-dropshipment-items/{id}.json
DELETE /custom-field-purchase-items/{id}.json
DELETE /custom-field-purchases/{id}.json
DELETE /dropship-locations/{id}.json
DELETE /dropship-provider-inventory-feed-variants/{id}.json
DELETE /dropship-provider-platform-actions/{id}.json
DELETE /dropship-provider-shipment-imports/{id}.json
DELETE /dropship-provider-warehouses/{id}.json
DELETE /inventory-feed-payloads/{id}.json
DELETE /inventory-feed-variant-connections/{id}.json
DELETE /label-payloads/{id}.json
DELETE /portal-links/{id}.json
DELETE /price-list-imports/{id}.json
DELETE /price-list-variants/{id}.json
DELETE /review-reasons/{id}.json
DELETE /sale-item-commissions/{id}.json
DELETE /sale-item-routings/{id}.json
DELETE /saleor-stores/{id}.json
DELETE /shipping-rate-zone-variants/{id}.json
DELETE /variant-hs-codes/{id}.json
DELETE /webhook-payloads/{id}.json
GET /channel-dropship-locations/{id}.json
PUT /channel-price-lists/{id}.json
PUT /channel-sites/{id}.json
PUT /channels/{id}/variant-set-level.json
PUT /custom-field-dropshipment-items/{id}.json
PUT /custom-field-purchase-items/{id}.json
PUT /custom-field-purchases/{id}.json
PUT /dropship-locations/{id}.json
PUT /dropship-provider-inventory-feed-variants/{id}.json
PUT /dropship-provider-platform-actions/{id}.json
PUT /dropship-provider-shipment-imports/{id}.json
PUT /dropship-provider-warehouses/{id}.json
PUT /inventory-feed-payloads/{id}.json
PUT /inventory-feed-variant-connections/{id}.json
PUT /label-payloads/{id}.json
PUT /portal-links/{id}.json
PUT /price-list-imports/{id}.json
PUT /price-list-variants/{id}.json
PUT /review-reasons/{id}.json
PUT /sale-item-commissions/{id}.json
PUT /sale-item-routings/{id}.json
PUT /saleor-stores/{id}.json
PUT /shipping-rate-zone-variants/{id}.json
PUT /variant-hs-codes/{id}.json
PUT /warehouses/{id}/import-location-csv.json
PUT /webhook-payloads/{id}.json
POST /channel-dropship-locations.json
POST /channel-dropship-provider-tax-rates.json
POST /channel-price-lists.json
POST /channel-sites.json
POST /custom-field-dropshipment-items.json
POST /custom-field-purchase-items.json
POST /custom-field-purchases.json
POST /dropship-locations.json
POST /dropship-provider-inventory-feed-variants.json
POST /dropship-provider-platform-actions.json
POST /dropship-provider-shipment-imports.json
POST /dropship-provider-warehouses.json
POST /inventory-feed-payloads.json
POST /inventory-feed-variant-connections.json
POST /label-payloads.json
POST /portal-links.json
POST /price-list-imports.json
POST /price-list-variants.json
POST /review-reasons.json
POST /sale-item-commissions.json
POST /sale-item-routings.json
POST /saleor-stores.json
POST /shipping-rate-zone-variants.json
POST /variant-hs-codes.json
POST /webhook-payloads.json
PUT /channel-dropship-locations/{id}.json
139 structure changes including:
35 Breaking changes
104 Modifications
35 Removals
Modified 104 Breaking
DELETE /inventory-feeds/{id}/remove-by-external-id.json
  • Body
  • application/json content type Modified
    • taxable property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxable property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /big-commerce-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • authenticationType, storeHash properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /channel-commission-rates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • filterType, tags properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /channels/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • disableVariantInventorySync, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, orderRoutingEndpoint, publishAdditionalTags, saleCustomFields, saleCustomFieldsScope, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, variantImportScope properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-channels/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • publishingEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-dropshipments/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-resellers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-sale-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-sale-return-items/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-sale-returns/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-sales/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-scopes/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-variants/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /custom-field-vendors/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /dropship-provider-shipping-fields/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • columnType property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
      • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /dropshipments/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelProblem property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /dropshipments/{id}/regenerate-label.json
  • Body
  • application/json content type Modified
    • labelProblem property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelProblem property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /inventory-exports/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scheduledType property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /inventory-feed-variants/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxable property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /inventory-feeds/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • decimalNotation, fetchCleanup, inventoryPolicySync, manualFetchFequency, strippedTags, syncWeightZero, taxableOverride, xmlMapping, xmlPath, zeroNullPrices properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /payment-methods/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • showNotes property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /purchases/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /sale-returns/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /sale-returns/{id}/weight.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /shipping-integrations/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • refundEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /shipping-rate-zones/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /shipping-rates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /shopify-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • orderMetafields, orderMetafieldsKey, orderMetafieldsValue properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /templates/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • xmlDateDormat property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /users/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • credentialCycles property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
GET /woo-commerce-stores/{id}.json
  • Response
  • 200 response Modified
    • application/json content type Modified
      • suffix property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /big-commerce-stores.json
  • Body
  • application/json content type Modified
    • authenticationType, storeHash properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • authenticationType, storeHash properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /channel-commission-rates.json
  • Body
  • application/json content type Modified
    • filterType, tags properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • filterType, tags properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /channels.json
  • Body
  • application/json content type Modified
    • disableVariantInventorySync, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, orderRoutingEndpoint, publishAdditionalTags, saleCustomFields, saleCustomFieldsScope, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, variantImportScope properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • disableVariantInventorySync, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, orderRoutingEndpoint, publishAdditionalTags, saleCustomFields, saleCustomFieldsScope, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, variantImportScope properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-channels.json
  • Body
  • application/json content type Modified
    • publishingEndpoint property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • publishingEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-dropship-providers.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-dropshipments.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-resellers.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-sale-items.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-sale-return-items.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-sale-returns.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-sales.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-scopes.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-variants.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /custom-field-vendors.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • object property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /dropship-provider-shipping-fields.json
  • Body
  • application/json content type Modified
    • columnType property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • columnType property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /dropship-providers.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from integer(int32) | null to string | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
      • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /dropshipments.json
  • Body
  • application/json content type Modified
    • labelProblem property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelProblem property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /inventory-exports.json
  • Body
  • application/json content type Modified
    • scheduledType property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • scheduledType property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /inventory-feed-variants.json
  • Body
  • application/json content type Modified
    • taxable property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxable property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /inventory-feed-variants/{id}/publish.json
  • Body
  • application/json content type Modified
    • taxable property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • taxable property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /inventory-feeds.json
  • Body
  • application/json content type Modified
    • decimalNotation, fetchCleanup, inventoryPolicySync, manualFetchFequency, strippedTags, syncWeightZero, taxableOverride, xmlMapping, xmlPath, zeroNullPrices properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • decimalNotation, fetchCleanup, inventoryPolicySync, manualFetchFequency, strippedTags, syncWeightZero, taxableOverride, xmlMapping, xmlPath, zeroNullPrices properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /payment-methods.json
  • Body
  • application/json content type Modified
    • showNotes property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • showNotes property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /purchases.json
  • Body
  • application/json content type Modified
    • internalReference property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /purchases/{id}/ship.json
  • Body
  • application/json content type Modified
    • labelProblem property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelProblem property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /sale-returns.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /sales/{id}/cancel.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
POST /shipping-integrations.json
  • Body
  • application/json content type Modified
    • refundEndpoint property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • refundEndpoint property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /shipping-rate-zones.json
  • Body
  • application/json content type Modified
    • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /shipping-rates.json
  • Body
  • application/json content type Modified
    • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /shopify-stores.json
  • Body
  • application/json content type Modified
    • orderMetafields, orderMetafieldsKey, orderMetafieldsValue properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • orderMetafields, orderMetafieldsKey, orderMetafieldsValue properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /templates.json
  • Body
  • application/json content type Modified
    • xmlDateDormat property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • xmlDateDormat property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /users.json
  • Body
  • application/json content type Modified
    • credentialCycles property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • credentialCycles property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from integer(int32) | null to string | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
      • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /vendors/{id}/dropship.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from integer(int32) | null to string | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
      • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /woo-commerce-stores.json
  • Body
  • application/json content type Modified
    • suffix property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • suffix property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /big-commerce-stores/{id}.json
  • Body
  • application/json content type Modified
    • authenticationType, storeHash properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /channel-commission-rates/{id}.json
  • Body
  • application/json content type Modified
    • filterType, tags properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /channels/{id}.json
  • Body
  • application/json content type Modified
    • disableVariantInventorySync, maximumExpectedShipping, maximumExpectedShippingDuration, negativeStock, negativeStockLevel, orderRoutingEndpoint, publishAdditionalTags, saleCustomFields, saleCustomFieldsScope, syncWeightZero, taxRateId, unallocatedDropship, useOrderRoutingEndpoint, variantImportScope properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-channels/{id}.json
  • Body
  • application/json content type Modified
    • publishingEndpoint property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-dropship-providers/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-dropshipments/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-resellers/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-sale-items/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-sale-return-items/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-sale-returns/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-sales/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-scopes/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-variants/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /custom-field-vendors/{id}.json
  • Body
  • application/json content type Modified
    • object property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /dropship-provider-shipping-fields/{id}.json
  • Body
  • application/json content type Modified
    • columnType property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /dropship-providers/{id}.json
  • Body
  • application/json content type Modified
    • magentoStoreId property Modified
      • Full types went from integer(int32) | null to string | null
        Breaking
      • magentoStoreId property Modified
        • Full types went from integer(int32) | null to string | null
          Breaking
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, dropshipmentSplittingEndpoint, internalReferenceTemplate, internalReferenceTemplateDateFormat, orderSplittingEndpoint, packagingWeight, platformStateCode, platformTrackingRequirement, returnDropshipProviderAddressId, returnShipmentTrigger, shippingUpdateExtension, shippingUpdateExtensionDuration, useDropshipmentSplittingEndpoint, useInternalReferenceTemplate properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /dropshipments/{id}.json
  • Body
  • application/json content type Modified
    • labelProblem property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /fulfillments/{id}/move-to-dropship.json
  • Body
  • application/json content type Modified
    • internalReference property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /inventory-exports/{id}.json
  • Body
  • application/json content type Modified
    • scheduledType property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /inventory-feed-variants/{id}.json
  • Body
  • application/json content type Modified
    • taxable property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /inventory-feeds/{id}.json
  • Body
  • application/json content type Modified
    • decimalNotation, fetchCleanup, inventoryPolicySync, manualFetchFequency, strippedTags, syncWeightZero, taxableOverride, xmlMapping, xmlPath, zeroNullPrices properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /payment-methods/{id}.json
  • Body
  • application/json content type Modified
    • showNotes property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /purchases/{id}.json
  • Body
  • application/json content type Modified
    • internalReference property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /purchases/{id}/cancel.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /purchases/{id}/default-label.json
  • Body
  • application/json content type Modified
    • labelProblem property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • labelProblem property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /purchases/{id}/move-dropship-provider.json
  • Body
  • application/json content type Modified
    • internalReference property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /purchases/{id}/send.json
  • Body
  • application/json content type Modified
    • internalReference property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • internalReference property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /sale-returns/{id}.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /sale-returns/{id}/default-label.json
  • Body
  • application/json content type Modified
    • dropshipProviderAddressId property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • dropshipProviderAddressId property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PUT /shipping-integrations/{id}.json
  • Body
  • application/json content type Modified
    • refundEndpoint property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /shipping-rate-zones/{id}.json
  • Body
  • application/json content type Modified
    • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /shipping-rates/{id}.json
  • Body
  • application/json content type Modified
    • integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /shopify-stores/{id}.json
  • Body
  • application/json content type Modified
    • orderMetafields, orderMetafieldsKey, orderMetafieldsValue properties Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /templates/{id}.json
  • Body
  • application/json content type Modified
    • xmlDateDormat property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /users/{id}.json
  • Body
  • application/json content type Modified
    • credentialCycles property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
PUT /woo-commerce-stores/{id}.json
  • Body
  • application/json content type Modified
    • suffix property Removed
      • Removing a resource is always breaking unless it was deprecated before
        Breaking
Removed 35 Breaking
DELETE /custom-field-dropshipment-items/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /custom-field-purchase-items/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /custom-field-purchases/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /inventory-feed-variant-connections/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /label-payloads/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /sale-item-routings/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /saleor-stores/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
DELETE /webhook-payloads/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /channels/{id}/variant-levels.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /custom-field-dropshipment-items/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /custom-field-purchase-items/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /custom-field-purchases/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /inventory-feed-variant-connections/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /label-payloads/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /sale-item-routings/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /saleor-stores/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
GET /webhook-payloads/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /custom-field-dropshipment-items.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /custom-field-purchase-items.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /custom-field-purchases.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /inventory-feed-variant-connections.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /label-payloads.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /sale-item-routings.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /saleor-stores.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
POST /webhook-payloads.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /channels/{id}/variant-set-level.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /custom-field-dropshipment-items/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /custom-field-purchase-items/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /custom-field-purchases/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /inventory-feed-variant-connections/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /label-payloads/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /sale-item-routings/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /saleor-stores/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /warehouses/{id}/import-location-csv.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
PUT /webhook-payloads/{id}.json
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
4 structure changes including:
4 Additions
Added 4
DELETE /inventory-feed-variant-connections/{id}.json
GET /inventory-feed-variant-connections/{id}.json
POST /inventory-feed-variant-connections.json
PUT /inventory-feed-variant-connections/{id}.json
5 structure changes including:
5 Modifications
Modified 5
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
POST /dropship-providers.json
  • Body
  • content type Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
  • Response
  • 200 response Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • content type Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
  • Response
  • 200 response Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
POST /vendors/{id}/dropship.json
  • Body
  • content type Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
  • Response
  • 200 response Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
PUT /dropship-providers/{id}.json
  • Body
  • content type Modified
    • dropshipmentSplittingEndpoint, useDropshipmentSplittingEndpoint properties Added
39 structure changes including:
39 Modifications
Modified 39
GET /custom-field-dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-dropshipment-items/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-dropshipments/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-purchase-items/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-purchases/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-resellers/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-sale-items/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-sale-return-items/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-sale-returns/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-sales/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-scopes/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-variants/{id}.json
  • Response
  • 200 response Modified
    • object property Added
GET /custom-field-vendors/{id}.json
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-dropship-providers.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-dropshipment-items.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-dropshipments.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-purchase-items.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-purchases.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-resellers.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-sale-items.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-sale-return-items.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-sale-returns.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-sales.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-scopes.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-variants.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
POST /custom-field-vendors.json
  • Body
  • content type Modified
    • object property Added
  • Response
  • 200 response Modified
    • object property Added
PUT /custom-field-dropship-providers/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-dropshipment-items/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-dropshipments/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-purchase-items/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-purchases/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-resellers/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-sale-items/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-sale-return-items/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-sale-returns/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-sales/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-scopes/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-variants/{id}.json
  • Body
  • content type Modified
    • object property Added
PUT /custom-field-vendors/{id}.json
  • Body
  • content type Modified
    • object property Added
3 structure changes including:
3 Modifications
Modified 3
GET /webhook-payloads/{id}.json
  • Response
  • 200 response Modified
    • trigger property Added
POST /webhook-payloads.json
  • Body
  • content type Modified
    • trigger property Added
  • Response
  • 200 response Modified
    • trigger property Added
PUT /webhook-payloads/{id}.json
  • Body
  • content type Modified
    • trigger property Added
4 structure changes including:
4 Additions
Added 4
DELETE /webhook-payloads/{id}.json
GET /webhook-payloads/{id}.json
POST /webhook-payloads.json
PUT /webhook-payloads/{id}.json
5 structure changes including:
5 Modifications
Modified 5
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
POST /dropship-providers.json
  • Body
  • content type Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
  • Response
  • 200 response Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • content type Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
  • Response
  • 200 response Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
POST /vendors/{id}/dropship.json
  • Body
  • content type Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
  • Response
  • 200 response Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
PUT /dropship-providers/{id}.json
  • Body
  • content type Modified
    • defaultAddress, defaultReturnAddress, dropshipProviderAddressId, returnDropshipProviderAddressId properties Added
4 structure changes including:
4 Additions
Added 4
DELETE /custom-field-purchase-items/{id}.json
GET /custom-field-purchase-items/{id}.json
POST /custom-field-purchase-items.json
PUT /custom-field-purchase-items/{id}.json
5 structure changes including:
5 Modifications
Modified 5
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • packagingWeight property Added
POST /dropship-providers.json
  • Body
  • content type Modified
    • packagingWeight property Added
  • Response
  • 200 response Modified
    • packagingWeight property Added
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • content type Modified
    • packagingWeight property Added
  • Response
  • 200 response Modified
    • packagingWeight property Added
POST /vendors/{id}/dropship.json
  • Body
  • content type Modified
    • packagingWeight property Added
  • Response
  • 200 response Modified
    • packagingWeight property Added
PUT /dropship-providers/{id}.json
  • Body
  • content type Modified
    • packagingWeight property Added
3 structure changes including:
3 Modifications
Modified 3 Breaking
GET /custom-field-dropshipment-items/{id}.json
  • Response
  • 200 response Modified
    • customFieldDropshipmentItemId property Removed
POST /custom-field-dropshipment-items.json
  • Body
  • content type Modified
    • customFieldDropshipmentItemId property Removed
  • Response
  • 200 response Modified
    • customFieldDropshipmentItemId property Removed
PUT /custom-field-dropshipment-items/{id}.json
  • Body
  • content type Modified
    • customFieldDropshipmentItemId property Removed
4 structure changes including:
4 Additions
Added 4
DELETE /custom-field-dropshipment-items/{id}.json
GET /custom-field-dropshipment-items/{id}.json
POST /custom-field-dropshipment-items.json
PUT /custom-field-dropshipment-items/{id}.json
5 structure changes including:
5 Modifications
Modified 5
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
POST /dropship-providers.json
  • Body
  • content type Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
  • Response
  • 200 response Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • content type Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
  • Response
  • 200 response Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
POST /vendors/{id}/dropship.json
  • Body
  • content type Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
  • Response
  • 200 response Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
PUT /dropship-providers/{id}.json
  • Body
  • content type Modified
    • platformStateCode, shippingUpdateExtension, shippingUpdateExtensionDuration properties Added
3 structure changes including:
3 Modifications
Modified 3
GET /payment-methods/{id}.json
  • Response
  • 200 response Modified
    • showNotes property Added
POST /payment-methods.json
  • Body
  • content type Modified
    • showNotes property Added
  • Response
  • 200 response Modified
    • showNotes property Added
PUT /payment-methods/{id}.json
  • Body
  • content type Modified
    • showNotes property Added
5 structure changes including:
5 Modifications
Modified 5
GET /dropship-providers/{id}.json
  • Response
  • 200 response Modified
    • orderSplittingEndpoint property Added
POST /dropship-providers.json
  • Body
  • content type Modified
    • orderSplittingEndpoint property Added
  • Response
  • 200 response Modified
    • orderSplittingEndpoint property Added
POST /vendors/{id}/assign-dropship-provider.json
  • Body
  • content type Modified
    • orderSplittingEndpoint property Added
  • Response
  • 200 response Modified
    • orderSplittingEndpoint property Added
POST /vendors/{id}/dropship.json
  • Body
  • content type Modified
    • orderSplittingEndpoint property Added
  • Response
  • 200 response Modified
    • orderSplittingEndpoint property Added
PUT /dropship-providers/{id}.json
  • Body
  • content type Modified
    • orderSplittingEndpoint property Added
8 structure changes including:
8 Modifications
Modified 8
DELETE /inventory-feeds/{id}/remove-by-external-id.json
  • Body
  • content type Modified
    • taxable property Added
  • Response
  • 200 response Modified
    • taxable property Added
GET /inventory-feed-variants/{id}.json
  • Response
  • 200 response Modified
    • taxable property Added
GET /inventory-feeds/{id}.json
  • Response
  • 200 response Modified
    • taxableOverride property Added
POST /inventory-feed-variants.json
  • Body
  • content type Modified
    • taxable property Added
  • Response
  • 200 response Modified
    • taxable property Added
POST /inventory-feed-variants/{id}/publish.json
  • Body
  • content type Modified
    • taxable property Added
  • Response
  • 200 response Modified
    • taxable property Added
POST /inventory-feeds.json
  • Body
  • content type Modified
    • taxableOverride property Added
  • Response
  • 200 response Modified
    • taxableOverride property Added
PUT /inventory-feed-variants/{id}.json
  • Body
  • content type Modified
    • taxable property Added
PUT /inventory-feeds/{id}.json
  • Body
  • content type Modified
    • taxableOverride property Added
3 structure changes including:
3 Modifications
Modified 3
GET /inventory-feeds/{id}.json
  • Response
  • 200 response Modified
    • zeroNullPrices property Added
POST /inventory-feeds.json
  • Body
  • content type Modified
    • zeroNullPrices property Added
  • Response
  • 200 response Modified
    • zeroNullPrices property Added
PUT /inventory-feeds/{id}.json
  • Body
  • content type Modified
    • zeroNullPrices property Added
3 structure changes including:
3 Modifications
Modified 3
GET /channels/{id}.json
  • Response
  • 200 response Modified
    • taxRateId property Added
POST /channels.json
  • Body
  • content type Modified
    • taxRateId property Added
  • Response
  • 200 response Modified
    • taxRateId property Added
PUT /channels/{id}.json
  • Body
  • content type Modified
    • taxRateId property Added
4 structure changes including:
4 Additions
Added 4
DELETE /sale-item-routings/{id}.json
GET /sale-item-routings/{id}.json
POST /sale-item-routings.json
PUT /sale-item-routings/{id}.json
7 structure changes including:
7 Modifications
Modified 7
GET /sale-returns/{id}.json
  • Response
  • 200 response Modified
    • dropshipProviderAddressId property Added
GET /sale-returns/{id}/weight.json
  • Body
  • content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • dropshipProviderAddressId property Added
POST /sale-returns.json
  • Body
  • content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • dropshipProviderAddressId property Added
POST /sales/{id}/cancel.json
  • Body
  • content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • dropshipProviderAddressId property Added
PUT /purchases/{id}/cancel.json
  • Body
  • content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • dropshipProviderAddressId property Added
PUT /sale-returns/{id}.json
  • Body
  • content type Modified
    • dropshipProviderAddressId property Added
PUT /sale-returns/{id}/default-label.json
  • Body
  • content type Modified
    • dropshipProviderAddressId property Added
  • Response
  • 200 response Modified
    • dropshipProviderAddressId property Added