Warehouse Batches

{
  "transactiontype": 50,
  "emailowner": "info@example.com",
  "comment": "New Stocktaking"
}

HTTP Status Code Summary
200	Returns warehousebatchid
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Get Warehouse Batches

get /sites/{siteid}/warehouses/{warehouseid}/warehousebatches.json

transactiontype

object

query

Filter on transaction type. Accepts either a single TransactionType enum value (e.g. 10) or a comma-separated list (e.g. 10,50,60). When omitted, no filter is applied and every transactiontype is returned, including cycle counts (60).

Example: /sites/{siteid}/warehouses/{warehouseid}/warehousebatches.json?transactiontype=0,10,1,50

warehousebatchstate

object

query

Filter on batch state. Accepts either a single WarehouseBatchState enum value (e.g. 10) or a comma-separated list (e.g. 10,20). Defaults to 10 (Open) when omitted.

Default: 10

showstock

boolean

query

Filter on show stock flag.

searchtext

string

query

Free-text search across the warehouse batch's textual fields (e.g. name, comment, instructions, emailowner, externalid, reasoncode). The value is split on whitespace and each token must match at least one searchable field (case-insensitive substring match).

datestartfrom

integer

query

Filter on warehousebatches with datestart starting from the timestamp provided.

datestartto

integer

query

Filter on warehousebatches with datestart up to and including the timestamp provided.

dateendfrom

integer

query

Filter on warehousebatches with dateend starting from the timestamp provided.

dateendto

integer

query

Filter on warehousebatches with dateend up to and including the timestamp provided.

start

integer

query

The index of the item to start from. Used for pagination.

Default: 0

num

integer

query

Number of items to return.

Default: 10

fields

array (string)

query

Comma separated list of fields to return. Use this to query only the fields you are using. See WarehouseBatch object for all fields. Pass fields= to opt-in to additional fields available on warehousebatch (e.g. name, instructions, showstock, datestart, dateend, dateclosed, closedbyuserid).

Default: [ "warehousebatchid", "warehouseid", "warehousetransactionid", "transactiontype", "datecreated", "warehousebatchstate", "emailowner", "comment", "shipmentid", "externalid", "reasoncode" ]

Example: /sites/{siteid}/warehouses/{warehouseid}/warehousebatches.json?fields=warehousebatchid,comment,emailowner

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

Returns an envelope with items of type warehousebatch for a warehouse.

{
  "totalcount": 1,
  "items": [
    {
      "warehousebatchid": 1,
      "warehouseid": 1,
      "warehousetransactionid": null,
      "transactiontype": 10,
      "datecreated": 1463124692,
      "warehousebatchstate": 10,
      "emailowner": "",
      "comment": "",
      "shipmentid": null,
      "externalid": null,
      "reasoncode": null
    }
  ]
}

HTTP Status Code Summary
200	Returns an envelope with items of type warehousebatch for a warehouse.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Get Warehouse Batch

get /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}.json

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

Returns an item of type warehousebatch.

{
  "warehousebatchid": 2,
  "warehouseid": 1,
  "warehousetransactionid": null,
  "transactiontype": 50,
  "datecreated": 1550669775,
  "warehousebatchstate": 10,
  "emailowner": "info@example.com",
  "comment": "New Stocktaking",
  "shipmentid": null,
  "externalid": null,
  "reasoncode": null
}

HTTP Status Code Summary
200	Returns an item of type warehousebatch.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Update Warehouse Batch

put /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}.json

Note! Changing the warehousebatchstate from 10 (Open) to 20 (Closed) will trigger the commit of a transaction for the batch items.

The fields name, instructions, showstock, datestart and dateend can only be updated when the batch's transactiontype is 60 (cycle count). When updating, name must be a non-empty string and datestart must be less than or equal to dateend.

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

object

{
  "warehousebatchstate": 20,
  "emailowner": "info@example.com",
  "comment": "Stocktaking has been completed!"
}

true

HTTP Status Code Summary
200	Successful. Returns true.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Get Warehouse Batch Items

get /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/warehousebatchitems.json

start

integer

query

The index of the item to start from. Used for pagination.

Default: 0

num

integer

query

Number of items to return.

Default: 10

datelaststocktakingfrom

integer

query

Filter on items with datelaststocktaking starting from the timestamp provided.

datelaststocktakingto

integer

query

Filter on items with datelaststocktaking up to and including the timestamp provided.

WarehouseBatchCountedItem

inscope

boolean

query

Filter on whether the warehousebatchitem is in scope for the batch. Use true to return only in-scope items, false to return only out-of-scope items. Cycle-count batches only (transactiontype=60); ignored on other batch types.

sort

array (string)

query

Comma separated sort fields. Prefix a field with - to reverse direction. Supported: warehousebatchitemid, datemodified, datelaststocktaking, inscope (inscope on cycle-count batches only; the sort key is ignored on other batch types). Default: warehousebatchitemid.

fields

array (string)

query

Comma separated list of fields to return. Use this to query only the fields you are using. See WarehouseBatchItem object for all fields. Pass fields= to opt-in to additional fields available on warehousebatchitem (e.g. datelaststocktaking, inscope).

Default: [ "warehousebatchitemid", "warehousebatchid", "warehouseitemid", "sku", "datemodified", "decimalquantity", "moneypricein", "emailowner", "comment" ]

Example: /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/warehousebatchitems.json?fields=warehouseitemid,sku,decimalquantity

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

Returns an envelope with items of type warehousebatchitem for a warehousebatch.

WarehouseBatchItem

{
  "totalcount": 2,
  "items": [
    {
      "warehousebatchitemid": 1,
      "warehousebatchid": 1,
      "warehouseitemid": 3,
      "datemodified": 1463131430,
      "decimalquantity": "25.000",
      "moneypricein": "3920.00",
      "emailowner": "info@example.com",
      "comment": null,
      "sku": "10038-1"
    },
    {
      "warehousebatchitemid": 2,
      "warehousebatchid": 1,
      "warehouseitemid": 5,
      "datemodified": 1463131443,
      "decimalquantity": "5.000",
      "moneypricein": "3920.00",
      "emailowner": "info@example.com",
      "comment": null,
      "sku": "10038-2"
    }
  ]
}

HTTP Status Code Summary
200	Returns an envelope with items of type warehousebatchitem for a warehousebatch.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Batch Set Warehouse Batch Items

put /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/warehousebatchitems.json

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

array

WarehouseBatchItem

[
  {
    "sku": "10038-1",
    "decimalquantity": "9.000",
    "emailowner": "info@example.com",
    "comment": "1 missing"
  },
  {
    "sku": "10038-2",
    "decimalquantity": "2.000",
    "emailowner": "info@example.com",
    "comment": ""
  },
  {
    "sku": "10038-3",
    "decimalquantity": "1.000"
  }
]

[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  }
]

HTTP Status Code Summary
200	Returns true or a batch envelope if multiple warehousebatchitems were set
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Batch Delete Warehouse Batch Items

delete /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/warehousebatchitems.json

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

array

[
  {
    "sku": "10038-2"
  },
  {
    "sku": "10038-3"
  }
]

[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 200,
    "return": true
  }
]

HTTP Status Code Summary
200	Returns true or a batch envelope if multiple warehousebatchitems were deleted
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Get Counted Items for Closed Warehouse Batch

get /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/warehousebatchitems-counted.json

Returns the counted items for a closed warehousebatch, including stock and value before/after, approved deltas, and product title/variant/binlocation. Responds with HTTP 400 if the batch is not in state 20 (Closed).

start

integer

query

The index of the item to start from. Used for pagination.

Default: 0

num

integer

query

Number of items to return.

Default: 10

sku

array (string)

query

Filter on stock keeping unit (SKU), use comma as separator for multiple values.

inscope

boolean

query

sort

array (string)

query

Comma separated sort fields. Prefix a field with - to reverse direction. Supported: warehousebatchitemid, sku, datemodified, decimaldiff, inscope (inscope on cycle-count batches only; the sort key is ignored on other batch types). Default: warehousebatchitemid.

fields

array (string)

query

Comma separated list of fields to return. Use this to query only the fields you are using. See WarehouseBatchCountedItem object for all fields.

Default: [ "warehousebatchitemid", "warehousebatchid", "warehouseitemid", "sku", "datemodified", "decimalquantity", "moneypricein", "emailowner", "comment", "decimalquantitybefore", "decimalquantityafter", "moneyvaluebefore", "moneyvalueafter", "decimaldiff", "moneydiff", "inscope", "binlocation", "productid", "title", "variant", "images" ]

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

Returns an envelope with items of type WarehouseBatchCountedItem.

HTTP Status Code Summary
200	Returns an envelope with items of type WarehouseBatchCountedItem.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Get Cycle Count Scope Items

get /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/scope-items.json

Returns the warehouseitems declared in scope for a cycle-count (transactiontype=60) batch, including product details for display. Responds with HTTP 400 if the batch is not a cycle count.

start

integer

query

The index of the item to start from. Used for pagination.

Default: 0

num

integer

query

Number of items to return.

Default: 10

searchtext

string

query

Search text matching SKU or product title.

sku

array (string)

query

Filter on stock keeping unit (SKU), use comma as separator for multiple values.

datelaststocktakingfrom

integer

query

Filter on items with datelaststocktaking starting from the timestamp provided.

datelaststocktakingto

integer

query

Filter on items with datelaststocktaking up to and including the timestamp provided.

WarehouseBatchScopeItemRef

availablebelowthreshold

boolean

query

When true, only return items where available stock is below decimalthreshold.

sort

array (string)

query

Comma separated sort fields. Prefix a field with - to reverse direction. Supported: warehousebatchscopeitemid, warehouseitemid, sku, title, decimaltotal, decimalreserved, moneytotal, datelaststocktaking, dateadded. Default: sku.

fields

array (string)

query

Comma separated list of fields to return. Use this to query only the fields you are using. See WarehouseBatchScopeItem object for all fields.

Default: [ "warehousebatchscopeitemid", "warehousebatchid", "warehouseitemid", "sku", "dateadded", "title", "variant", "decimaltotal", "decimalreserved", "moneytotal", "datelaststocktaking" ]

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

Returns an envelope with items of type WarehouseBatchScopeItem.

WarehouseBatchScopeItem

HTTP Status Code Summary
200	Returns an envelope with items of type WarehouseBatchScopeItem.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Add Cycle Count Scope Item

post /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/scope-items.json

Add a single sku to the scope of a cycle-count batch in state Pending (40). Idempotent — returns true if the row already exists. When the sku has never been stocked at the warehouse, a warehouse item (zero stock) is created automatically.

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

object

{
  "sku": "100287"
}

true

HTTP Status Code Summary
200	Successful. Returns true.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Replace Cycle Count Scope

put /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/scope-items.json

Replace-all semantics: the resulting scope equals exactly the sku values supplied in the body. Rows present today but absent from the body are deleted; rows in the body but missing today are inserted. An empty array is valid and clears the scope. Warehouse items (zero stock) are created automatically for skus never stocked at the warehouse. Duplicate skus (case-insensitive) in the body return HTTP 400. Only allowed on cycle-count batches in state Pending (40).

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

array

WarehouseBatchScopeItemRef

[
  {
    "sku": "100287"
  },
  {
    "sku": "100288"
  }
]

true

HTTP Status Code Summary
200	Successful. Returns true.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
404	The specified resource was not found.
429	Too Many Requests.
500	Internal Server Error.

Delete Cycle Count Scope Items

delete /sites/{siteid}/warehouses/{warehouseid}/warehousebatches/{warehousebatchid}/scope-items.json

Delete one or more sku rows from the scope of a cycle-count batch in state Pending (40). Deleting a sku with no scope row (or never stocked at the warehouse) is a no-op; no warehouse items are created. Duplicate skus (case-insensitive) in the body, and an empty array, return HTTP 400. Each row is processed on its own and reported in a batch envelope, so a row that fails — including a batch that belongs to another warehouse — is reported as {"statuscode": 400, "errortext": "…"} while the request itself answers HTTP 200.

siteid

integer

path

REQUIRED

Site ID. (Use eshopid of the site for this parameter).

warehouseid

integer

path

REQUIRED

Warehouse ID.

warehousebatchid

integer

path

REQUIRED

Warehouse Batch ID.

array

WarehouseBatchScopeItemRef

[
  {
    "sku": "100287"
  },
  {
    "sku": "100288"
  }
]

[
  {
    "statuscode": 200,
    "return": true
  },
  {
    "statuscode": 400,
    "errortext": "Warehouse batch does not belong to the given warehouse."
  }
]

HTTP Status Code Summary
200	Returns a batch envelope with one row per provided item, in the same order they were received.
400	Invalid request. Data sent from client is invalid.
401	Missing or bad authentication.
429	Too Many Requests.
500	Internal Server Error.

Objects

DecimalQuantity
string

Pattern: ^[-+]?[0-9]+\.[0-9]{3}$

Example: "123.000"

Error
object

statuscode

integer

REQUIRED

A status code for the error. Usually HTTP status code.

errortext

string

REQUIRED

A textual description of the error.

errorcode

string

An optional internal code for the error.

Money
string

Pattern: ^[-+]?[0-9]+\.[0-9]{2}$

Example: "123.00"

Timestamp
integer

Number of seconds since the Unix Epoch.

TransactionType
integer

10 ManualIn
20 ManualOut
30 Sales
40 Refund
50 StockTaking
60 Cycle count

Values: 10, 20, 30, 40, 50, 60

WarehouseBatch
object

All changes to a warehouse is made using transactions. To make a change, first create a warehousebatch, add batch items and then set the batch to closed. That will commit the batch and create a warehousetransaction.

warehousebatchid

integer

READ ONLY

The unique ID of the warehousebatch.

warehouseid

integer

READ ONLY

The warehouse ID for this warehousebatch.

warehousetransactionid

integer

READ ONLY

The warehouse transaction ID for this warehousebatch.

transactiontype

TransactionType

REQUIRED

The type of the transaction.

datecreated

READ ONLY

The creation date for this warehousebatch.

warehousebatchstate

WarehouseBatchState

The state of this warehousebatch.

emailowner

string

The email for the owner of this warehousebatch.

comment

string

The comment for this warehousebatch.

name

string

nullable

The name for this warehousebatch. Can only be set on cycle count batches (transactiontype = 60). Null when no name has been set.

Max Length: 255

instructions

string

nullable

The instructions for this warehousebatch. Can only be set on cycle count batches (transactiontype = 60). Null when no instructions have been set.

Max Length: 65535

shipmentid

integer

The ID for the shipment that is the source of this warehouse batch (if applicable).

externalid

string

External ID for the warehousebatch which will be transferred to the warehouse transaction (if applicable).

reasoncode

string

A reason code for the warehousebatch which will be transferred to the warehouse transaction (if applicable).

showstock

boolean

nullable

Flag indicating if stock quantities are shown to the counter for this warehousebatch. Can only be set on cycle count batches (transactiontype = 60). Null when not set.

datestart

nullable

The start date for this warehousebatch. Can only be set on cycle count batches (transactiontype = 60). Must be less than or equal to dateend. Null when no start bound is set.

dateend

nullable

The end date for this warehousebatch. Can only be set on cycle count batches (transactiontype = 60). Must be greater than or equal to datestart. Null when no end bound is set.

dateclosed

nullable

READ ONLY

The date the warehousebatch was closed. Null while the batch has not been closed yet.

closedbyuserid

string

nullable

READ ONLY

The user ID (GUID matching the User entity) of the logged-in user who closed the warehousebatch. Populated for back-office requests authenticated with a user session (api_session token). Null when the batch is closed via a plain API-key token or by a background job that carries no user identity.

WarehouseBatchCountedItem
object

A counted item for a closed warehousebatch (before/after stock and value, approved deltas) plus product title/variant/binlocation. Returned only by the /warehousebatches/{warehousebatchid}/warehousebatchitems-counted endpoint.

warehousebatchitemid

integer

READ ONLY

The unique ID of the warehousebatchitem.

warehousebatchid

integer

READ ONLY

The ID of the warehousebatch.

warehouseitemid

integer

READ ONLY

The ID of the warehouseitem.

sku

string

READ ONLY

The SKU for this stock item.

datemodified

READ ONLY

The modified date for this warehousebatchitem.

decimalquantity

READ ONLY

The quantity counted by staff for this warehousebatchitem.

moneypricein

READ ONLY

The purchase price per item for this warehousebatchitem.

emailowner

string

READ ONLY

The email for the owner of this warehousebatchitem.

comment

string

READ ONLY

A comment for the warehousebatchitem.

decimalquantitybefore

READ ONLY

Stock quantity for this item BEFORE the batch transaction was committed.

decimalquantityafter

READ ONLY

Stock quantity for this item AFTER the batch transaction was committed.

moneyvaluebefore

READ ONLY

Stock value for this item BEFORE the batch transaction was committed.

moneyvalueafter

READ ONLY

Stock value for this item AFTER the batch transaction was committed.

decimaldiff

READ ONLY

Approved quantity delta committed by the transaction (= decimalquantityafter - decimalquantitybefore).

moneydiff

READ ONLY

Approved value delta committed by the transaction (= moneyvalueafter - moneyvaluebefore).

inscope

boolean

READ ONLY

Whether this batchitem was in scope for the batch. Cycle-count batches only (transactiontype=60); omitted from the response on all other batch types.

binlocation

string

READ ONLY

Bin location for the stock item in the warehouse.

productid

integer

READ ONLY

The product ID.

title

string

READ ONLY

The product title.

variant

array

(object)

READ ONLY

Array of variant attributes for the product. Each item has name (variant group, e.g. "Size") and value (variant value, e.g. "Large"). Empty array for non-variant products.

name

string

value

string

images

array

(string)

READ ONLY

Array containing the URL of the product's first image. Empty array when the product has no images.

WarehouseBatchItem
object

Warehouse batch item for a warehousebatch.

warehousebatchitemid

integer

READ ONLY

The unique ID of the warehousebatchitem.

warehousebatchid

integer

READ ONLY

The ID of the warehousebatch that this warehousebatchitem belongs to.

warehouseitemid

integer

READ ONLY

The unique ID of the warehouseitem.

datemodified

READ ONLY

The modified date for this warehousebatchitem.

decimalquantity

The stock quantity for this warehousebatchitem.

moneypricein

The purchase price per item for this warehousebatchitem.

emailowner

string

The email for the owner of this warehousebatchitem.

comment

string

A comment for the warehousebatchitem.

sku

string

REQUIRED

The SKU for this stock item.

datelaststocktaking

nullable

READ ONLY

The last date this warehouseitem has been part of a stocktaking or cycle count transaction.

inscope

boolean

READ ONLY

Whether this warehousebatchitem is in scope for the batch. Cycle-count batches only (transactiontype=60); omitted on other batch types. Read-only; only returned when requested via fields=. Not accepted in POST/PUT request bodies.

WarehouseBatchScopeItem
object

One warehouseitem declared in scope for a cycle-count warehousebatch (transactiontype 60) in state Pending (40), including product details for display. Returned by GET /warehousebatches/{warehousebatchid}/scope-items.

warehousebatchscopeitemid

integer

READ ONLY

The unique ID of the scope-item row.

warehousebatchid

integer

READ ONLY

The ID of the warehousebatch.

warehouseitemid

integer

READ ONLY

The ID of the warehouseitem in scope.

sku

string

READ ONLY

The SKU for this stock item.

dateadded

READ ONLY

When the warehouseitem was added to the cycle-count scope.

title

string

READ ONLY

The product title.

variant

array

(object)

READ ONLY

Array of variant attributes for the product. Each item has name and value.

name

string

value

string

decimaltotal

READ ONLY

Current stock level for the warehouseitem.

decimalreserved

READ ONLY

Reserved stock level for the warehouseitem.

moneytotal

READ ONLY

Current stock value for the warehouseitem.

datelaststocktaking