Warehouses API

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.



PUT/v2/warehouses

Overview

Create new warehouse

Request fields

ElementmandatorytypeDescription
externalIdXStringIdentifier of warehouse in external system. Use EDI-code (in Finland OVT).
warehouseTypeXStringType of warehouse. Allowed values are "Posti" for webshops warehouses, "Store" for brick-and-mortar store locations and "Catalog" for direct delivery from suppliers.
contractNumberStringPosti logistics number used in shipments. Exactly six numbers. Use can use this for example to manage warehouse specific return addresses. This functionality is supported for Posti deliveries.
supplierIdXStringBusiness identitiy code (y-tunnus in Finland) of the Supplier.
backOrderAllowedXBooleanFlag to identify that backorders can be sent to this warehouse. More information from Posti. This is a webshop specific configuration.
priorityXNumberPriority number in routing orders to warehouse. The smaller the priority number is the higher priority.
routeWeightNumberLoadbalancing for the warehouses with the same priority. Eg. 30 to warehouse A and 70 to warehouse B with priority 1.
printingServiceObject
infoCodeStringUsed in tracking code if same Posti logistics number is used by several warehouses to identify shipments from a warehouse. Supported only for Posti deliveries.

Example request

{
  "externalId": "00371234567800001",
  "warehouseType": "Posti",
  "supplierId": "1234567-8",
  "contractNumber": "123456",
  "priority": 1,
  "routeWeight": 10,
  "printingService": {
     "infoCode": "00100"
  }
}

            

JSON Schema

PUT warehouse JSON schema

Response codes

Response codeMeaning
200Successfully completed.
500Internal error occured while processing request.

POST/v2/warehouses/{externalId}

Overview

Update warehouse

Request fields

Same as when creating new warehouse.

Response codes

Response codeMeaning
200Successfully completed.
404The warehouse does not exist.
500Internal error occured while processing request.

GET/v2/warehouses

Overview

List all webstore's warehouses

Response fields

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 codes

Response codeMeaning
200Successfully completed.
404The warehouse does not exist.
500Internal error occured while processing request.

GET/v2/warehouses/{externalId}

Overview

Get warehouse by it's id

Response fields

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 codes

Response codeMeaning
200Successfully completed.
404The warehouse does not exist.
500Internal error occured while processing request.