Jump to Content
Home
Guides
API Reference
Changelog
v1
v2
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
API1
Home
Guides
API Reference
Changelog
ShippingPlan
Search
All
Pages
Start typing to search…
JUMP TO
Getting Started
Overview
Setting up
Authentication
API Definitions & Swagger
Authenticate API
Auth
GetApplicationProfileBySecretKey
post
AuthorizeByApplication
post
Dashboards API
Dashboards
GetLowStockLevel
get
GetPerformanceTableData
get
GetPerformanceDetail
get
GetTopProducts
get
GetInventoryLocationData
get
GetInventoryLocationCategoriesData
get
GetInventoryLocationProductsData
get
Email API
Email
GetEmailTemplates
get
GetEmailTemplate
get
GenerateAdhocEmail
post
GenerateFreeTextEmail
post
Generic Listings API
GenericListings
SaveTemplateFields
post
ProcessTemplates
post
CreateTemplates
post
OpenTemplatesByInventory
post
GetConfiguratorsInfoPaged
post
SaveConfiguratorFields
post
GetConfiguratorDescription
post
SaveConfiguratorDescription
post
GetConfiguratorData
post
SaveConfiguratorData
post
CreateConfigurator
post
DeleteConfigurators
post
Import and Export API
ImportExport
EnableImport
post
RunNowImport
post
GetImport
get
DeleteImport
post
GetFullfilmentCenterSettings
get
EnableExport
post
RunNowExport
post
GetExport
get
DeleteExport
post
GetImportList
get
GetExportList
get
Listings API
Listings
EndListingsPendingRelist
post
SetListingStrikeOffState
post
GeteBayConfigurators
get
CreateeBayConfigurators
post
GetAllEbayConfigurators
get
UpdateeBayConfigurators
post
DeleteeBayConfigurators
post
GeteBayTemplates
post
CreateEbayTemplates
post
CreateTemplatesFromViewInBulk
post
GetEbayListingOperations
get
CancelListingBulkOperation
post
ProcesseBayListings
post
DeleteEbayTemplates
post
GetBigCommerceTemplates
post
CreateBigcommerceTemplates
post
ProcessBigcommerceListings
post
GetBigcommerceConfigurators
get
CreateBigcommerceConfigurators
post
UpdateBigcommerceConfigurators
post
DeleteBigcommerceConfigurators
post
DeleteBigcommerceTemplates
post
Locations API
Locations
GetLocation
get
AddLocation
post
UpdateLocation
post
DeleteLocation
post
GetWarehouseTOTEs
post
DeleteWarehouseTOTE
post
Macros API
Macro
GetInstalledMacros
get
GetMacroConfigurations
get
Open Orders API
OpenOrders
GetViewStats
post
FilterNotProcessedOpenOrders
get
SearchOrders
post
GetOpenOrderIds
post
GetOpenOrders
post
GetIdentifiers
get
GetIdentifiersByOrderIds
post
SaveIdentifier
post
DeleteIdentifier
post
AssignOrderIdentifier
post
UnassignOrderIdentifier
post
GetOrdersLowFidelity
post
GetOpenOrdersDetails
post
AssignStockToOrders
post
DeleteAssignedStock
post
GetAvailableChannels
get
GetOrderItemIndicators
post
MarkReadyForCollection
post
Orders API
Orders
GetOrderDetailsByNumOrderId
get
GetOrdersById
post
GetOrderPackagingCalculation
post
RecalculateSingleOrderPackaging
post
SetOrderSplitPackagingManualOverwrite
post
SetOrderPackaging
post
GetOrderItemBatchsByOrderId
post
GetOrderItemBatchesByOrderIds
post
GetAllAvailableOrderItemBatchsByOrderId
post
CreateOrders
post
AddExtendedProperties
post
CreateSerialisedValuesForOrderItems
post
GetOrderItemRowSerialValuesByOrderIds
post
GetAssignedOrderItemBatches
post
AssignOrderItemBatches
post
AssignStockToOrder
post
GetUserLocationId
get
GetOpenOrders
post
GetAllOpenOrders
post
GetAllOpenOrdersBetweenIndex
post
SetLabelsPrinted
post
SetInvoicesPrinted
post
SetPickListPrinted
post
RunRulesEngine
post
GetOrderItemComposition
get
ChangeOrderTag
post
GetAvailableFolders
get
SetAvailableFolders
post
AssignToFolder
post
UnassignToFolder
post
GetOrderXmlJSTree
get
GetOrderXml
get
ChangeShippingMethod
post
ChangeStatus
post
LockOrder
post
DeleteOrder
post
CancelOrder
post
MoveToLocation
post
ClearShippingLabelInfo
post
ClearInvoicePrinted
post
ClearPickListPrinted
post
GetShippingMethods
get
GetPackagingGroups
get
GetExtendedPropertyTypes
get
GetExtendedPropertyNames
get
SetExtendedProperties
post
GetBatchPilots
get
GetOrders
post
GetOrderAuditTrailsByIds
post
GetOrdersNotes
post
GetOrderNoteTypes
get
SetOrderNotes
post
GetOrderRelations
get
GetOrdersRelations
post
AddOrdersNote
post
GetOpenOrderItemsSuppliers
get
AddOrderItem
post
AddOrderService
post
UpdateOrderItem
post
RemoveOrderItem
post
GetCountries
get
GetPaymentMethods
get
GetDefaultPaymentMethodIdForNewOrder
get
SetDefaultPaymentMethodIdForNewOrder
post
SetPaymentMethods
post
CreateNewOrder
post
GetDraftOrders
get
CompleteOrder
post
SplitOrder
post
MergeOrders
post
ProcessOrder
post
ProcessOrder_RequiredBatchScans
post
ProcessOrdersInBatch
post
ProcessFulfilmentCentreOrder
post
SetOrderGeneralInfo
post
SetOrderShippingInfo
post
SetOrderCustomerInfo
post
SetOrderTotalsInfo
post
ValidateCoupon
post
AddCoupon
post
UpdateBillingAddress
post
SetAdditionalInfo
post
UpdateAdditionalInfo
post
GetOrderViews
get
GetOrderView
get
SaveOrderView
post
CustomerLookUp
get
GetLinkedItems
get
UpdateLinkItem
post
CreateNewItemAndLink
post
GetOrderPackagingSplit
get
SetOrderPackagingSplit
post
GetOpenOrderIdByOrderOrReferenceId
post
ProcessOrderByOrderOrReferenceId
post
GetOpenOrdersByItemBarcode
post
GetOrderDetailsByReferenceId
get
Picking API
Picking
GetAllPickingWaveHeaders
get
GetMyPickingWaveHeaders
get
GetAllPickingWaves
get
GetMyPickingWaves
get
GetPickingWave
get
UpdatePickingWaveItem
post
UpdatePickingWaveHeader
post
GeneratePickingWave
post
CheckAllocatableToPickwave
post
GetPickwaveUsersWithSummary
get
DeleteOrdersFromPickingWaves
post
GetItemBinracks
get
UpdatePickingWaveItemWithNewBinrack
post
UpdatePickedItemDelta
post
Post Sale (Cancellations) API
PostSale
GetCancellationOptions
get
CreateCancellation
post
Postal Services API
PostalServices
GetPostalServices
get
CreatePostalService
post
UpdatePostalService
post
DeletePostalService
post
GetChannelLinks
get
Print Service API
PrintService
CreatePDFfromJobForceTemplateStockIn
post
CreatePDFfromJobForceTemplate
post
CreatePDFfromJobForceTemplateWithQuantities
post
PrintTemplatePreview
post
GetTemplateList
get
VP_GetPrinters
get
GetUsersForPrinterConfig
get
CreateReturnShippingLabelsPDFWithSKUs
post
CreateReturnShippingLabelsPDF
post
Processed Orders API
ProcessedOrders
RefundFreeText
post
RefundShipping
post
MarkManualRefundsAsActioned
post
RefundServices
post
ValidateCompleteOrderRefund
post
GetRefundsOptions
get
GetRefundableServiceItems
get
GetTotalRefunds
get
IsRefundValid
post
IsRefundValidationRequiredByOrderId
get
GetChannelRefundReasons
get
GetReturnsExchanges
get
GetReturnItemsInfo
get
GetReturnOrderInfo
get
GetOrderTrackingURLs
post
SearchProcessedOrders
post
SearchProcessedOrdersPaged
post
DownloadOrdersToCSV
post
AddReturnCategory
post
RenameReturnCategory
post
DeleteReturnCategory
post
GetProcessedRelatives
get
GetPackageSplit
get
GetProcessedAuditTrail
get
GetProcessedOrderExtendedProperties
get
GetReturnCategories
get
GetProcessedOrderNotes
get
AddOrderNote
post
ChangeOrderNote
post
DeleteOrderNote
post
CreateExchange
post
CreateResend
post
CreateFullResend
post
GetRefunds
get
CheckOrderFullyReturned
get
Print Zone API
PrintZone
GetAllPrintZones
get
Purchase Orders API
PurchaseOrder
Search_PurchaseOrders2
post
Search_PurchaseOrders
post
Create_PurchaseOrder_Initial
post
Update_PurchaseOrderHeader
post
Modify_PurchaseOrderItems_Bulk
post
Add_PurchaseOrderItem
post
Update_PurchaseOrderItem
post
Delete_PurchaseOrderItem
post
GetPurchaseOrdersWithStockItems
post
Get_PurchaseOrder
post
Get_PurchaseOrderNote
post
ExportPurchaseOrder
post
Add_PurchaseOrderNote
post
Delete_PurchaseOrderNote
post
Change_PurchaseOrderStatus
post
Deliver_PurchaseItemAll_ExceptBatchItems
post
Deliver_PurchaseItems_WithQuantity
post
Deliver_PurchaseItemAll
post
Deliver_PurchaseItem
post
GetPurchaseOrderStatusList
post
Delete_PurchaseOrder
post
Get_PurchaseOrderAudit
post
Get_PurchaseOrderExtendedProperty
post
Add_PurchaseOrderExtendedProperty
post
Update_PurchaseOrderExtendedProperty
post
Delete_PurchaseOrderExtendedProperty
post
Get_AdditionalCostTypes
post
Add_AdditionalCostTypes
post
Update_AdditionalCostTypes
post
Delete_AdditionalCostTypes
post
Modify_AdditionalCost
post
Get_Additional_Cost
post
Modify_AdditionalCostAllocation
post
Modify_PaymentStatement
post
Get_Payment_Statement
post
FindStockItem
post
Get_DeliveredRecords
post
Get_EmailsSent
post
Get_EmailCSVFile
post
CreatePOsFromInventory
post
Returns and Refunds API
ReturnsRefunds
GetRefundOptions
post
GetActionableRefundHeaders
post
GetProcessedOrAckedErrorRefundHeaders
post
GetRMAHeadersByOrderId
post
GetRefundHeadersByOrderId
post
GetRefundLinesByHeaderId
post
CreateRefund
post
UpdateRefund
post
AcknowledgeRefundErrors
post
AcknowledgeRMAErrors
post
ActionRefund
post
DeleteRefund
post
DeleteRMA
post
GetReturnOptions
post
GetActionableRMAHeaders
post
GetProcessedOrAckedErrorRMAHeaders
post
CreateRMABooking
post
UpdateRMABooking
post
ActionRMABooking
post
GetRefundOrders
get
GetBookedReturnsExchangeOrders
get
DeleteBookedOrder
post
ActionBookedOrder
post
DeleteBookedItem
post
RefundOrder
post
GetWarehouseLocations
get
EditBookedItemInfo
post
DeletePendingRefundItem
post
GetTotalRefunds
get
SearchReturnsRefundsPaged
get
CreateReturnsRefundsCSV
get
GetSearchTypes
get
Rules Engine API
RulesEngine
GetEvaluatorTypes
get
GetEvaluationFields
get
GetOptions
get
GetMultiOptions
post
GetKeyOptions
get
GetMultiKeyOptions
post
GetRules
get
GetRulesByType
get
GetRuleConditionNodes
get
GetConditionWeb
get
GetActionTypes
get
CreateNewCondition
post
SaveConditionChanges
post
CheckConditionNameExists
get
GetAction
get
GetActionOptions
get
UpdateAction
post
AddAction
post
DeleteAction
post
DeleteCondition
post
SwapConditions
post
GetRequiredFieldsByRuleId
get
GetRequiredFieldsByType
get
TestEvaluateRule
post
SetDraftLive
post
CreateDraftFromExisting
post
CreateNewDraftFromExisting
post
CreateNewDraft
post
SetRuleEnabled
post
SetRuleName
post
DeleteRuleById
post
SwapRules
post
SetConditionEnabled
post
CopyCondition
post
CopyAction
post
Settings API
Settings
GetCurrencyConversionRates
get
GetAvailableTimeZones
get
UpdateCurrencyConversionRates
post
InsertCurrencyConversionRates
post
DeleteCurrencyConversionRates
post
GetMeasures
get
GetLatestCurrencyRate
get
ShipStation API
ShipStation
GetShipStationIntegrations
get
GetShipStationIntegration
get
CreateShipStationIntegration
post
DeleteShipStationIntegration
post
EditShipStationIntegration
post
Stock API
Stock
CheckVariationParentSKUExists
get
GetVariationGroupSearchTypes
get
SearchVariationGroups
get
DeleteVariationGroup
get
DeleteVariationGroups
post
GetVariationGroupByParentId
get
GetVariationGroupByName
get
RenameVariationGroup
post
GetVariationItems
get
AddVariationItems
post
DeleteVariationItem
post
DeleteVariationItems
post
CreateVariationGroup
post
SKUExists
get
GetStockConsumption
get
GetItemChangesHistory
get
GetItemChangesHistoryCSV
get
GetStockItemsFull
post
GetStockItemsFullByIds
post
GetStockLevel_Batch
post
UpdateStockMinimumLevel
post
GetStockSold
get
GetStockDuePO
get
GetStockItemReturnStat
get
GetStockItemScrapStat
get
GetSoldStat
get
SetStockLevel
post
UpdateStockLevelsBySKU
post
BookInStockItem
post
CreateStockBatches
post
BookInStockBatch
post
SearchBinracks
post
GetBinRacksById
post
GetBinrackSkus
post
DeleteMove
post
GetWarehouseMovesByBinrack
post
GetWarehouseMove
post
CompleteWarehouseMove
post
UpdateWarehouseMove
post
CreateWarehouseMove
post
BatchStockLevelDelta
post
AddRollingStockTake
post
UpdateStockLevelsBulk
post
GetStockItemsByIds
post
GetStockItemTypeInfo
post
UpdateSkuGroupIdentifier
post
GetStockItemsLocation
post
Warehouse Transfer (Legacy) API
WarehouseTransfer
GetActiveTransfersForLocation
get
GetActiveTransfersAllLocations
get
CreateTransferRequestWithReturn
post
CreateTransferFromDescrepancies
post
DeleteTransfer
post
DeleteTransferProperty
post
GetTransferWithNotes
get
ChangeTransferStatus
post
AddTransferNote
post
AddTransferBinNote
post
AddItemToTransfer
post
AddItemsToTransfer
post
AddTransferProperty
post
RemoveItemFromTransfer
post
SetReferenceNumber
post
ChangeTransferFromLocation
post
ChangeTransferToLocation
post
ChangeTransferLocations
post
ChangeTransferProperty
post
GetTransferItems
get
ChangeTransferItemRequestQuantity
post
ChangeTransferItemSentQuantity
post
ChangeTransferItemReceivedQuantity
post
GetTransferNotes
get
GetTransferItemNotes
get
AddTransferItemNote
post
GetTransferAudit
get
GetTransferProperties
get
SearchTransfersAllLocations
get
GetArchivedTransfers
get
GetArchivedTransfersFiltered
get
GetArchivedTransfersBetweenDates
get
GetArchivedTransfersBetweenArchivedDates
get
SearchTransfersByLocation
get
GetListTransfers
post
GetModifiedBasic
get
GetServerTime
get
GetTransferWithItems
get
ChangeBinDetails
post
AllocateItemToBin
post
CreateNewBin
post
RemoveAllEmptyBins
post
GetTransferBinNotes
get
GetDiscrepancyItems
get
GetStockAvailability
get
IsDraftTransferChanged
get
DeleteEmptyDraftTransfer
post
CheckForDraftTransfer
get
PrintTransfer
post
Warehouse Transfer
FbaTransferCards
GetMetaData
get
Import
UploadCsv
post
ImportCsv
ImportCsv
StockItem
FindStockItem
FindWarehouseTransferStockItems
Channel
ContentUpdatePreview
Metadata
Operation
PackingGroup
PackingOption
PlacementOption
ShipmentBox
ShipmentBoxItem
ShipmentBoxTracking
ShipmentDeliveryWindowOptions
ShipmentItem
ShipmentItemBatch
ShipmentPallet
Shipments
ShippingPlan
TransferCards
Transfers
TransportationOption
WarehouseTransfer
WarehouseTransfer
WarehouseTransfer
/warehousetransfer/transfers/AddItem
/warehousetransfer/transfers/AddItemBatches
/warehousetransfer/transfers/AddItemsInBulk
/warehousetransfer/transfers/CheckForDraftTransfer
/warehousetransfer/transfers/CreateTransfer
/warehousetransfer/transfers/DeleteItems
/warehousetransfer/transfers/DeleteWarehouseTransfer
/warehousetransfer/transfers/ArchiveWarehouseTransfer
/warehousetransfer/transfers/GetListTransfers
/warehousetransfer/transfers/GetTransferCards
/warehousetransfer/transfers/GetTransferCardsByLocation
/warehousetransfer/transfers/GetTransferItemBatches/{transferId}
/warehousetransfer/transfers/GetTransferItems
/warehousetransfer/transfers/UpdateFromLocation
/warehousetransfer/transfers/UpdateItemReceivedQuantity
/warehousetransfer/transfers/UpdateItemsReceivedQuantities
/warehousetransfer/transfers/UpdateItemRequestedQuantity
/warehousetransfer/transfers/UpdateItemSentQuantity
/warehousetransfer/transfers/UpdateStatus
/warehousetransfer/transfers/UpdateToLocation
/warehousetransfer/transfers/AddItemReceivedBatches
/warehousetransfer/transfers/ReceiveSelectedTransferItemsForWMS
WMS API
Wms
GetWarehouseZoneTypes
get
UpdateWarehouseZoneType
post
AddWarehouseZoneType
post
DeleteWarehouseZoneType
post
GetWarehouseZonesByLocation
get
GetBinrackZonesByBinrackIdOrName
post
UpdateWarehouseBinrackBinrackToZone
post
GetBinrackZonesByZoneIdOrName
post
AddWarehouseZone
post
DeleteWarehouseZone
post
UpdateWarehouseZone
post
Shipping service API
ShippingService
GetIntegrations
get
PostShipmentUpload
post
GetConsignmentsByManifest
get
GetFiledManifestsByVendor
get
GetShippingQuote
get
CancelOrderShippingLabel
post
Inventory API
Inventory
CreateInventoryItemPrices
post
UpdateInventoryItemPrices
post
DeleteInventoryItemPrices
post
GetInventoryItemPriceChannelSuffixes
get
GetInventoryItemPriceTags
get
GetInventoryItemPriceRulesById
get
GetInventoryItemPriceRulesBySource
get
CreateInventoryItemPricingRules
post
DeleteInventoryItemPricingRules
post
UpdateInventoryItemPricingRules
post
GetInventoryItemDescriptions
get
CreateInventoryItemDescriptions
post
UpdateInventoryItemDescriptions
post
DeleteInventoryItemDescriptions
post
GetStockItemLabels
post
GetBatchesByStockItemId
get
GetBatchInventoryById
post
GetStockItemBatchesByLocation
post
GetBatchAudit
post
DeleteBatchInventoryInBulk
post
DeleteBatchesByStockItemId
post
UpdateBatchesWithInventory
post
CreateBatches
post
HasStockItemBatches
get
UpdateCompositeParentStockLevel
post
UpdateBatchDates
post
GetEbayCompatibilityList
get
InsertUpdateEbayCompatibilityList
post
DeleteEbayCompatibilityList
post
GetScrapCategories
get
AddScrapCategories
post
DeleteScrapCategories
post
UpdateScrapCategories
post
GetScrapHistory
post
AddScrapItem
post
ScrapBatchedItem
post
BulkScrapBatchedItems
post
GetProductIdentifiersByStockItemId
post
AddProductIdentifiers
post
UpdateProductIdentifiers
post
DeleteProductIdentifiers
post
GetProductIdentifierTypes
get
GetProductIdentifierExtendedTypes
get
GetScannableProductIdentifiersByOrderIds
post
GetProductIdentifiersBulkByStockItemId
post
ItemsHaveScannableIdentifiers
post
GetChannels
get
GetChannelsBySource
get
GetExtendedPropertyNames
get
GetAllExtendedPropertyNames
get
GetExtendedPropertyTypes
get
GetPackageGroups
get
GetPostalServices
get
AddImageToInventoryItem
post
UpdateInventoryItemField
post
UpdateInventoryItemStockField
post
UpdateInventoryItemLevels
post
UpdateInventoryItemLocationField
post
GetInventoryItemById
get
GetInventoryItem
get
GetUserSpecificViews
get
CreateUserSpecificView
post
UpdateUserSpecificView
post
DeleteUserSpecificView
post
GetPreDefinedViews
get
GetInventoryItemsCount
get
AddInventoryItem
post
AddInventoryItemBulk
post
DuplicateInventoryItem
post
ArchiveInventoryItems
post
UnarchiveInventoryItems
post
GetNewItemNumber
get
UpdateInventoryItem
post
DeleteInventoryItems
post
DeleteInventoryItemBulk
post
AdjustTemplatesInstant
post
GetInventoryItemChannelSKUs
get
BatchGetInventoryItemChannelSKUs
post
GetInventoryItemChannelSKUsWithLocation
get
UpdateInventoryItemChannelSKUsWithLocation
post
DeleteInventoryItemChannelSKUs
post
UpdateChannelMapping
post
IsInventoryItemChannelSKULinked
get
UnlinkChannelListing
post
CreateChannelMapping
post
GetInventoryItemAuditTrail
get
GetInventoryItemAuditTrailPaged
post
GetInventoryItemBatchInformation
post
GetInventoryItemBatchInformationByIds
post
HasStockItemStockLevel
post
UpdateBatchDetails
post
GetInventoryItemImages
get
GetStockItemIdsBySKU
post
GetImagesInBulk
post
SetInventoryItemImageAsMain
post
UploadImagesToInventoryItem
post
UpdateImages
post
DeleteImagesFromInventoryItem
post
DeleteInventoryItemImageBulk
post
GetCategories
get
GetInventoryBatchTypes
get
CreateCategory
post
UpdateCategory
post
DeleteCategoryById
post
GetCountryCodes
get
GetCountries
get
CreateCountries
post
UpdateCountries
post
DeleteCountries
post
CreateCountryRegions
post
UpdateCountryRegions
post
GetStockLocations
get
IsOwnedStockLocation
get
GetInventoryItemLocations
get
AddItemLocations
post
UpdateItemLocations
post
DeleteItemLocations
post
GetInventoryItemCompositions
get
GetInventoryItemsCompositionByIds
post
CreateInventoryItemCompositions
post
UpdateInventoryItemCompositions
post
DeleteInventoryItemCompositions
post
GetInventoryItemExtendedProperties
post
CreateInventoryItemExtendedProperties
post
UpdateInventoryItemExtendedProperties
post
DeleteInventoryItemExtendedProperties
post
GetInventoryItemTitles
get
CreateInventoryItemTitles
post
UpdateInventoryItemTitles
post
DeleteInventoryItemTitles
post
GetSuppliers
get
GetSupplierDetails
get
AddSupplier
post
UpdateSupplier
post
DeleteSuppliers
post
GetStockSupplierStat
get
GetStockSupplierStatsBulk
get
CreateStockSupplierStat
post
UpdateStockSupplierStat
post
DeleteStockSupplierStat
post
GetInventoryItemPrices
get
Orders
Orders
GetOrders
get
GetFulfillmentStatuses
get
UpdateFulfillmentStatuses
post
GetFulfillmentStatus
get
UpdateFulfillmentStatus
put
Picking
OrderPickwave
/picking/orderpickwave/identifiers
post
PickwaveIdentifier
/picking/pickwaveidentifier
get
/picking/pickwaveidentifier
post
/picking/pickwaveidentifier/{identifierId}
del
Powered by
ShippingPlan
Ask AI
