POST v1/Warehouses

Add a new Warehouse.

Request Information

URI Parameters

None.

Body Parameters

The Warehouse changes object

Name	Description	Type	Additional 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	Gets or sets whether the warehouse is enabled or not	boolean	Required
WarehouseType	Gets or sets the warehouse type	WarehouseTypeEnum	None.
GenerateShippingLabel	Gets or sets whether or not this warehouse generates a shipping label by default	boolean	Required
GeneratePicklist	Gets or sets whether or not this warehouse generates a picklist by default	boolean	Required
GenerateReturnShippingLabel	Gets or sets whether or not this warehouse generates a return shipping label by default	boolean	Required
RequirePackDocumentsPrinted	Gets or sets whether or not this warehouse requires all pack documents printed before marking a shipment as packed.	boolean	Required
Parameters	Gets the parameters attached to this warehouse	Collection of WarehouseParameter	None.
Shops	Gets the list of shops for which this warehouse is enabled.	Collection of integer	None.
Id	Gets or sets the identifier.	integer	Must be 0 (for insert operations)
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,
  "RequirePackDocumentsPrinted": 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"
    }
  ],
  "Shops": [
    1,
    2
  ],
  "Id": 9,
  "Name": "sample string 10"
}

Response Information

Resource Description

The Warehouse object.

Warehouse

Name	Description	Type	Additional 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	Gets or sets whether the warehouse is enabled or not	boolean	Required
WarehouseType	Gets or sets the warehouse type	WarehouseTypeEnum	None.
GenerateShippingLabel	Gets or sets whether or not this warehouse generates a shipping label by default	boolean	Required
GeneratePicklist	Gets or sets whether or not this warehouse generates a picklist by default	boolean	Required
GenerateReturnShippingLabel	Gets or sets whether or not this warehouse generates a return shipping label by default	boolean	Required
RequirePackDocumentsPrinted	Gets or sets whether or not this warehouse requires all pack documents printed before marking a shipment as packed.	boolean	Required
Parameters	Gets the parameters attached to this warehouse	Collection of WarehouseParameter	None.
Shops	Gets the list of shops for which this warehouse is enabled.	Collection of integer	None.
Id	Gets or sets the identifier.	integer	Must be 0 (for insert operations)
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,
  "RequirePackDocumentsPrinted": 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"
    }
  ],
  "Shops": [
    1,
    2
  ],
  "Id": 9,
  "Name": "sample string 10"
}