Add, modify and query warehouses.
Warehouses API is used to add, modify and query warehouses information. Warehouse can be any location that contains stock balance for a product including Posti's service warehouses, external warehouses and warehouses that are located within brick-and-mortar stores. External warehouse is a warehouse that is not operated by Posti. It can be any warehouse location that is not operated by Posti or a virtual warehouse for supplier specific catalog which contains products that can be directly delivered to customers.
As with other requests to the system, user must be authenticated as described in Posti Authentication API.
| Environment | Protocol | Host |
|---|---|---|
| Test | HTTPS | argon.ecom-api.posti.com |
| Prod | HTTPS | ecom-api.posti.com |
Here is a list of all available API methods, followed by a detailed description for each one.
| PUT | /v2/warehouses | Create new warehouse | |
| POST | /v2/warehouses/{externalId} | Update warehouse | |
| GET | /v2/warehouses | List all warehouses | |
| GET | /v2/warehouses/{externalId} | Get warehouse by it's id |
Create new warehouse
| Element | mandatory | type | Description |
|---|---|---|---|
| externalId | X | String | Identifier of warehouse in external system. Use EDI-code (in Finland OVT). |
| warehouseType | X | String | Type of warehouse. Allowed values are "Posti" for webshops warehouses, "Store" for brick-and-mortar store locations and "Catalog" for direct delivery from suppliers. |
| warehouseName | String | Warehouse name that will help to identify a specific supplier's warehouse. | |
| contractNumber | X | String | Posti logistics number used in shipments. Exactly six numbers. Users can use this for example to manage warehouse specific return addresses. This functionality is supported for Posti deliveries. If order information (see Orders API) has value for it is used instead of value of contractNumber. |
| supplierId | X | String | Business identitiy code (y-tunnus in Finland) of the Supplier. |
| backOrderAllowed | X | Boolean | Flag to identify that backorders can be sent to this warehouse. More information from Posti. This is a webshop specific configuration. |
| priority | X | Number | Priority number in routing orders to warehouse. The smaller the priority number is the higher priority. |
| routeWeight | Number | Loadbalancing for the warehouses with the same priority. Eg. 30 to warehouse A and 70 to warehouse B with priority 1. | |
| deliveryOperator | String | Default delivery operator for warehouse. Possible values:
Posti,
Matkahuolto,
DBSchenker. |
|
| printingService | Object | ||
| printingService.infoCode | String | Used in tracking code if same Posti logistics number is used by several warehouses to identify shipments from a warehouse. Supported only for Posti deliveries. | |
| unifaunUser | String | In case of using Unifaun services, define the username provided by Unifaun. | |
| unifaunSecret | String | In case of using Unifaun services, define the secret provided by Unifaun. |
{
"externalId": "00371234567800001",
"warehouseType": "Posti",
"warehouseName": "Test warehouse",
"supplierId": "1234567-8",
"contractNumber": "123456",
"priority": 1,
"routeWeight": 10,
"deliveryOperator": "Posti",
"printingService": {
"infoCode": "00100"
}
}
| Response code | Meaning |
|---|---|
200 | Successfully completed. |
500 | Internal error occured while processing request. |
Update warehouse
Same as when creating new warehouse.
| Response code | Meaning |
|---|---|
200 | Successfully completed. |
404 | The warehouse does not exist. |
500 | Internal error occured while processing request. |
List all webstore's warehouses
An instance of warehouse. The content depends on the information sent with the warehouse originally. Please refer to the description of creating a new warehouse for the extensive field list.
| Response code | Meaning |
|---|---|
200 | Successfully completed. |
404 | The warehouse does not exist. |
500 | Internal error occured while processing request. |
Get warehouse by it's id
An instance of warehouse. The content depends on the information sent with the warehouse originally. Please refer to the description of creating a new warehouse for the extensive field list.
| Response code | Meaning |
|---|---|
200 | Successfully completed. |
404 | The warehouse does not exist. |
500 | Internal error occured while processing request. |