Admin Settings: Inventory Sources

Create a new inventory source

Create a new inventory source

post/settings/inventory-sources

Request

Request body

codestring required
namestring required
descriptionstring
contact_namestring required
contact_emailstring required
contact_numberstring required
contact_faxstring
countrystring required
statestring required
citystring required
streetstring required
postcodestring required
priorityinteger
latitudenumber float
longitudenumber float
status0 | 1

Example request

{
  "code": "warehouse-1",
  "name": "Warehouse 1",
  "description": "Primary warehouse.",
  "contact_name": "Jane Doe",
  "contact_email": "jane@example.com",
  "contact_number": "1234567890",
  "country": "US",
  "state": "CA",
  "city": "Los Angeles",
  "street": "123 Main St",
  "postcode": "90001",
  "latitude": 34.05,
  "longitude": -118.24,
  "status": 1
}

Response

Inventory source created.

idinteger nullable
codestring nullable
namestring nullable
descriptionstring nullable
contactNamestring nullable
contactEmailstring nullable
contactNumberstring nullable
contactFaxstring nullable
countrystring nullable
statestring nullable
citystring nullable
streetstring nullable
postcodestring nullable
priorityinteger nullable
latitudenumber nullable
longitudenumber nullable
statusinteger nullable
createdAtstring nullable
updatedAtstring nullable
messagestring nullable

Example response

{
  "id": 1,
  "code": "default",
  "name": "Default Warehouse",
  "description": "Primary fulfilment warehouse",
  "contactName": "Jane Smith",
  "contactEmail": "warehouse@example.com",
  "contactNumber": "+1-555-0100",
  "contactFax": "+1-555-0101",
  "country": "US",
  "state": "CA",
  "city": "San Francisco",
  "street": "123 Market St",
  "postcode": "94103",
  "priority": 1,
  "latitude": 37.7749,
  "longitude": -122.4194,
  "status": 1,
  "createdAt": "2026-05-25T08:15:00+00:00",
  "updatedAt": "2026-05-25T08:20:00+00:00",
  "message": "Inventory source deleted successfully."
}

Changes

No recorded changes to this operation across all 8 revisions of this API.