API structure has changed
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
POST /magento-stores.json
- Body
-
application/json content type Modified
-
apiPassword property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
apiPassword property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
-
- archiveReason, resourcePath, sourceLocation properties Added
-
apiPassword property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
apiPassword property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
- archiveReason, resourcePath, sourceLocation properties Added
-
apiPassword property Modified
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
POST /importers.json
- Body
-
application/json content type Modified
- eoriNumber property Added
- Response
-
200 response Modified
-
application/json content type Modified
- eoriNumber property Added
-
application/json content type Modified
POST /errors.json
- Body
-
application/json content type Modified
- problem property Added
- Response
-
200 response Modified
-
application/json content type Modified
- problem property Added
-
application/json content type Modified
POST /channels/{id}/import-connector-variant-batch.json
- Body
-
application/json content type Modified
-
packingDepth, packingHeight, packingWidth properties Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth, packingHeight, packingWidth properties Modified
- 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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
-
-
stateFormat property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
stateFormat property Modified
-
Property is now required
Breaking
-
-
stateFormat property Modified
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
POST /shipping-rate-carriers.json
- Body
-
application/json content type Modified
-
shippingRateId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
shippingRateId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
-
- dropshipProviderId property Added
-
shippingRateId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
shippingRateId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
- dropshipProviderId property Added
-
shippingRateId property Modified
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
POST /channel-variants.json
- Body
-
application/json content type Modified
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
-
- cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
-
externalId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
- cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
-
externalId property Modified
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
GET /woo-commerce-stores/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- archiveReason, suffix properties Added
-
application/json content type Modified
GET /warehouses/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- status property Added
-
application/json content type Modified
GET /variants/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
packingDepth, packingHeight, packingWidth properties Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth, packingHeight, packingWidth properties Modified
-
application/json content type Modified
GET /users/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- archiveReason, credentialCycles, throttleParity properties Added
-
application/json content type Modified
GET /transfers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- resendExternalIds, resends properties Added
-
application/json content type Modified
GET /transactions/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- purchaseId, purchaseInvoiceId properties Added
-
application/json content type Modified
GET /templates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- customDelimiter, xmlDateDormat properties Added
-
application/json content type Modified
GET /template-mappings/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
stateFormat property Modified
-
Property is now required
Breaking
-
-
stateFormat property Modified
-
application/json content type Modified
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
-
application/json content type Modified
GET /shipping-rates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- allowList, integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint properties Added
-
application/json content type Modified
GET /shipping-rate-zones/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- integrationFilteringEndpoint, serviceFilteringEndpoint, useIntegrationFilteringEndpoint, useServiceFilteringEndpoint, variantScope properties Added
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
POST /dropshipment-imports.json
- Body
-
application/json content type Modified
-
dropshipmentId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
dropshipmentId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
-
- dropshipProviderId, problem, purchaseId properties Added
-
dropshipmentId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
dropshipmentId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
- dropshipProviderId, problem, purchaseId properties Added
-
dropshipmentId property Modified
-
application/json content type Modified
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
-
application/json content type Modified
POST /dropship-providers.json
- Body
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(int32) | null
Breaking
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
POST /customers.json
- Body
-
application/json content type Modified
- token property Added
- Response
-
200 response Modified
-
application/json content type Modified
- token property Added
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
Property is no longer required
-
Type went from
string
tostring | null
-
apiPassword property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
-
- archiveReason, resourcePath, sourceLocation properties Added
-
apiPassword property Modified
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
-
application/json content type Modified
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
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
packingDepth, packingHeight, packingWidth properties Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth, packingHeight, packingWidth properties Modified
-
application/json content type Modified
PUT /variants/{id}/push-channel-inventory.json
- Body
-
application/json content type Modified
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
packingDepth, packingHeight, packingWidth properties Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth, packingHeight, packingWidth properties Modified
-
application/json content type Modified
PUT /variants/{id}/push-channel-cost-price.json
- Body
-
application/json content type Modified
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
packingDepth, packingHeight, packingWidth properties Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth, packingHeight, packingWidth properties Modified
-
application/json content type Modified
PUT /variants/{id}.json
- Body
-
application/json content type Modified
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth property Modified
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
-
application/json content type Modified
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
-
-
-
stateFormat property Modified
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
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
shippingRateId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
-
- dropshipProviderId property Added
-
shippingRateId property Modified
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
-
Property is no longer required
-
Type went from
string
tostring | null
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
-
- cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
-
externalId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
- cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
-
externalId property Modified
-
application/json content type Modified
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
-
Property is no longer required
-
Type went from
string
tostring | null
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
-
- cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
-
externalId property Modified
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
-
application/json content type Modified
POST /warehouses.json
- Body
-
application/json content type Modified
- status property Added
- Response
-
200 response Modified
-
application/json content type Modified
- status property Added
-
application/json content type Modified
POST /vendors/{id}/dropship.json
- Body
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(int32) | null
Breaking
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
-
application/json content type Modified
POST /vendors/{id}/assign-dropship-provider.json
- Body
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(int32) | null
Breaking
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
-
application/json content type Modified
POST /variants.json
- Body
-
application/json content type Modified
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingDepth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingHeight property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
packingWidth property Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth property Modified
- Response
-
200 response Modified
-
application/json content type Modified
-
packingDepth, packingHeight, packingWidth properties Modified
-
Type went from
integer(int32) | null
tonumber | null
Breaking
-
- imagesRaw, minimumGuidePrice, mpn properties Added
-
packingDepth, packingHeight, packingWidth properties Modified
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
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
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
dropshipmentId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
-
- dropshipProviderId, problem, purchaseId properties Added
-
dropshipmentId property Modified
PUT /dropship-providers/{id}.json
- Body
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(int32) | null
Breaking
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
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
-
application/json content type Modified
GET /dropshipment-imports/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
dropshipmentId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
- dropshipProviderId, problem, purchaseId properties Added
-
dropshipmentId property Modified
-
application/json content type Modified
GET /dropship-providers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
magentoStoreId property Modified
-
Type went from
string | null
tointeger(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
-
magentoStoreId property Modified
-
application/json content type Modified
GET /dropship-provider-shipping-fields/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- columnType property Added
-
application/json content type Modified
GET /dropship-provider-addresses/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- eoriNumber, shippingRateId, taxId properties Added
-
application/json content type Modified
GET /data-imports/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- queueName, statusProblem properties Added
-
application/json content type Modified
GET /data-exports/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- queueName, retries, statusProblem properties Added
-
application/json content type Modified
GET /customers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- token property Added
-
application/json content type Modified
GET /custom-field-vendors/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-variants/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-sales/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-sale-returns/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-sale-return-items/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-sale-items/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-resellers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-dropshipments/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-field-dropship-providers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- object property Added
-
application/json content type Modified
GET /custom-channels/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- cloneOrderNotifications, enabled, inventoryEndpointPrice, priceEndpointInventory, priceListEndpoint, publishingAcknowledgement, publishingEndpoint, webhookHash properties Added
-
application/json content type Modified
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
-
application/json content type Modified
GET /channel-variants/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
externalId property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
- cacheHash, costPriceRetries, costPriceRetry, externalCreatedAt, inventoryRetries, inventoryRetry, metaFieldsHash, priceListHash, priceListRetry, priceRetries, priceRetry properties Added
-
externalId property Modified
-
application/json content type Modified
GET /channel-variant-updates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- retries, retry properties Added
-
application/json content type Modified
GET /channel-variant-imports/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- costPrice, grams, inventoryPolicy, sku properties Added
-
application/json content type Modified
GET /channel-shipment-updates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- statusProblem property Added
-
application/json content type Modified
GET /channel-commission-rates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- filterType, tags properties Added
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
GET /shipping-rate-carriers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
shippingRateId property Modified
-
Property is no longer required
-
Type went from
integer(int32)
tointeger(int32) | null
-
- dropshipProviderId property Added
-
shippingRateId property Modified
-
application/json content type Modified
GET /shipping-integrations/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- refundEndpoint property Added
-
application/json content type Modified
GET /sales/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- currencyId, exchangeRate, externalChannelSiteId, iso, paymentProviderIds, saleReturnProblems properties Added
-
application/json content type Modified
GET /sale-shipping-rates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- basePrice, serviceCode, tax properties Added
-
application/json content type Modified
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
-
application/json content type Modified
GET /sale-returns/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- dropshipProviderAddressId property Added
-
application/json content type Modified
GET /sale-items/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- basePrice, displayTax, dropshipProviderAddressId, priceBase, priceDisplay, priceExtended properties Added
-
application/json content type Modified
GET /sale-invoices/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- accountingProblem property Added
-
application/json content type Modified
GET /purchases/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- internalReference, invoiceProblem, pauseProblems, returnLabelProblem, sendSource, vendorReceivedStatusReason properties Added
-
application/json content type Modified
GET /purchase-shipping-rates/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- serviceCode, targetPrice, tax properties Added
-
application/json content type Modified
GET /purchase-notifications/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- statusProblem property Added
-
application/json content type Modified
GET /purchase-items/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- dropshipProviderInventoryFeedVariantId, priceBase, priceDisplay, priceExtended properties Added
-
application/json content type Modified
GET /purchase-invoices/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- accountingProblem, invoiceShippingProblem, invoiceShippingSource, saleReturnId, saleReturnInvoiceShippingSource, saleReturnItemId, transactionId properties Added
-
application/json content type Modified
GET /errors/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- problem property Added
-
application/json content type Modified
GET /importers/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- eoriNumber property Added
-
application/json content type Modified
GET /inventory-exports/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- scheduledType property Added
-
application/json content type Modified
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
-
application/json content type Modified
GET /inventory-feed-channels/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- externalLocationId property Added
-
application/json content type Modified
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
-
application/json content type Modified
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
-
application/json content type Modified
GET /inventory-imports/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- archiveReason property Added
-
application/json content type Modified
GET /landed-cost-purchase-invoice-items/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- exchangeIso, exchangeRate properties Added
-
application/json content type Modified
GET /landed-cost-purchase-invoices/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- exchangeIso, exchangeRate properties Added
-
application/json content type Modified
GET /magento-stores/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
-
apiPassword property Modified
-
Property is no longer required
-
Type went from
string
tostring | null
-
- archiveReason, resourcePath, sourceLocation properties Added
-
apiPassword property Modified
-
application/json content type Modified
GET /payment-methods/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- showNotes property Added
-
application/json content type Modified
GET /price-lists/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- cacheImport, comparePrevious, delimiter, importSeconds properties Added
-
application/json content type Modified
GET /purchase-invoice-payments/{id}.json
- Response
-
200 response Modified
-
application/json content type Modified
- totals property Added
-
application/json content type Modified
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