POST v1/Warehouses

Add a new Warehouse.

Request Information

Requires Authorization!

URI Parameters

None.

Body Parameters

The Warehouse changes object

WarehouseChanges
NameDescriptionTypeAdditional information
Priority

Gets or sets the priority.

integer

Required

CanPick

Gets or sets a value indicating whether this instance can pick.

boolean

Required

ShopOwnerId

Gets or sets the shop owner identifier.

integer

Required

Address

Physical address of warehouse

ContactInfoAddress

None.

Enabled

boolean

Required

WarehouseType

WarehouseTypeEnum

None.

GenerateShippingLabel

boolean

Required

GeneratePicklist

boolean

Required

GenerateReturnShippingLabel

boolean

Required

Parameters

Collection of WarehouseParameter

None.

Id

Gets or sets the identifier.

integer

Must be 0

Name

Gets or sets the name.

string

Required

Max length: 50

Request Formats

application/json, text/json

Sample:
{
  "Priority": 1,
  "CanPick": true,
  "ShopOwnerId": 3,
  "Address": {
    "Id": 1,
    "CompanyName": "sample string 2",
    "Address": "sample string 3",
    "Address2": "sample string 4",
    "StreetAddress": "sample string 5",
    "StreetAddressNumber": "sample string 6",
    "StreetAddressExtension": "sample string 7",
    "PostalCode": "sample string 8",
    "City": "sample string 9",
    "CountryId": 1,
    "CountryCode": "sample string 10",
    "CountryName": null,
    "EMail": "sample string 11",
    "Phone": "sample string 12",
    "Phone2": "sample string 13",
    "StateProvince": "sample string 14",
    "StateProvinceCode": "sample string 15"
  },
  "Enabled": true,
  "WarehouseType": 1,
  "GenerateShippingLabel": true,
  "GeneratePicklist": true,
  "GenerateReturnShippingLabel": true,
  "Parameters": [
    {
      "Id": 1,
      "WarehouseId": 2,
      "Key": "sample string 3",
      "Value": "sample string 4",
      "DataType": "sample string 5"
    },
    {
      "Id": 1,
      "WarehouseId": 2,
      "Key": "sample string 3",
      "Value": "sample string 4",
      "DataType": "sample string 5"
    }
  ],
  "Id": 8,
  "Name": "sample string 9"
}

Response Information

Resource Description

The Warehouse object.


Warehouse
NameDescriptionTypeAdditional information
Priority

Gets or sets the priority.

integer

Required

CanPick

Gets or sets a value indicating whether this instance can pick.

boolean

Required

ShopOwnerId

Gets or sets the shop owner identifier.

integer

Required

Address

Physical address of warehouse

ContactInfoAddress

None.

Enabled

boolean

Required

WarehouseType

WarehouseTypeEnum

None.

GenerateShippingLabel

boolean

Required

GeneratePicklist

boolean

Required

GenerateReturnShippingLabel

boolean

Required

Parameters

Collection of WarehouseParameter

None.

Id

Gets or sets the identifier.

integer

Must be 0

Name

Gets or sets the name.

string

Required

Max length: 50

Response Formats

application/json, text/json

Sample:
{
  "Priority": 1,
  "CanPick": true,
  "ShopOwnerId": 3,
  "Address": {
    "Id": 1,
    "CompanyName": "sample string 2",
    "Address": "sample string 3",
    "Address2": "sample string 4",
    "StreetAddress": "sample string 5",
    "StreetAddressNumber": "sample string 6",
    "StreetAddressExtension": "sample string 7",
    "PostalCode": "sample string 8",
    "City": "sample string 9",
    "CountryId": 1,
    "CountryCode": "sample string 10",
    "CountryName": null,
    "EMail": "sample string 11",
    "Phone": "sample string 12",
    "Phone2": "sample string 13",
    "StateProvince": "sample string 14",
    "StateProvinceCode": "sample string 15"
  },
  "Enabled": true,
  "WarehouseType": 1,
  "GenerateShippingLabel": true,
  "GeneratePicklist": true,
  "GenerateReturnShippingLabel": true,
  "Parameters": [
    {
      "Id": 1,
      "WarehouseId": 2,
      "Key": "sample string 3",
      "Value": "sample string 4",
      "DataType": "sample string 5"
    },
    {
      "Id": 1,
      "WarehouseId": 2,
      "Key": "sample string 3",
      "Value": "sample string 4",
      "DataType": "sample string 5"
    }
  ],
  "Id": 8,
  "Name": "sample string 9"
}