API reference

Inventory API

Operations, parameters, and response codes generated from the current OpenAPI contract.

OpenAPI 1.0 · refreshed at most every 10 minutes · Download specification

Inventory

PUT /v1/inventory #

Responses

200 OK

Schemas: ItemLedgerModel

POST /v1/inventory/availability/assessments #

Responses

200 OK

Schemas: InventoryAvailabilityAssessmentRequestModel

POST /v1/inventory/availability/shortages #

Responses

200 OK

Schemas: InventoryShortageNotificationModel

GET /v1/inventory/average-balances #

Parameters

Name	In	Type	Required	Details	Description
`months`	query	`integer`	No	format: int32 default: 12

Responses

200 OK

POST /v1/inventory/balances/by-item-ids #

Responses

200 OK

GET /v1/inventory/campaigns #

Responses

200 OK

POST /v1/inventory/campaigns #

Responses

200 OK

Schemas: InventoryCampaignModel

GET /v1/inventory/createtestdata #

Responses

200 OK

GET /v1/inventory/demand/analyzer #

Parameters

Name	In	Type	Required	Details	Description
`daysLookback`	query	`integer`	No	format: int32 default: 30

Responses

200 OK

GET /v1/inventory/demand/createsampledata #

Parameters

Name	In	Type	Required	Details	Description
`daysLookback`	query	`integer`	No	format: int32 default: 30

Responses

200 OK

GET /v1/inventory/export #

Responses

200 OK

GET /v1/inventory/export/ledger #

Responses

200 OK

POST /v1/inventory/import #

Parameters

Name	In	Type	Required	Details	Description
`dryRun`	query	`boolean`	No	default: false

Responses

200 OK

GET /v1/inventory/import/results #

Responses

200 OK

GET /v1/inventory/import/results/{importId} #

Parameters

Name	In	Type	Required	Details	Description
`importId`	path	`string`	Yes

Responses

200 OK

GET /v1/inventory/import/results/history #

Parameters

Name	In	Type	Required	Details	Description
`limit`	query	`integer`	No	format: int32 default: 25

Responses

200 OK

GET /v1/inventory/items/{itemId} #

Parameters

Name	In	Type	Required	Details	Description
`itemId`	path	`string`	Yes

Responses

200 OK

PUT /v1/inventory/move #

Responses

200 OK

Schemas: InventoryTransferModel

GET /v1/inventory/orders #

Responses

200 OK

POST /v1/inventory/orders #

Responses

200 OK

Schemas: InventoryOrderModel

GET /v1/inventory/orders/{orderId} #

Parameters

Name	In	Type	Required	Details	Description
`orderId`	path	`string`	Yes

Responses

200 OK

POST /v1/inventory/orders/{orderId}/transition #

Parameters

Name	In	Type	Required	Details	Description
`orderId`	path	`string`	Yes

Responses

200 OK

Schemas: InventoryOrderTransitionRequest

GET /v1/inventory/orders/statemachines/status #

Responses

200 OK

GET /v1/inventory/owner-exceptions #

Responses

200 OK

POST /v1/inventory/owner-exceptions #

Responses

200 OK

Schemas: InventoryOwnerExceptionModel

GET /v1/inventory/ownership #

Responses

200 OK

GET /v1/inventory/ownership-coverage #

Responses

200 OK

PUT /v1/inventory/ownership-coverage/{ownerUserId} #

Parameters

Name	In	Type	Required	Details	Description
`ownerUserId`	path	`string`	Yes

Responses

200 OK

Schemas: InventoryOwnershipCoverageModel

GET /v1/inventory/ownership-rules #

Responses

200 OK

POST /v1/inventory/ownership-rules #

Responses

200 OK

Schemas: InventoryOwnershipRuleModel

PUT /v1/inventory/ownership/{itemId} #

Parameters

Name	In	Type	Required	Details	Description
`itemId`	path	`string`	Yes

Responses

200 OK

Schemas: InventoryItemOwnershipModel

PUT /v1/inventory/receive #

Responses

200 OK

Schemas: InventoryReceiveModel

GET /v1/inventory/reconciliation/balance-drift #

Responses

200 OK

POST /v1/inventory/reviews #

Responses

200 OK

Schemas: InventoryReviewRecordModel

GET /v1/inventory/reviews/{reviewMonth} #

Parameters

Name	In	Type	Required	Details	Description
`reviewMonth`	path	`string`	Yes

Responses

200 OK

GET /v1/inventory/status #

Responses

200 OK

GET /v1/inventory/status/all #

Responses

200 OK

GET /v1/inventory/status/count #

Responses

200 OK

GET /v1/inventory/status/locations/{locationId} #

Parameters

Name	In	Type	Required	Details	Description
`locationId`	path	`string`	Yes

Responses

200 OK

GET /v1/inventory/status/pages/{page} #

Parameters

Name	In	Type	Required	Details	Description
`page`	path	`integer`	Yes	format: int32 default: 1

Responses

200 OK

InventoryLocations

GET /v1/inventory/locations #

Responses

200 OK

POST /v1/inventory/locations #

Responses

200 OK

Schemas: InventoryLocationsSlicerModel

PUT /v1/inventory/locations #

Responses

200 OK

Schemas: InventoryLocationModel

DELETE /v1/inventory/locations/{locationId} #

Parameters

Name	In	Type	Required	Details	Description
`locationId`	path	`string`	Yes

Responses

200 OK

GET /v1/inventory/locations/{locationId} #

Parameters

Name	In	Type	Required	Details	Description
`locationId`	path	`string`	Yes

Responses

200 OK

PATCH /v1/inventory/locations/{locationId} #

Parameters

Name	In	Type	Required	Details	Description
`locationId`	path	`string`	Yes

Responses

200 OK

Schemas: InventoryLocationModel

PATCH /v1/inventory/locations/{locationId}/deactivate #

Parameters

Name	In	Type	Required	Details	Description
`locationId`	path	`string`	Yes

Responses

200 OK

PATCH /v1/inventory/locations/{locationId}/notes #

Parameters

Name	In	Type	Required	Details	Description
`locationId`	path	`string`	Yes

Responses

200 OK

Schemas: InventoryLocationModel

GET /v1/inventory/locations/export #

Responses

200 OK

POST /v1/inventory/locations/import #

Parameters

Name	In	Type	Required	Details	Description
`dryRun`	query	`boolean`	No	default: false

Responses

200 OK

InventoryMode

GET /v1/settings #

Responses

200 OK

PUT /v1/settings #

Responses

200 OK

Schemas: InventorySettingsModel

TenantProvisioning

POST /v1/provisioning/tenants #

Responses

200 OK application/json

{
  "tenantID": "example_001",
  "status": "example"
}

Schemas: TenantProvisioningRequest TenantProvisioningResponse

WarehouseMoves

GET /v1/warehouse/moves #

Parameters

Name	In	Type	Required	Details	Description
`status`	query	`string`	No	default: PENDING

Responses

200 OK

PATCH /v1/warehouse/moves #

Responses

200 OK

Schemas: MaterialMovementModel

PUT /v1/warehouse/moves #

Responses

200 OK

Schemas: MaterialMovementModel

DELETE /v1/warehouse/moves/{moveId} #

Parameters

Name	In	Type	Required	Details	Description
`moveId`	path	`string`	Yes

Responses

200 OK

GET /v1/warehouse/moves/{moveId} #

Parameters

Name	In	Type	Required	Details	Description
`moveId`	path	`string`	Yes

Responses

200 OK

Schemas

EmailContactModelobject

Property	Type	Required	Details	Description
`name`	`string`	No	nullable
`emailAddress`	`string`	No	nullable

FeatureModelobject

Property	Type	Required	Details
`featureID`	`string`	No	nullable
`appID`	`string`	No	nullable
`enabled`	`boolean`	No
`canEdit`	`boolean`	No
`notes`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`createdByUserID`	`string`	No	nullable
`lastUpdateddUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable

GbbCatalogEntryModelobject

Property	Type	Required	Details
`entryID`	`string`	No	nullable
`code`	`string`	No	nullable
`displayName`	`string`	No	nullable
`description`	`string`	No	nullable
`displayOrder`	`integer`	No	format: int32
`isActive`	`boolean`	No

GbbCatalogModelobject

Property	Type	Required	Details	Description
`benefits`	`array of GbbCatalogEntryModel`	No	nullable
`fences`	`array of GbbCatalogEntryModel`	No	nullable

GeoCoordinatesModelobject

Property	Type	Required	Details	Description
`latitude`	`number`	No	format: double
`longitude`	`number`	No	format: double

HistoryModelobject

Property	Type	Required	Details
`historyID`	`string`	No	nullable
`activity`	`string`	No	nullable
`byUserID`	`string`	No	nullable
`dateTimeUTC`	`string`	No	format: date-time

InstanceModelobject

Property	Type	Required	Details
`instanceID`	`string`	No	nullable
`organizationID`	`string`	No	nullable
`companyName`	`string`	No	nullable
`name`	`string`	No	nullable
`website`	`string`	No	nullable
`allowedCountries`	`string`	No	nullable
`currencyID`	`string`	No	nullable
`currencyIDs`	`array of string`	No	nullable
`unitsWeight`	`string`	No	nullable
`unitsLength`	`string`	No	nullable
`offsetUTC`	`number`	No	format: double
`timeZoneID`	`string`	No	nullable
`defaultMarkup`	`number`	No	format: double
`gbbCatalog`	`GbbCatalogModel`	No
`schedulingAlgorithm`	`SchedulingAlgorithmModel`	No
`address`	`string`	No	nullable
`city`	`string`	No	nullable
`state`	`string`	No	nullable
`postalCode`	`string`	No	nullable
`country`	`string`	No	nullable
`phone`	`string`	No	nullable
`culture`	`string`	No	nullable
`defaultPaymentTerms`	`string`	No	nullable
`tenantType`	`string`	No	nullable
`instanceType`	`string`	No	nullable
`storeRequireLogin`	`string`	No	nullable
`subscriptionExpiresUTC`	`string`	No	format: date-time
`featureSalesFunnel`	`string`	No	nullable
`features`	`object`	No	nullable
`featureConfigurator`	`string`	No	nullable
`featureBuilder`	`string`	No	nullable
`featureSalesQuotes`	`string`	No	nullable
`featureSalesOrders`	`string`	No	nullable
`featureBids`	`string`	No	nullable
`featureProduction`	`string`	No	nullable
`featureService`	`string`	No	nullable
`featureStore`	`string`	No	nullable
`featureMaintenance`	`string`	No	nullable
`featureShipping`	`string`	No	nullable
`featurePromotions`	`string`	No	nullable
`featureDelivery`	`string`	No	nullable
`featureSuppliers`	`string`	No	nullable
`featureInvoicing`	`string`	No	nullable
`featurePurchasing`	`string`	No	nullable
`featureWarehouse`	`string`	No	nullable
`featureQuality`	`string`	No	nullable
`featureHelp`	`string`	No	nullable
`featureCompany`	`string`	No	nullable
`emailCc`	`array of EmailContactModel`	No	nullable
`incoterm`	`OrganizationIncotermModel`	No
`integrationJustPlanIt`	`IntegrationJustPlanItModel`	No
`integrationQuickBooks`	`IntegrationQuickBooksModel`	No
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`updatedTUTC`	`string`	No	format: date-time

IntegrationJustPlanItModelobject

Property	Type	Required	Details
`customerID`	`string`	No	nullable
`apikey`	`string`	No	nullable
`statusesToSend`	`array of integer`	No	nullable
`weeksDataToSend`	`integer`	No	format: int32
`isActive`	`string`	No	nullable

IntegrationQuickBooksModelobject

Property	Type	Required	Details
`clientID`	`string`	No	nullable
`clientSecret`	`string`	No	nullable
`isActive`	`string`	No	nullable

InventoryAvailabilityAssessmentRequestModelobject

Property	Type	Required	Details
`requestID`	`string`	No	nullable
`requestedAtUTC`	`string`	No	format: date-time
`requirements`	`array of InventoryAvailabilityRequirementModel`	No	nullable

Used by: POST /v1/inventory/availability/assessments

InventoryAvailabilityRequirementModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`itemNumber`	`string`	No	nullable
`quantity`	`number`	No	format: double
`uom`	`string`	No	nullable

InventoryCampaignModelobject

Property	Type	Required	Details
`campaignID`	`string`	No	nullable
`name`	`string`	No	nullable
`scope`	`string`	No	nullable
`baselineValue`	`number`	No	format: double
`targetValue`	`number`	No	format: double
`sponsorUserID`	`string`	No	nullable
`dueUTC`	`string`	No	format: date-time
`milestones`	`array of string`	No	nullable
`status`	`string`	No	nullable

Used by: POST /v1/inventory/campaigns

InventoryItemOwnershipModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`partNumber`	`string`	No	nullable
`ownerUserID`	`string`	No	nullable
`assignedByUserID`	`string`	No	nullable
`assignedUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory/ownership/{itemId}

InventoryLocationModelobject

Property	Type	Required	Details
`locationID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`groupName`	`string`	No	nullable
`isActive`	`string`	No	nullable
`coordinates`	`GeoCoordinatesModel`	No
`notes`	`array of NoteModel`	No	nullable
`history`	`array of HistoryModel`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/inventory/locations/{locationId} PATCH /v1/inventory/locations/{locationId}/notes PUT /v1/inventory/locations

InventoryLocationsSlicerModelobject

Property	Type	Required	Details
`isActive`	`string`	No	nullable
`group`	`string`	No	nullable
`sortBy`	`string`	No	nullable
`sortOrder`	`string`	No	nullable

Used by: POST /v1/inventory/locations

InventoryOrderLineModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`partNumber`	`string`	No	nullable
`quantityOrdered`	`number`	No	format: double
`quantityReceived`	`number`	No	format: double

InventoryOrderModelobject

Property	Type	Required	Details
`inventoryOrderID`	`string`	No	nullable
`number`	`string`	No	nullable
`state`	`string`	No	nullable
`supplierID`	`string`	No	nullable
`expectedReceiptUTC`	`string`	No	format: date-time nullable
`processID`	`string`	No	nullable
`lines`	`array of InventoryOrderLineModel`	No	nullable
`version`	`integer`	No	format: int32
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/inventory/orders

InventoryOrderTransitionRequestobject

Property	Type	Required	Details
`transition`	`string`	No	nullable
`processID`	`string`	No	nullable
`expectedVersion`	`integer`	No	format: int32

Used by: POST /v1/inventory/orders/{orderId}/transition

InventoryOwnerExceptionModelobject

Property	Type	Required	Details
`exceptionKey`	`string`	No	nullable
`exceptionType`	`string`	No	nullable
`itemID`	`string`	No	nullable
`partNumber`	`string`	No	nullable
`ownerUserID`	`string`	No	nullable
`details`	`string`	No	nullable
`status`	`string`	No	nullable
`firstDetectedUTC`	`string`	No	format: date-time
`lastDetectedUTC`	`string`	No	format: date-time

Used by: POST /v1/inventory/owner-exceptions

InventoryOwnershipCoverageModelobject

Property	Type	Required	Details
`ownerUserID`	`string`	No	nullable
`delegateUserID`	`string`	No	nullable
`absentFromUTC`	`string`	No	format: date-time nullable
`absentThroughUTC`	`string`	No	format: date-time nullable
`escalationUserID`	`string`	No	nullable
`escalateAfterDays`	`integer`	No	format: int32
`updatedByUserID`	`string`	No	nullable
`updatedUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory/ownership-coverage/{ownerUserId}

InventoryOwnershipRuleModelobject

Property	Type	Required	Details
`ruleID`	`string`	No	nullable
`scopeType`	`string`	No	nullable
`scopeValue`	`string`	No	nullable
`ownerUserID`	`string`	No	nullable
`priority`	`integer`	No	format: int32
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: POST /v1/inventory/ownership-rules

InventoryReceiveModelobject

Property	Type	Required	Details
`inventoryReceiveID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`quantity`	`number`	No	format: double
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory/receive

InventoryReviewRecordModelobject

Property	Type	Required	Details
`reviewRecordID`	`string`	No	nullable
`reviewMonth`	`string`	No	nullable
`itemID`	`string`	No	nullable
`partNumber`	`string`	No	nullable
`assignedToUserID`	`string`	No	nullable
`status`	`string`	No	nullable
`recommendedSafetyStock`	`integer`	No	format: int32
`reason`	`string`	No	nullable
`actionType`	`string`	No	nullable
`expectedCashRelease`	`number`	No	format: double
`serviceRisk`	`string`	No	nullable
`approverUserID`	`string`	No	nullable
`erpReference`	`string`	No	nullable
`actualResult`	`string`	No	nullable
`campaignID`	`string`	No	nullable
`actionBaselineQuantity`	`number`	No	format: double
`baselineCapturedUTC`	`string`	No	format: date-time nullable
`outcomeVerifiedUTC`	`string`	No	format: date-time nullable
`verificationSource`	`string`	No	nullable
`reviewedByUserID`	`string`	No	nullable
`reviewedUTC`	`string`	No	format: date-time nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: POST /v1/inventory/reviews

InventorySettingsModelobject

Property	Type	Required	Details
`mode`	`string`	No	nullable
`sourceSystem`	`string`	No	nullable
`sourceDocumentID`	`string`	No	nullable
`dataAsOfUTC`	`string`	No	format: date-time nullable
`lastSynchronizedUTC`	`string`	No	format: date-time nullable
`synchronizationHealth`	`string`	No	nullable

Used by: PUT /v1/settings

InventoryShortageItemModelobject

Property	Type	Required	Details
`itemID`	`string`	No	nullable
`itemNumber`	`string`	No	nullable
`description`	`string`	No	nullable
`uom`	`string`	No	nullable
`requiredQuantity`	`number`	No	format: double
`onHandQuantity`	`number`	No	format: double
`availableQuantity`	`number`	No	format: double
`shortfallQuantity`	`number`	No	format: double

InventoryShortageNotificationModelobject

Property	Type	Required	Details
`notificationID`	`string`	No	nullable
`productID`	`string`	No	nullable
`productName`	`string`	No	nullable
`availabilitySource`	`string`	No	nullable
`snapshotAtUTC`	`string`	No	format: date-time nullable
`items`	`array of InventoryShortageItemModel`	No	nullable

Used by: POST /v1/inventory/availability/shortages

InventoryTransferModelobject

Property	Type	Required	Details
`inventoryMoveID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`quantity`	`number`	No	format: double
`fromLocationID`	`string`	No	nullable
`toLocationID`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory/move

ItemLedgerModelobject

Property	Type	Required	Details
`itemLedgerID`	`string`	No	nullable
`itemID`	`string`	No	nullable
`locationID`	`string`	No	nullable
`quantityChange`	`number`	No	format: double
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`referenceLineNumber`	`integer`	No	format: int32
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

Used by: PUT /v1/inventory

MaterialMovementModelobject

Property	Type	Required	Details
`moveID`	`string`	No	nullable
`referenceType`	`string`	No	nullable
`referenceID`	`string`	No	nullable
`status`	`string`	No	nullable
`createdByUserID`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time
`lastUpdatedByUserID`	`string`	No	nullable
`lastUpdatedUTC`	`string`	No	format: date-time

Used by: PATCH /v1/warehouse/moves PUT /v1/warehouse/moves

NoteModelobject

Property	Type	Required	Details
`noteID`	`string`	No	nullable
`note`	`string`	No	nullable
`byUserID`	`string`	No	nullable
`visibility`	`string`	No	nullable
`createdUTC`	`string`	No	format: date-time

OrganizationIncotermModelobject

Property	Type	Required	Details
`termID`	`string`	No	nullable
`code`	`string`	No	nullable
`name`	`string`	No	nullable
`description`	`string`	No	nullable
`effectiveYear`	`integer`	No	format: int32
`location`	`string`	No	nullable
`defaultLocation`	`string`	No	nullable
`isDefault`	`boolean`	No
`notes`	`string`	No	nullable
`isActive`	`boolean`	No

SchedulingAlgorithmModelobject

Property	Type	Required	Details
`algorithm`	`string`	No	nullable
`attributes`	`array of string`	No	nullable
`batchSize`	`integer`	No	format: int32
`keepLineItemsTogether`	`string`	No	nullable

TenantProvisioningRequestobject

Property	Type	Required	Details
`tenantID`	`string`	No	nullable
`appID`	`string`	No	nullable
`companyType`	`string`	No	nullable
`tenant`	`InstanceModel`	No

Used by: POST /v1/provisioning/tenants

TenantProvisioningResponseobject

Property	Type	Required	Details	Description
`tenantID`	`string`	No	nullable
`status`	`string`	No	nullable

Used by: POST /v1/provisioning/tenants

Example request

curl --request GET "https://api.inventory.velosity.one/v1/inventory/reviews/{reviewMonth}" \
  --header "X-APIKEY: YOUR_API_KEY"using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("GET"), "https://api.inventory.velosity.one/v1/inventory/reviews/{reviewMonth}");
request.Headers.Add("X-APIKEY", "YOUR_API_KEY");

var response = await client.SendAsync(request);