Sign in
latestOpenAPI 3.1.0MIT2026-08-104712182.1 KB

c71c20d26559

warehouses

Create warehouse

Adds a Ship From Location (formerly known as warehouse) to your account.

Note: In the API, the endpoint is called warehouse, but the process actually affects Ship From Locations in the UI.

post/warehouses/createwarehouse

Request body

warehouseNamestring

Name of Ship From Location

isDefaultboolean

Whether this will be the default Ship From Location

Example request

{
  "warehouseName": "New Ship From Location",
  "originAddress": {
    "name": "John Doe",
    "company": "Acme Corp",
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "street3": "Building B",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "phone": "512-555-1234",
    "residential": true,
    "addressVerified": "Address validated successfully"
  },
  "returnAddress": {
    "name": "John Doe",
    "company": "Acme Corp",
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "street3": "Building B",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "phone": "512-555-1234",
    "residential": true,
    "addressVerified": "Address validated successfully"
  }
}

Response

Warehouse created successfully

warehouseIdinteger
warehouseNamestring
isDefaultboolean

Example response

{
  "warehouseId": 12345,
  "originAddress": {
    "name": "John Doe",
    "company": "Acme Corp",
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "street3": "Building B",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "phone": "512-555-1234",
    "residential": true,
    "addressVerified": "Address validated successfully"
  },
  "returnAddress": {
    "name": "John Doe",
    "company": "Acme Corp",
    "street1": "123 Main St",
    "street2": "Apt 4B",
    "street3": "Building B",
    "city": "Austin",
    "state": "TX",
    "postalCode": "78701",
    "country": "US",
    "phone": "512-555-1234",
    "residential": true,
    "addressVerified": "Address validated successfully"
  }
}