JUMP TOGetting StartedOverviewSetting upAuthenticationAPI Definitions & SwaggerAuthenticate APIAuthGetApplicationProfileBySecretKeypostAuthorizeByApplicationpostDashboards APIDashboardsGetLowStockLevelgetGetPerformanceTableDatagetGetPerformanceDetailgetGetTopProductsgetGetInventoryLocationDatagetGetInventoryLocationCategoriesDatagetGetInventoryLocationProductsDatagetEmail APIEmailGetEmailTemplatesgetGetEmailTemplategetGenerateAdhocEmailpostGenerateFreeTextEmailpostGeneric Listings APIGenericListingsSaveTemplateFieldspostProcessTemplatespostCreateTemplatespostOpenTemplatesByInventorypostGetConfiguratorsInfoPagedpostSaveConfiguratorFieldspostGetConfiguratorDescriptionpostSaveConfiguratorDescriptionpostGetConfiguratorDatapostSaveConfiguratorDatapostCreateConfiguratorpostDeleteConfiguratorspostImport and Export APIImportExportEnableImportpostRunNowImportpostGetImportgetDeleteImportpostGetFullfilmentCenterSettingsgetEnableExportpostRunNowExportpostGetExportgetDeleteExportpostGetImportListgetGetExportListgetListings APIListingsEndListingsPendingRelistpostSetListingStrikeOffStatepostGeteBayConfiguratorsgetCreateeBayConfiguratorspostUpdateeBayConfiguratorspostDeleteeBayConfiguratorspostGeteBayTemplatespostCreateEbayTemplatespostCreateTemplatesFromViewInBulkpostGetEbayListingOperationsgetCancelListingBulkOperationpostProcesseBayListingspostDeleteEbayTemplatespostGetAmazonConfiguratorsgetCreateAmazonConfiguratorspostUpdateAmazonConfiguratorspostDeleteAmazonConfiguratorspostGetAmazonTemplatespostCreateAmazonTemplatespostProcessAmazonListingspostDeleteAmazonTemplatespostGetMagentoConfiguratorsgetProcessMagentoListingspostCreateMagentoConfiguratorspostUpdateMagentoConfiguratorspostDeleteMagentoConfiguratorspostGetMagentoTemplatespostCreateMagentoTemplatespostDeleteMagentoTemplatespostGetBigCommerceTemplatespostCreateBigcommerceTemplatespostProcessBigcommerceListingspostGetBigcommerceConfiguratorsgetCreateBigcommerceConfiguratorspostUpdateBigcommerceConfiguratorspostDeleteBigcommerceConfiguratorspostDeleteBigcommerceTemplatespostLocations APILocationsGetLocationgetAddLocationpostUpdateLocationpostDeleteLocationpostGetWarehouseTOTEspostDeleteWarehouseTOTEpostMacros APIMacroGetInstalledMacrosgetGetMacroConfigurationsgetOpen Orders APIOpenOrdersGetViewStatspostSearchOrderspostGetOpenOrderIdspostGetOpenOrderspostGetIdentifiersgetGetIdentifiersByOrderIdspostSaveIdentifierpostDeleteIdentifierpostAssignOrderIdentifierpostUnassignOrderIdentifierpostGetOrdersLowFidelitypostGetOpenOrdersDetailspostAssignStockToOrderspostDeleteAssignedStockpostGetAvailableChannelsgetGetOrderItemIndicatorspostMarkReadyForCollectionpostOrders APIOrdersGetOrderDetailsByNumOrderIdgetGetOrdersByIdpostGetOrderPackagingCalculationpostRecalculateSingleOrderPackagingpostSetOrderSplitPackagingManualOverwritepostSetOrderPackagingpostGetOrderItemBatchsByOrderIdpostGetOrderItemBatchesByOrderIdspostGetAllAvailableOrderItemBatchsByOrderIdpostCreateOrderspostAddExtendedPropertiespostCreateSerialisedValuesForOrderItemspostGetOrderItemRowSerialValuesByOrderIdspostGetAssignedOrderItemBatchespostAssignOrderItemBatchespostAssignStockToOrderpostGetUserLocationIdgetGetOpenOrderspostGetAllOpenOrderspostGetAllOpenOrdersBetweenIndexpostSetLabelsPrintedpostSetInvoicesPrintedpostSetPickListPrintedpostRunRulesEnginepostGetOrderItemCompositiongetChangeOrderTagpostGetAvailableFoldersgetSetAvailableFolderspostAssignToFolderpostUnassignToFolderpostGetOrderXmlJSTreegetGetOrderXmlgetChangeShippingMethodpostChangeStatuspostLockOrderpostDeleteOrderpostCancelOrderpostMoveToLocationpostClearShippingLabelInfopostClearInvoicePrintedpostClearPickListPrintedpostGetShippingMethodsgetGetPackagingGroupsgetGetExtendedPropertyTypesgetGetExtendedPropertyNamesgetSetExtendedPropertiespostGetBatchPilotsgetGetOrderspostGetOrderAuditTrailsByIdspostGetOrdersNotespostGetOrderNoteTypesgetSetOrderNotespostGetOrderRelationsgetGetOrdersRelationspostGetOpenOrderItemsSuppliersgetAddOrderItempostAddOrderServicepostUpdateOrderItempostRemoveOrderItempostGetCountriesgetGetPaymentMethodsgetGetDefaultPaymentMethodIdForNewOrdergetSetDefaultPaymentMethodIdForNewOrderpostSetPaymentMethodspostCreateNewOrderpostGetDraftOrdersgetCompleteOrderpostSplitOrderpostMergeOrderspostProcessOrderpostProcessOrder_RequiredBatchScanspostProcessOrdersInBatchpostProcessFulfilmentCentreOrderpostSetOrderGeneralInfopostSetOrderShippingInfopostSetOrderCustomerInfopostSetOrderTotalsInfopostValidateCouponpostAddCouponpostUpdateBillingAddresspostSetAdditionalInfopostUpdateAdditionalInfopostGetOrderViewsgetGetOrderViewgetSaveOrderViewpostCustomerLookUpgetGetLinkedItemsgetUpdateLinkItempostCreateNewItemAndLinkpostGetOrderPackagingSplitgetSetOrderPackagingSplitpostGetOpenOrderIdByOrderOrReferenceIdpostProcessOrderByOrderOrReferenceIdpostGetOpenOrdersByItemBarcodepostGetOrderDetailsByReferenceIdgetPicking APIPickingGetAllPickingWaveHeadersgetGetMyPickingWaveHeadersgetGetAllPickingWavesgetGetMyPickingWavesgetGetPickingWavegetUpdatePickingWaveItempostUpdatePickingWaveHeaderpostGeneratePickingWavepostCheckAllocatableToPickwavepostGetPickwaveUsersWithSummarygetDeleteOrdersFromPickingWavespostGetItemBinracksgetUpdatePickingWaveItemWithNewBinrackpostUpdatePickedItemDeltapostPost Sale (Cancellations) APIPostSaleGetCancellationOptionsgetCreateCancellationpostPostal Services APIPostalServicesGetPostalServicesgetCreatePostalServicepostUpdatePostalServicepostDeletePostalServicepostGetChannelLinksgetPrint Service APIPrintServiceCreatePDFfromJobForceTemplateStockInpostCreatePDFfromJobForceTemplatepostCreatePDFfromJobForceTemplateWithQuantitiespostPrintTemplatePreviewpostGetTemplateListgetVP_GetPrintersgetGetUsersForPrinterConfiggetCreateReturnShippingLabelsPDFWithSKUspostCreateReturnShippingLabelsPDFpostProcessed Orders APIProcessedOrdersRefundFreeTextpostRefundShippingpostMarkManualRefundsAsActionedpostRefundServicespostValidateCompleteOrderRefundpostGetRefundsOptionsgetGetRefundableServiceItemsgetGetTotalRefundsgetIsRefundValidpostIsRefundValidationRequiredByOrderIdgetGetChannelRefundReasonsgetGetReturnsExchangesgetGetReturnItemsInfogetGetReturnOrderInfogetGetOrderTrackingURLspostSearchProcessedOrderspostSearchProcessedOrdersPagedpostDownloadOrdersToCSVpostAddReturnCategorypostRenameReturnCategorypostDeleteReturnCategorypostGetProcessedRelativesgetGetPackageSplitgetGetProcessedAuditTrailgetGetProcessedOrderExtendedPropertiesgetGetReturnCategoriesgetGetProcessedOrderNotesgetAddOrderNotepostChangeOrderNotepostDeleteOrderNotepostCreateExchangepostCreateResendpostCreateFullResendpostGetRefundsgetCheckOrderFullyReturnedgetPurchase Orders APIPurchaseOrderSearch_PurchaseOrders2postSearch_PurchaseOrderspostCreate_PurchaseOrder_InitialpostUpdate_PurchaseOrderHeaderpostModify_PurchaseOrderItems_BulkpostAdd_PurchaseOrderItempostUpdate_PurchaseOrderItempostDelete_PurchaseOrderItempostGetPurchaseOrdersWithStockItemspostGet_PurchaseOrderpostGet_PurchaseOrderNotepostExportPurchaseOrderpostAdd_PurchaseOrderNotepostDelete_PurchaseOrderNotepostChange_PurchaseOrderStatuspostDeliver_PurchaseItemAll_ExceptBatchItemspostDeliver_PurchaseItems_WithQuantitypostDeliver_PurchaseItemAllpostDeliver_PurchaseItempostGetPurchaseOrderStatusListpostDelete_PurchaseOrderpostGet_PurchaseOrderAuditpostGet_PurchaseOrderExtendedPropertypostAdd_PurchaseOrderExtendedPropertypostUpdate_PurchaseOrderExtendedPropertypostDelete_PurchaseOrderExtendedPropertypostGet_AdditionalCostTypespostAdd_AdditionalCostTypespostUpdate_AdditionalCostTypespostDelete_AdditionalCostTypespostModify_AdditionalCostpostGet_Additional_CostpostModify_AdditionalCostAllocationpostModify_PaymentStatementpostGet_Payment_StatementpostFindStockItempostGet_DeliveredRecordspostGet_EmailsSentpostGet_EmailCSVFilepostCreatePOsFromInventorypostReturns and Refunds APIReturnsRefundsGetRefundOptionspostGetActionableRefundHeaderspostGetProcessedOrAckedErrorRefundHeaderspostGetRMAHeadersByOrderIdpostGetRefundHeadersByOrderIdpostGetRefundLinesByHeaderIdpostCreateRefundpostUpdateRefundpostAcknowledgeRefundErrorspostAcknowledgeRMAErrorspostActionRefundpostDeleteRefundpostDeleteRMApostGetReturnOptionspostGetActionableRMAHeaderspostGetProcessedOrAckedErrorRMAHeaderspostCreateRMABookingpostUpdateRMABookingpostActionRMABookingpostGetRefundOrdersgetGetBookedReturnsExchangeOrdersgetDeleteBookedOrderpostActionBookedOrderpostDeleteBookedItempostRefundOrderpostGetWarehouseLocationsgetEditBookedItemInfopostDeletePendingRefundItempostGetTotalRefundsgetSearchReturnsRefundsPagedgetCreateReturnsRefundsCSVgetGetSearchTypesgetRules Engine APIRulesEngineGetEvaluatorTypesgetGetEvaluationFieldsgetGetOptionsgetGetMultiOptionspostGetKeyOptionsgetGetMultiKeyOptionspostGetRulesgetGetRulesByTypegetGetRuleConditionNodesgetGetConditionWebgetGetActionTypesgetCreateNewConditionpostSaveConditionChangespostCheckConditionNameExistsgetGetActionOptionsgetUpdateActionpostAddActionpostDeleteActionpostDeleteConditionpostSwapConditionspostGetRequiredFieldsByRuleIdgetGetRequiredFieldsByTypegetTestEvaluateRulepostSetDraftLivepostCreateDraftFromExistingpostCreateNewDraftFromExistingpostCreateNewDraftpostSetRuleEnabledpostSetRuleNamepostDeleteRuleByIdpostSwapRulespostSetConditionEnabledpostCopyConditionpostCopyActionpostSettings APISettingsGetCurrencyConversionRatesgetGetAvailableTimeZonesgetUpdateCurrencyConversionRatespostInsertCurrencyConversionRatespostDeleteCurrencyConversionRatespostGetMeasuresgetGetLatestCurrencyRategetShipStation APIShipStationGetShipStationIntegrationsgetGetShipStationIntegrationgetCreateShipStationIntegrationpostDeleteShipStationIntegrationpostEditShipStationIntegrationpostStock APIStockCheckVariationParentSKUExistsgetGetVariationGroupSearchTypesgetSearchVariationGroupsgetDeleteVariationGroupgetDeleteVariationGroupspostGetVariationGroupByParentIdgetGetVariationGroupByNamegetRenameVariationGrouppostGetVariationItemsgetAddVariationItemspostDeleteVariationItempostDeleteVariationItemspostCreateVariationGrouppostSKUExistsgetGetStockConsumptiongetGetItemChangesHistorygetGetItemChangesHistoryCSVgetGetStockItemsFullpostGetStockItemsFullByIdspostGetStockLevel_BatchpostUpdateStockMinimumLevelpostGetStockSoldgetGetStockDuePOgetGetStockItemReturnStatgetGetStockItemScrapStatgetGetSoldStatgetSetStockLevelpostUpdateStockLevelsBySKUpostBookInStockItempostCreateStockBatchespostBookInStockBatchpostSearchBinrackspostGetBinRacksByIdpostGetBinrackSkuspostDeleteMovepostGetWarehouseMovesByBinrackpostGetWarehouseMovepostCompleteWarehouseMovepostUpdateWarehouseMovepostCreateWarehouseMovepostBatchStockLevelDeltapostAddRollingStockTakepostUpdateStockLevelsBulkpostGetStockItemsByIdspostGetStockItemTypeInfopostUpdateSkuGroupIdentifierpostGetStockItemsLocationpostWarehouse Transfer (Legacy) APIWarehouseTransferGetActiveTransfersForLocationgetGetActiveTransfersAllLocationsgetCreateTransferRequestWithReturnpostCreateTransferFromDescrepanciespostDeleteTransferpostDeleteTransferPropertypostGetTransferWithNotesgetChangeTransferStatuspostAddTransferNotepostAddTransferBinNotepostAddItemToTransferpostAddItemsToTransferpostAddTransferPropertypostRemoveItemFromTransferpostSetReferenceNumberpostChangeTransferFromLocationpostChangeTransferToLocationpostChangeTransferLocationspostChangeTransferPropertypostGetTransferItemsgetChangeTransferItemRequestQuantitypostChangeTransferItemSentQuantitypostChangeTransferItemReceivedQuantitypostGetTransferNotesgetGetTransferItemNotesgetAddTransferItemNotepostGetTransferAuditgetGetTransferPropertiesgetSearchTransfersAllLocationsgetGetArchivedTransfersgetGetArchivedTransfersFilteredgetGetArchivedTransfersBetweenDatesgetGetArchivedTransfersBetweenArchivedDatesgetSearchTransfersByLocationgetGetListTransferspostGetModifiedBasicgetGetServerTimegetGetTransferWithItemsgetChangeBinDetailspostAllocateItemToBinpostCreateNewBinpostRemoveAllEmptyBinspostGetTransferBinNotesgetGetDiscrepancyItemsgetGetStockAvailabilitygetIsDraftTransferChangedgetDeleteEmptyDraftTransferpostCheckForDraftTransfergetPrintTransferpostWarehouse TransferFbaShipmentGetShipmentByIdgetUpdateShipmentputUpdateInboundShipmentputApproveShipmentpostShipShipmentpostApproveAllShipmentspostVoidShipmentdeleteGetShipmentsWithItemsByShippingPlanIdgetGetShipmentsByShippingPlanIdgetUpdateShipmentNameputDeleteAmazonShipmentItemdeleteFbaShipmentBoxAddpostUpdateputGetgetDeletedeleteUpdateShipmentBoxPalletsputFbaShipmentBoxItemAddUpdateShipmentBoxItemsputDeletedeleteGetShipmentItemsWithBoxAndPalletgetFbaShipmentFeedSubmitCartonInformationFeedputGetCartonInformationFeedErrorgetFbaShipmentItemCreateShipmentItemBatchpostDeleteShipmentItemdeleteGetShipmentItemsgetGetShipmentItemsByIdsgetUpdateQuantityputUpdatePackSizeputUpdatePackQuantityputUpdateShipmentItemputUpdateShipmentItemPrepInstructionputUpdateShippingPlanPrepInstructionsByShippingPlanIdputGetPrepInstructionsByShippingPlanIdgetGetPrepInstructionsByShipmentItemIdsgetUpdateShippingItemWhoLabelPrepputUpdateAmazonShipmentItemQuantityputUpdateAmazonShipmentItemPackQuantityputFbaShipmentItemBatchAddItemBatchpostFbaShipmentPalletAddpostUpdateputGetgetDeleteShipmentPalletdeleteFbaShipmentTransportSubmitTransportContentputEstimateTransportContentputConfirmTransportRequestputGetUniquePackageLabelsgetGetBillOfLadinggetGetPalletLabelsRequestgetVoidTransportRequestputFbaShipmentTransportDetailGetTransportDetailgetUpdateTransportDetailputFbaShippingLocationGetCountriesgetGetShippingLocationContactDetailsgetUpdateShippingLocationContactputFbaShippingPlanCreateShippingPlanpostDeleteShippingPlandeleteGetShippingPlanByIdgetUpdateShippingPlanputSubmitShippingPlanputGetAmazonTopLevelDomaingetGetSellerCentralUrlgetUpdatePackingTypeputUpdateToLocationputUpdateFromLocationputFbaStockItemBatchGetBatchesByShippingPlanIdgetFbaTransferCardsGetShippingPlanCardsgetGetShipmentCardsgetGetMetaDatagetRequestShipmentCardsUpdateputArchiveClosedShipmentsputImportUploadCsvpostImportCsvpostImportCsvpostImportCsvpostStockItemFindStockItemgetFindWarehouseTransferStockItemsgetWarehouseTransfer/warehousetransfer/transfers/AddItemput/warehousetransfer/transfers/AddItemBatchespost/warehousetransfer/transfers/AddItemsInBulkpost/warehousetransfer/transfers/CheckForDraftTransferput/warehousetransfer/transfers/CreateTransferpost/warehousetransfer/transfers/DeleteItemsdelete/warehousetransfer/transfers/DeleteWarehouseTransferdelete/warehousetransfer/transfers/ArchiveWarehouseTransferput/warehousetransfer/transfers/GetListTransfersget/warehousetransfer/transfers/GetTransferCardsget/warehousetransfer/transfers/GetTransferCardsByLocationget/warehousetransfer/transfers/GetTransferItemBatches/{transferId}get/warehousetransfer/transfers/GetTransferItemsput/warehousetransfer/transfers/UpdateFromLocationput/warehousetransfer/transfers/UpdateItemReceivedQuantityput/warehousetransfer/transfers/UpdateItemRequestedQuantityput/warehousetransfer/transfers/UpdateItemSentQuantityput/warehousetransfer/transfers/UpdateStatusput/warehousetransfer/transfers/UpdateToLocationput/warehousetransfer/transfers/AddItemReceivedBatchespost/warehousetransfer/transfers/ReceiveSelectedTransferItemsForWMSpostWMS APIWmsGetWarehouseZoneTypesgetUpdateWarehouseZoneTypepostAddWarehouseZoneTypepostDeleteWarehouseZoneTypepostGetWarehouseZonesByLocationgetGetBinrackZonesByBinrackIdOrNamepostUpdateWarehouseBinrackBinrackToZonepostGetBinrackZonesByZoneIdOrNamepostAddWarehouseZonepostDeleteWarehouseZonepostUpdateWarehouseZonepostShipping service APIShippingServiceGetIntegrationsgetPostShipmentUploadpostGetConsignmentsByManifestgetGetFiledManifestsByVendorgetCancelOrderShippingLabelpostInventory APIInventoryUpdateInventoryItemPricespostDeleteInventoryItemPricespostGetInventoryItemPriceChannelSuffixesgetGetInventoryItemPriceTagsgetGetInventoryItemPriceRulesByIdgetGetInventoryItemPriceRulesBySourcegetCreateInventoryItemPricingRulespostDeleteInventoryItemPricingRulespostUpdateInventoryItemPricingRulespostGetInventoryItemDescriptionsgetCreateInventoryItemDescriptionspostUpdateInventoryItemDescriptionspostDeleteInventoryItemDescriptionspostGetStockItemLabelspostGetBatchesByStockItemIdgetGetBatchInventoryByIdpostGetStockItemBatchesByLocationpostGetBatchAuditpostDeleteBatchInventoryInBulkpostDeleteBatchesByStockItemIdpostUpdateBatchesWithInventorypostCreateBatchespostHasStockItemBatchesgetUpdateCompositeParentStockLevelpostUpdateBatchDatespostGetEbayCompatibilityListgetInsertUpdateEbayCompatibilityListpostDeleteEbayCompatibilityListpostGetScrapCategoriesgetAddScrapCategoriespostDeleteScrapCategoriespostUpdateScrapCategoriespostGetScrapHistorypostAddScrapItempostScrapBatchedItempostBulkScrapBatchedItemspostGetProductIdentifiersByStockItemIdpostAddProductIdentifierspostUpdateProductIdentifierspostDeleteProductIdentifierspostGetProductIdentifierTypesgetGetProductIdentifierExtendedTypesgetGetScannableProductIdentifiersByOrderIdspostGetProductIdentifiersBulkByStockItemIdpostGetChannelsgetGetChannelsBySourcegetGetExtendedPropertyNamesgetGetAllExtendedPropertyNamesgetGetExtendedPropertyTypesgetGetPackageGroupsgetGetPostalServicesgetAddImageToInventoryItempostUpdateInventoryItemFieldpostUpdateInventoryItemStockFieldpostUpdateInventoryItemLevelspostUpdateInventoryItemLocationFieldpostGetInventoryItemByIdgetGetUserSpecificViewsgetCreateUserSpecificViewpostUpdateUserSpecificViewpostDeleteUserSpecificViewpostGetPreDefinedViewsgetGetInventoryItemsCountgetAddInventoryItempostAddInventoryItemBulkpostDuplicateInventoryItempostArchiveInventoryItemspostUnarchiveInventoryItemspostGetNewItemNumbergetUpdateInventoryItempostDeleteInventoryItemspostDeleteInventoryItemBulkpostAdjustTemplatesInstantpostGetInventoryItemChannelSKUsgetBatchGetInventoryItemChannelSKUspostGetInventoryItemChannelSKUsWithLocationgetUpdateInventoryItemChannelSKUspostUpdateInventoryItemChannelSKUsWithLocationpostCreateInventoryItemChannelSKUspostDeleteInventoryItemChannelSKUspostIsInventoryItemChannelSKULinkedgetUnlinkChannelListingpostGetInventoryItemAuditTrailgetGetInventoryItemAuditTrailPagedpostGetInventoryItemBatchInformationpostGetInventoryItemBatchInformationByIdspostHasStockItemStockLevelpostUpdateBatchDetailspostGetInventoryItemImagesgetGetStockItemIdsBySKUpostGetImagesInBulkpostSetInventoryItemImageAsMainpostUploadImagesToInventoryItempostUpdateImagespostDeleteImagesFromInventoryItempostDeleteInventoryItemImageBulkpostGetCategoriesgetGetInventoryBatchTypesgetCreateCategorypostUpdateCategorypostDeleteCategoryByIdpostGetCountryCodesgetGetCountriesgetCreateCountriespostUpdateCountriespostDeleteCountriespostCreateCountryRegionspostUpdateCountryRegionspostGetStockLocationsgetIsOwnedStockLocationgetGetInventoryItemLocationsgetAddItemLocationspostUpdateItemLocationspostDeleteItemLocationspostGetInventoryItemCompositionsgetGetInventoryItemsCompositionByIdspostCreateInventoryItemCompositionspostUpdateInventoryItemCompositionspostDeleteInventoryItemCompositionspostGetInventoryItemExtendedPropertiespostCreateInventoryItemExtendedPropertiespostUpdateInventoryItemExtendedPropertiespostDeleteInventoryItemExtendedPropertiespostGetInventoryItemTitlesgetCreateInventoryItemTitlespostUpdateInventoryItemTitlespostDeleteInventoryItemTitlespostGetSuppliersgetGetSupplierDetailsgetAddSupplierpostUpdateSupplierpostDeleteSupplierspostGetStockSupplierStatgetGetStockSupplierStatsBulkgetCreateStockSupplierStatpostUpdateStockSupplierStatpostDeleteStockSupplierStatpostGetInventoryItemPricesgetCreateInventoryItemPricespostPowered by OverviewThe Linnworks API is an API that allows developers to build applications that interact with Linnworks data.
