Customer orders API

General:

Basics:

Base-URL: https://capi.lagerkoll.com/v1/customer_orders/

Parameters in the url should all be encoded and all data sent should be UTF-8

MAX number of requests per minute is set to 200.
When the limit is hit an error with code 429 is returned, with the header "Retry-After" containing the number of seconds you have to wait for your next request.

Headers:

There are 2 ways to be authenticated when using this API. in both ways you add headers to the request.
1) Use an API-key together with store-id. This would be used when communicating machine to machine and no real person is involved. The API-key is available from where you activated the API. The store-id is also available in the same place.
2) Use a user_id and user_token together with a store-id. You get these values from the login-request. The values are connected to a person and are gained when an actual login to the system has been made.

store: <<STORE>>
user_id: <<USER_ID>>
user_token: <<USER_TOKEN>>
api_key: <<API_KEY>>
Accept: application/json
Content-Type: application/json

Errors:

Code	Description
900001	Credentials don't match
900101	Common error
900429	Too many requests
900701	Error when getting customer order
900702	Error when creating a customer order
900703	Error when updating a customer order
900711	Error when getting picking list
900713	Error when updating picking list
900721	Error when getting rest articles
900732	Error creating drop shipment from Customer order
900743	Error sending confirmation
900752	Customer order value is 0
900761	Error when getting offer
900762	Error when creating an offer
900763	Error when updating an offer

{
  "errorCode" : 900101,
  "errorMessage" : "Something went wrong on the server",
  "errorField" : null,
  "errorData" : null
}

Customer orders API:

Customer orders

Get customer order

GETUrl: /{id}

Headers:

Accept: application/json or application/xml

Get a single customer orders based on order id

Body:

Successfull response:

CustomerOrdersResponse

{
    "ordersCount": 9598,
    "pages": 6844,
    "totalCustomerOrderValue": 5998.571214297813,
    "pageSize": 7994,
    "orders": [{
        "orderId": 2439,
        "totalPrice": 1586.1304042848124,
        "paymentTermDesc": "paymentTermDesc",
        "freight": 9669.43807969397,
        "phone2": "phone2",
        "deliveryEmail": "deliveryEmail",
        "administrationFee": 6679.212919775336,
        "webshopOrderId": "webshopOrderId",
        "customerOrderNumber": "customerOrderNumber",
        "orderValue": 5649.562551441319,
        "phone1": "phone1",
        "products": [{
            "deliveredAmount": "0",
            "isBundled": false,
            "totalPrice": 9208.18968240081,
            "costCenter": 9689,
            "articleId": "articleId",
            "vat": 916.4066249217784,
            "discount": "0",
            "description": "description",
            "weight": 2584.5432586769834,
            "storeId": 2803,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182845988,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "pickedAmount": "0",
            "piecePrice": 2784.3061013764445,
            "tg": 818.8445784871079,
            "availableAmount": 8877.554876942624,
            "storeGroupId": 6844,
            "rowIndex": 3133,
            "discountType": "AMOUNT",
            "id": 1301,
            "orderedAmount": 9224.239412924448,
            "stockWarning": 75.17305083901805
        }],
        "deliveredDate": 1732182845988,
        "ourReference": "ourReference",
        "storeGroupId": 1457,
        "deliveryTermDesc": "deliveryTermDesc",
        "deliveryZipCode": "deliveryZipCode",
        "wayOfDelivery": "wayOfDelivery",
        "customerId": 2455,
        "currency": "currency",
        "state": "0",
        "deliveryDate": 1732182845988,
        "deliveryCity": "deliveryCity",
        "comments": "comments",
        "yourReference": "yourReference",
        "pricelistId": "-1",
        "deliveryTerm": "deliveryTerm",
        "costCenter": 6196,
        "deliveryAddress2": "deliveryAddress2",
        "externalOrderId": "externalOrderId",
        "deliveryAddress1": "deliveryAddress1",
        "wayOfDeliveryDesc": "wayOfDeliveryDesc",
        "customerName": "customerName",
        "externalInvoiceReference1": "externalInvoiceReference1",
        "externalInvoiceReference2": "externalInvoiceReference2",
        "deliveryCountry": "deliveryCountry",
        "vatIncluded": "true",
        "totalDiscount": 5637.587937090102,
        "currencyRate": 5393.2147487837365,
        "deliveryName": "deliveryName",
        "orderDate": 1732182845988,
        "paymentTerm": "paymentTerm",
        "remarks": "remarks",
        "deliveryStatus": 9597,
        "externalDisplayOrderId": "externalDisplayOrderId"
    }],
    "page": 4659,
    "since": 7528
}

Get customer orders with article

GETUrl: /article/{article_id : .+}

Headers:

Accept: application/json or application/xml

Get a list of customer orders that contains a specific article. It´s also possible to filter article on batch or serialnumber

Valid parameters:

Parameter	Default value	Allowed values
batch
serialnumber
max_state
from	0
to	0
page	0
limit	50
sort_column	id	id,customer,order_date,delivery_date,delivered_date,state
order	desc	asc,desc

Body:

Successfull response:

CustomerOrdersResponse

{
    "ordersCount": 8205,
    "pages": 9897,
    "totalCustomerOrderValue": 3264.7246780862647,
    "pageSize": 632,
    "orders": [{
        "orderId": 5500,
        "totalPrice": 4191.294077790436,
        "paymentTermDesc": "paymentTermDesc",
        "freight": 8780.127051884076,
        "phone2": "phone2",
        "deliveryEmail": "deliveryEmail",
        "administrationFee": 458.790276507598,
        "webshopOrderId": "webshopOrderId",
        "customerOrderNumber": "customerOrderNumber",
        "orderValue": 1008.8080147709333,
        "phone1": "phone1",
        "products": [{
            "deliveredAmount": "0",
            "isBundled": true,
            "totalPrice": 5506.4089079917385,
            "costCenter": 3221,
            "articleId": "articleId",
            "vat": 8359.8973739032,
            "discount": "0",
            "description": "description",
            "weight": 5202.722779496225,
            "storeId": 9149,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182845998,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "pickedAmount": "0",
            "piecePrice": 8816.261492010866,
            "tg": 6949.1792112374715,
            "availableAmount": 1140.7427706553462,
            "storeGroupId": 5884,
            "rowIndex": 9085,
            "discountType": "AMOUNT",
            "id": 9810,
            "orderedAmount": 8710.260704004944,
            "stockWarning": 9396.38492262803
        }],
        "deliveredDate": 1732182845998,
        "ourReference": "ourReference",
        "storeGroupId": 9870,
        "deliveryTermDesc": "deliveryTermDesc",
        "deliveryZipCode": "deliveryZipCode",
        "wayOfDelivery": "wayOfDelivery",
        "customerId": 9981,
        "currency": "currency",
        "state": "0",
        "deliveryDate": 1732182845998,
        "deliveryCity": "deliveryCity",
        "comments": "comments",
        "yourReference": "yourReference",
        "pricelistId": "-1",
        "deliveryTerm": "deliveryTerm",
        "costCenter": 5649,
        "deliveryAddress2": "deliveryAddress2",
        "externalOrderId": "externalOrderId",
        "deliveryAddress1": "deliveryAddress1",
        "wayOfDeliveryDesc": "wayOfDeliveryDesc",
        "customerName": "customerName",
        "externalInvoiceReference1": "externalInvoiceReference1",
        "externalInvoiceReference2": "externalInvoiceReference2",
        "deliveryCountry": "deliveryCountry",
        "vatIncluded": "true",
        "totalDiscount": 4586.470011108809,
        "currencyRate": 7893.206068363391,
        "deliveryName": "deliveryName",
        "orderDate": 1732182845998,
        "paymentTerm": "paymentTerm",
        "remarks": "remarks",
        "deliveryStatus": 5155,
        "externalDisplayOrderId": "externalDisplayOrderId"
    }],
    "page": 2001,
    "since": 1099
}

Get customer order by external id

GETUrl: /external/{external_id}

Headers:

Accept: application/json or application/xml

Get a single customer order based on external order id

Body:

Successfull response:

CustomerOrdersResponse

{
    "ordersCount": 5740,
    "pages": 5678,
    "totalCustomerOrderValue": 2366.273217358893,
    "pageSize": 7983,
    "orders": [{
        "orderId": 8118,
        "totalPrice": 5949.454746763952,
        "paymentTermDesc": "paymentTermDesc",
        "freight": 4156.660597487551,
        "phone2": "phone2",
        "deliveryEmail": "deliveryEmail",
        "administrationFee": 8623.381984370304,
        "webshopOrderId": "webshopOrderId",
        "customerOrderNumber": "customerOrderNumber",
        "orderValue": 4147.639922058796,
        "phone1": "phone1",
        "products": [{
            "deliveredAmount": "0",
            "isBundled": true,
            "totalPrice": 4489.561669200186,
            "costCenter": 7426,
            "articleId": "articleId",
            "vat": 4032.3576471507217,
            "discount": "0",
            "description": "description",
            "weight": 6819.53203874199,
            "storeId": 1462,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846013,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "pickedAmount": "0",
            "piecePrice": 7065.8578026950145,
            "tg": 9916.859928791599,
            "availableAmount": 5345.9406655387,
            "storeGroupId": 7301,
            "rowIndex": 8657,
            "discountType": "AMOUNT",
            "id": 1724,
            "orderedAmount": 109.22491606690122,
            "stockWarning": 1451.8223734308865
        }],
        "deliveredDate": 1732182846013,
        "ourReference": "ourReference",
        "storeGroupId": 5790,
        "deliveryTermDesc": "deliveryTermDesc",
        "deliveryZipCode": "deliveryZipCode",
        "wayOfDelivery": "wayOfDelivery",
        "customerId": 4775,
        "currency": "currency",
        "state": "0",
        "deliveryDate": 1732182846013,
        "deliveryCity": "deliveryCity",
        "comments": "comments",
        "yourReference": "yourReference",
        "pricelistId": "-1",
        "deliveryTerm": "deliveryTerm",
        "costCenter": 9204,
        "deliveryAddress2": "deliveryAddress2",
        "externalOrderId": "externalOrderId",
        "deliveryAddress1": "deliveryAddress1",
        "wayOfDeliveryDesc": "wayOfDeliveryDesc",
        "customerName": "customerName",
        "externalInvoiceReference1": "externalInvoiceReference1",
        "externalInvoiceReference2": "externalInvoiceReference2",
        "deliveryCountry": "deliveryCountry",
        "vatIncluded": "true",
        "totalDiscount": 3370.8593511589256,
        "currencyRate": 393.6728133722189,
        "deliveryName": "deliveryName",
        "orderDate": 1732182846013,
        "paymentTerm": "paymentTerm",
        "remarks": "remarks",
        "deliveryStatus": 3415,
        "externalDisplayOrderId": "externalDisplayOrderId"
    }],
    "page": 3900,
    "since": 3596
}

Get customer orders

GETUrl:

Headers:

Accept: application/json or application/xml

Get a list of customer orders

Valid parameters:

Parameter	Default value	Allowed values
customer_id
state	-1	-1,0,5,10,15,20,30,40,45,50,60
since	0
page	0
limit	50
query
sort_column	id	id,customer,order_date,delivery_date,delivered_date,state, way_of_delivery, order_value
order	desc	asc,desc

Body:

Successfull response:

CustomerOrdersResponse

{
    "ordersCount": 9680,
    "pages": 1741,
    "totalCustomerOrderValue": 9056.70014054082,
    "pageSize": 7282,
    "orders": [{
        "orderId": 8848,
        "totalPrice": 2948.2761175912497,
        "paymentTermDesc": "paymentTermDesc",
        "freight": 8675.339409961653,
        "phone2": "phone2",
        "deliveryEmail": "deliveryEmail",
        "administrationFee": 6702.634344699996,
        "webshopOrderId": "webshopOrderId",
        "customerOrderNumber": "customerOrderNumber",
        "orderValue": 3545.094506386514,
        "phone1": "phone1",
        "products": [{
            "deliveredAmount": "0",
            "isBundled": false,
            "totalPrice": 619.5869675182574,
            "costCenter": 9054,
            "articleId": "articleId",
            "vat": 7275.473671427488,
            "discount": "0",
            "description": "description",
            "weight": 9849.407533549744,
            "storeId": 7831,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846026,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "pickedAmount": "0",
            "piecePrice": 3403.8219280571548,
            "tg": 9548.286623723405,
            "availableAmount": 8868.957700351237,
            "storeGroupId": 7861,
            "rowIndex": 6453,
            "discountType": "AMOUNT",
            "id": 2938,
            "orderedAmount": 7942.224571700216,
            "stockWarning": 3736.3503779626094
        }],
        "deliveredDate": 1732182846026,
        "ourReference": "ourReference",
        "storeGroupId": 7206,
        "deliveryTermDesc": "deliveryTermDesc",
        "deliveryZipCode": "deliveryZipCode",
        "wayOfDelivery": "wayOfDelivery",
        "customerId": 4523,
        "currency": "currency",
        "state": "0",
        "deliveryDate": 1732182846026,
        "deliveryCity": "deliveryCity",
        "comments": "comments",
        "yourReference": "yourReference",
        "pricelistId": "-1",
        "deliveryTerm": "deliveryTerm",
        "costCenter": 5267,
        "deliveryAddress2": "deliveryAddress2",
        "externalOrderId": "externalOrderId",
        "deliveryAddress1": "deliveryAddress1",
        "wayOfDeliveryDesc": "wayOfDeliveryDesc",
        "customerName": "customerName",
        "externalInvoiceReference1": "externalInvoiceReference1",
        "externalInvoiceReference2": "externalInvoiceReference2",
        "deliveryCountry": "deliveryCountry",
        "vatIncluded": "true",
        "totalDiscount": 5070.514278918363,
        "currencyRate": 869.5670256094123,
        "deliveryName": "deliveryName",
        "orderDate": 1732182846026,
        "paymentTerm": "paymentTerm",
        "remarks": "remarks",
        "deliveryStatus": 9111,
        "externalDisplayOrderId": "externalDisplayOrderId"
    }],
    "page": 6349,
    "since": 2842
}

Get customer orders for state

GETUrl: /state/{state}

Headers:

Accept: application/json or application/xml

Get a list of customer orders based on state

Valid parameters:

Parameter	Default value	Allowed values
from	0
to	0
page	0
limit	50
sort_column	id	id,delivery_date,delivered_date
order	desc	asc,desc

Body:

Successfull response:

CustomerOrdersResponse

{
    "ordersCount": 7019,
    "pages": 4136,
    "totalCustomerOrderValue": 2895.1350635633567,
    "pageSize": 7672,
    "orders": [{
        "orderId": 7159,
        "totalPrice": 2121.772895229561,
        "paymentTermDesc": "paymentTermDesc",
        "freight": 3044.027145168846,
        "phone2": "phone2",
        "deliveryEmail": "deliveryEmail",
        "administrationFee": 3766.6057838921674,
        "webshopOrderId": "webshopOrderId",
        "customerOrderNumber": "customerOrderNumber",
        "orderValue": 8163.584173926544,
        "phone1": "phone1",
        "products": [{
            "deliveredAmount": "0",
            "isBundled": true,
            "totalPrice": 8294.675010349805,
            "costCenter": 7708,
            "articleId": "articleId",
            "vat": 8975.893531422367,
            "discount": "0",
            "description": "description",
            "weight": 4473.4515904715545,
            "storeId": 5753,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846028,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "pickedAmount": "0",
            "piecePrice": 5997.939305437067,
            "tg": 3306.9309045128357,
            "availableAmount": 5784.049958505063,
            "storeGroupId": 4672,
            "rowIndex": 2314,
            "discountType": "AMOUNT",
            "id": 3416,
            "orderedAmount": 4055.3257043723447,
            "stockWarning": 3674.5933198708703
        }],
        "deliveredDate": 1732182846028,
        "ourReference": "ourReference",
        "storeGroupId": 5232,
        "deliveryTermDesc": "deliveryTermDesc",
        "deliveryZipCode": "deliveryZipCode",
        "wayOfDelivery": "wayOfDelivery",
        "customerId": 3732,
        "currency": "currency",
        "state": "0",
        "deliveryDate": 1732182846028,
        "deliveryCity": "deliveryCity",
        "comments": "comments",
        "yourReference": "yourReference",
        "pricelistId": "-1",
        "deliveryTerm": "deliveryTerm",
        "costCenter": 9409,
        "deliveryAddress2": "deliveryAddress2",
        "externalOrderId": "externalOrderId",
        "deliveryAddress1": "deliveryAddress1",
        "wayOfDeliveryDesc": "wayOfDeliveryDesc",
        "customerName": "customerName",
        "externalInvoiceReference1": "externalInvoiceReference1",
        "externalInvoiceReference2": "externalInvoiceReference2",
        "deliveryCountry": "deliveryCountry",
        "vatIncluded": "true",
        "totalDiscount": 8577.435976914114,
        "currencyRate": 1865.6494153702008,
        "deliveryName": "deliveryName",
        "orderDate": 1732182846028,
        "paymentTerm": "paymentTerm",
        "remarks": "remarks",
        "deliveryStatus": 9030,
        "externalDisplayOrderId": "externalDisplayOrderId"
    }],
    "page": 2159,
    "since": 5422
}

Get products for customer order

GETUrl: /{id}/products

Headers:

Accept: application/json or application/xml

Get list of products for a customer order with details

Body:

Successfull response:

Article[]

{
    "supplierAutomaticOrder": true,
    "supplierBuyPriceMisc": 6136.161126113387,
    "supplierExternalId": "supplierExternalId",
    "type": "type",
    "price": 4857.443722935197,
    "supplier": 9427,
    "supplierArticleId": "supplierArticleId",
    "vatAccount": 3689,
    "links": [{
        "name": "name",
        "type": "type",
        "url": "url"
    }],
    "stock": "true",
    "barcode": "barcode",
    "height": 1395.3437763387121,
    "bundled": "false",
    "vat": 9738.611915479156,
    "nextDeliveryDate": 4443,
    "active": "true",
    "weight": 932.4692329216189,
    "tags": [{
        "name": "name",
        "externalId": "externalId",
        "id": 8349,
        "desc": "desc"
    }],
    "supplierBuyRate": 4264.851222111651,
    "unit": "st",
    "reserved": 1629.8551367944492,
    "name": "name",
    "parts": [{
        "buyPrice": 8102.008636093314,
        "supplierName": "supplierName",
        "amount": 777.7279385432967,
        "articleName": "articleName",
        "supplierId": 5959,
        "unitName": "unitName",
        "articleId": "articleId",
        "externalId": "externalId",
        "stockPlace": "stockPlace",
        "type": "type",
        "buyPriceCurrency": "buyPriceCurrency",
        "reserved": 4568.838626363817,
        "buyPriceShipment": 4378.009486058315,
        "buyPriceMisc": 2977.379406038705,
        "supplierArticleId": "supplierArticleId",
        "stock": 4220.214346973289,
        "isStock": true,
        "stockWarning": 6477.040228070756
    }],
    "supplierBuyPriceShipment": 1665.7935093567112,
    "manufacturerArticleId": "manufacturerArticleId",
    "imageLastUpdated": 8042,
    "orderedAmount": 803.1798019545112,
    "stockWarning": 4396.662754533336,
    "customFields": [{
        "name": "name",
        "type": "type",
        "validValues": [{
            "description": "description",
            "value": "value"
        }],
        "value": "value"
    }],
    "barcodeType": "EAN",
    "description": "description",
    "stockPlace": "stockPlace",
    "criticalLevel": 841.2290378564879,
    "manufacturer": "manufacturer",
    "batches": {
        "totalSerialNumbersReserved": 4946.288396662693,
        "batches": [{
            "serialNr": "serialNr",
            "amount": "1",
            "articleName": "articleName",
            "reserved": 6295.703747171583,
            "bestBefore": 9520,
            "articleId": "articleId",
            "batchId": "batchId",
            "barcode": "barcode"
        }],
        "totalBatchesInStock": 1722.0642180960388,
        "totalSerialNumbersInStock": 6777.170458515001,
        "serialNumbers": [{
            "serialNr": "serialNr",
            "amount": "1",
            "articleName": "articleName",
            "reserved": 334.0785739293728,
            "bestBefore": 3524,
            "articleId": "articleId",
            "batchId": "batchId",
            "barcode": "barcode"
        }],
        "totalBatchesReserved": 6841.780964936066,
        "totalBatches": 8335,
        "totalSerialNumbers": 8888
    },
    "webshopArticle": "false",
    "availableAmount": 5485.038566948381,
    "orderLevel": 6641.2383765949235,
    "prices": [{
        "listId": 9044,
        "price": "0",
        "articleId": "articleId",
        "fromQuantity": "0",
        "listExternalId": "listExternalId"
    }],
    "supplierArticles": [{
        "supplierName": "supplierName",
        "supplierAutomaticOrder": false,
        "supplierBuyPriceMisc": 2839.5768554933966,
        "supplierBuyRate": "1.0",
        "supplierBuyPrice": 1734.2974765856534,
        "supplier": 3254,
        "supplierArticleId": "supplierArticleId",
        "supplierBuyCurrency": "Store currency",
        "supplierBuyPriceShipment": 8123.768293055376
    }],
    "automaticOrder": false,
    "supplierName": "supplierName",
    "deliveredAmount": 3317.445191787408,
    "amount": 9446.8150536298,
    "articleId": "articleId",
    "externalId": "externalId",
    "depth": 8242.214667656324,
    "supplierBuyPrice": 3478.470909528544,
    "supplierBuyCurrency": "supplierBuyCurrency",
    "width": 3026.3731423622476,
    "category": "övrigt"
}

Get customer order cost

GETUrl: /cost/{id}

Headers:

Accept: application/json or application/xml

Get the cost for a specific customer order based on order id

Body:

Successfull response:

CustomerOrderCost

{
    "orderId": 3696,
    "productCosts": [{
        "deliveredAmount": 8866.772541003962,
        "articleId": "articleId",
        "totalCost": 3172.2606405891906
    }]
}

Get purchase orders for customer order

GETUrl: /{order_id}/purchase_orders

Headers:

Accept: application/json or application/xml

Get dropshipment orders for a customer order

Body:

Successfull response:

PurchaseOrdersResponse

{
    "ordersCount": 7460,
    "pages": 6041,
    "pageSize": 2870,
    "orders": [{
        "paymentTermsDescription": "paymentTermsDescription",
        "deliveryPhone": "deliveryPhone",
        "supplierOrderId": "supplierOrderId",
        "supplierId": 5452,
        "productionOrderId": 7704,
        "deliveryTermsDescription": "deliveryTermsDescription",
        "customerOrderId": 1030,
        "contactPerson": "contactPerson",
        "deliveryZip": "deliveryZip",
        "productCount": 7861,
        "orderValue": 3257.465804930426,
        "confirmedDeliveryDate": 1732182846045,
        "externalInvoiceReference": "externalInvoiceReference",
        "orderValueCurrency": "orderValueCurrency",
        "deliveredDate": 1732182846045,
        "deliveryAddress": "deliveryAddress",
        "orderSentDate": 1732182846045,
        "deliveryContact": "deliveryContact",
        "id": 7225,
        "state": 7967,
        "deliveryDate": 1732182846045,
        "paymentTerms": "paymentTerms",
        "supplierName": "supplierName",
        "deliveryCity": "deliveryCity",
        "deliveryTerms": "deliveryTerms",
        "goodsMarking": "goodsMarking",
        "contactEmail": "contactEmail",
        "isPickNPack": "false",
        "deliveryAddress2": "deliveryAddress2",
        "orderValueStore": 6958.138807097256,
        "storeId": 6941,
        "deliveryCompany": "deliveryCompany",
        "message": "message",
        "deliveryCountry": "deliveryCountry",
        "comment": "comment",
        "articles": [{
            "deliveredAmount": "0",
            "articleName": "articleName",
            "purchasePriceMisc": "0",
            "barcodeType": "EAN",
            "articleId": "articleId",
            "description": "description",
            "purchasePrice": "0",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 6927
                },
                "articleId": "articleId",
                "storegroupId": 4069,
                "convert": 7586.2955141133425,
                "barcode": "barcode"
            }],
            "type": "type",
            "batches": [{
                "deliveredAmount": "1",
                "serialNr": "serialNr",
                "bestBefore": 2320,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": "unit",
            "availableAmount": "0",
            "rate": 6413.219830864902,
            "supplierArticleId": "supplierArticleId",
            "purchasePriceShipment": "0",
            "id": 7726,
            "orderedAmount": "0",
            "stock": true,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits",
            "stockWarning": "0"
        }],
        "poReference": "poReference"
    }],
    "page": 7862
}

Add customer order

POSTUrl:

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Add a new customer order

Body:

CustomerOrder

{
    "freight": 8619.716147797673,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 1163.2100821962354,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 2709.1107157237325,
        "costCenter": 7367,
        "articleId": "articleId",
        "discount": "0",
        "description": "description",
        "weight": 994.6875665938315,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 7114.173656817624,
        "availableAmount": 8068.733990887567,
        "rowIndex": 4334,
        "discountType": "AMOUNT",
        "id": 4552,
        "orderedAmount": 9021.819738223756,
        "stockWarning": 9965.583728790107
    }],
    "ourReference": "ourReference",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 5065,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846049,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 466,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "currencyRate": 299.6399268528116,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846049,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Successfull response:

CustomerOrder

{
    "orderId": 2934,
    "totalPrice": 9491.18547920403,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 9888.526843222235,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 4045.3196173736596,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 3244.90412088673,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 8587.769824529745,
        "costCenter": 6964,
        "articleId": "articleId",
        "vat": 1977.232730160342,
        "discount": "0",
        "description": "description",
        "weight": 5803.41744639538,
        "storeId": 8766,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846055,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 1508.7496815600944,
        "tg": 9539.464259747358,
        "availableAmount": 4295.892183872642,
        "storeGroupId": 8285,
        "rowIndex": 809,
        "discountType": "AMOUNT",
        "id": 1431,
        "orderedAmount": 7356.849734931618,
        "stockWarning": 4749.218861273988
    }],
    "deliveredDate": 1732182846054,
    "ourReference": "ourReference",
    "storeGroupId": 7915,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 5775,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846054,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 3298,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 9510.26389105191,
    "currencyRate": 6901.2814446007405,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846054,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 4208,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Add row to customer order

POSTUrl: /{id}/product

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Add article or textrow to an existing customer order

Body:

CustomerOrderProduct

{
    "deliveredAmount": "0",
    "isBundled": true,
    "totalPrice": 5043.07152948368,
    "costCenter": 9880,
    "articleId": "articleId",
    "discount": "0",
    "description": "description",
    "weight": 9131.961181064022,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "pickedAmount": "0",
    "piecePrice": 5494.580340004071,
    "availableAmount": 8502.355174552147,
    "rowIndex": 9214,
    "discountType": "AMOUNT",
    "id": 2614,
    "orderedAmount": 6755.476656410856,
    "stockWarning": 20.4322981863736
}

Successfull response:

CustomerOrder

{
    "orderId": 873,
    "totalPrice": 5005.539973919474,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 2262.549522713406,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 7114.5266798031325,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 8962.358458968883,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 1911.3591188110167,
        "costCenter": 3812,
        "articleId": "articleId",
        "vat": 1531.1573842091952,
        "discount": "0",
        "description": "description",
        "weight": 3754.70740336479,
        "storeId": 6828,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846069,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 2637.115964372039,
        "tg": 2139.66713779863,
        "availableAmount": 1201.6995766316306,
        "storeGroupId": 125,
        "rowIndex": 9631,
        "discountType": "AMOUNT",
        "id": 9697,
        "orderedAmount": 7869.684618588284,
        "stockWarning": 9888.533177475309
    }],
    "deliveredDate": 1732182846069,
    "ourReference": "ourReference",
    "storeGroupId": 1911,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 6832,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846069,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 2856,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 3473.9075640242636,
    "currencyRate": 5163.22019035579,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846069,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 5050,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Create drop shipment

POSTUrl: /{order_id}/dropshipment

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Create drop shipment for this customer order. One or more purchase orders will be connected with content from this customer order. The customer order will be moved to drop shipment state

Valid parameters:

Parameter	Description	Default value	Allowed values
is_dropshipment	if flag is false, purchase orders are created with content matching the customer order. If flag is true (default value) the picking lists for customer order is removed and the order is marked as drop shipment	true

Body:

Successfull response:

PurchaseOrdersResponse

{
    "ordersCount": 775,
    "pages": 6641,
    "pageSize": 3504,
    "orders": [{
        "paymentTermsDescription": "paymentTermsDescription",
        "deliveryPhone": "deliveryPhone",
        "supplierOrderId": "supplierOrderId",
        "supplierId": 1699,
        "productionOrderId": 1592,
        "deliveryTermsDescription": "deliveryTermsDescription",
        "customerOrderId": 7012,
        "contactPerson": "contactPerson",
        "deliveryZip": "deliveryZip",
        "productCount": 4203,
        "orderValue": 3353.8007057207565,
        "confirmedDeliveryDate": 1732182846071,
        "externalInvoiceReference": "externalInvoiceReference",
        "orderValueCurrency": "orderValueCurrency",
        "deliveredDate": 1732182846071,
        "deliveryAddress": "deliveryAddress",
        "orderSentDate": 1732182846071,
        "deliveryContact": "deliveryContact",
        "id": 9704,
        "state": 596,
        "deliveryDate": 1732182846071,
        "paymentTerms": "paymentTerms",
        "supplierName": "supplierName",
        "deliveryCity": "deliveryCity",
        "deliveryTerms": "deliveryTerms",
        "goodsMarking": "goodsMarking",
        "contactEmail": "contactEmail",
        "isPickNPack": "false",
        "deliveryAddress2": "deliveryAddress2",
        "orderValueStore": 6023.781286679305,
        "storeId": 7190,
        "deliveryCompany": "deliveryCompany",
        "message": "message",
        "deliveryCountry": "deliveryCountry",
        "comment": "comment",
        "articles": [{
            "deliveredAmount": "0",
            "articleName": "articleName",
            "purchasePriceMisc": "0",
            "barcodeType": "EAN",
            "articleId": "articleId",
            "description": "description",
            "purchasePrice": "0",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 3213
                },
                "articleId": "articleId",
                "storegroupId": 4422,
                "convert": 1860.3635995138468,
                "barcode": "barcode"
            }],
            "type": "type",
            "batches": [{
                "deliveredAmount": "1",
                "serialNr": "serialNr",
                "bestBefore": 9951,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": "unit",
            "availableAmount": "0",
            "rate": 6298.419902281224,
            "supplierArticleId": "supplierArticleId",
            "purchasePriceShipment": "0",
            "id": 2529,
            "orderedAmount": "0",
            "stock": false,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits",
            "stockWarning": "0"
        }],
        "poReference": "poReference"
    }],
    "page": 2780
}

Packed order

PUTUrl: /{order_id}/packed

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to packed

Valid parameters:

Parameter	Description	Default value	Allowed values
finish_pickinglists		false	true,false
create_rest_order		false	true,false

Body:

Successfull response:

CustomerOrder

{
    "orderId": 3250,
    "totalPrice": 2183.1254345092398,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 9553.74622850908,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 566.3234695995856,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 7587.945185131991,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 9876.345454103968,
        "costCenter": 4225,
        "articleId": "articleId",
        "vat": 9507.61703073458,
        "discount": "0",
        "description": "description",
        "weight": 6842.408021484698,
        "storeId": 563,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846083,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 8417.234810205202,
        "tg": 3854.700223566447,
        "availableAmount": 3235.009144977079,
        "storeGroupId": 5117,
        "rowIndex": 2634,
        "discountType": "AMOUNT",
        "id": 8104,
        "orderedAmount": 169.56337503793773,
        "stockWarning": 345.3519158991958
    }],
    "deliveredDate": 1732182846083,
    "ourReference": "ourReference",
    "storeGroupId": 7746,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 3788,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846083,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 9207,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 8207.644678049748,
    "currencyRate": 5421.168384126548,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846083,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 3807,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Order delivered

PUTUrl: /{order_id}/delivered

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to delivered. This can only be done for sent or freight booked orders

Body:

Successfull response:

CustomerOrder

{
    "orderId": 4461,
    "totalPrice": 9073.849052555008,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 4259.160614844174,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 1637.8513464968303,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 8276.108174022122,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 9972.379992540646,
        "costCenter": 4967,
        "articleId": "articleId",
        "vat": 7362.600642524825,
        "discount": "0",
        "description": "description",
        "weight": 3992.1166296782417,
        "storeId": 4801,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846090,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 4324.027974238269,
        "tg": 2428.1450398932416,
        "availableAmount": 1363.42932703438,
        "storeGroupId": 8053,
        "rowIndex": 7773,
        "discountType": "AMOUNT",
        "id": 7044,
        "orderedAmount": 1399.1683672198963,
        "stockWarning": 8774.200718077149
    }],
    "deliveredDate": 1732182846090,
    "ourReference": "ourReference",
    "storeGroupId": 1056,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 9705,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846090,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 3625,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 8067.789239504138,
    "currencyRate": 7715.104884964742,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846090,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 3041,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Send order

PUTUrl: /{order_id}/send

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to sent

Valid parameters:

Parameter	Description	Default value	Allowed values
finish_pickinglists		false	true,false
create_rest_order		false	true,false

Body:

Successfull response:

CustomerOrder

{
    "orderId": 9818,
    "totalPrice": 1191.1231633756092,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 194.01990891668385,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 4792.394388230578,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 5895.304865010432,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 9514.093946937079,
        "costCenter": 3404,
        "articleId": "articleId",
        "vat": 4833.874403750769,
        "discount": "0",
        "description": "description",
        "weight": 8471.945525281799,
        "storeId": 621,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846092,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 5767.484408980396,
        "tg": 6845.859011684879,
        "availableAmount": 503.1909901036735,
        "storeGroupId": 7196,
        "rowIndex": 7405,
        "discountType": "AMOUNT",
        "id": 2050,
        "orderedAmount": 1442.9833619668009,
        "stockWarning": 5358.95244388948
    }],
    "deliveredDate": 1732182846092,
    "ourReference": "ourReference",
    "storeGroupId": 8827,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 8369,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846092,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 6809,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 2764.561295902722,
    "currencyRate": 6748.480132361409,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846092,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 7960,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Invoice order

PUTUrl: /{order_id}/invoice

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to invoiced. If store is connected to an integration with support for invoicing an invoice will be created thru that integration (For example Fortnox)

Valid parameters:

Parameter	Description	Default value	Allowed values
type		invoice	invoice, cash, card, ag

Body:

Successfull response:

CustomerOrder

{
    "orderId": 5897,
    "totalPrice": 174.85697888941053,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 5374.190271242101,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 7808.841131078937,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 5609.194357535432,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 1070.7830866758438,
        "costCenter": 2328,
        "articleId": "articleId",
        "vat": 3977.9596560527384,
        "discount": "0",
        "description": "description",
        "weight": 6105.453831666805,
        "storeId": 7047,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846098,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 2557.618958833997,
        "tg": 8129.854666607841,
        "availableAmount": 1321.250190726937,
        "storeGroupId": 7426,
        "rowIndex": 1414,
        "discountType": "AMOUNT",
        "id": 735,
        "orderedAmount": 7644.871233437632,
        "stockWarning": 7234.561843334049
    }],
    "deliveredDate": 1732182846098,
    "ourReference": "ourReference",
    "storeGroupId": 4907,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 746,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846098,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 3612,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 7393.394533368105,
    "currencyRate": 3694.6385789949986,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846098,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 1100,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Ready for packing

PUTUrl: /{order_id}/ready_for_packing

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to ready for packing. Picking lists will be created for the order

Body:

Successfull response:

CustomerOrder

{
    "orderId": 1922,
    "totalPrice": 5810.4635053751745,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 3943.20427552026,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 9775.894430164339,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 6951.821040321988,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 2253.002850176322,
        "costCenter": 1958,
        "articleId": "articleId",
        "vat": 4038.0414267448873,
        "discount": "0",
        "description": "description",
        "weight": 5209.674365190504,
        "storeId": 1471,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846101,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 5743.17833842331,
        "tg": 4074.6959805959314,
        "availableAmount": 8144.610815595144,
        "storeGroupId": 3317,
        "rowIndex": 3423,
        "discountType": "AMOUNT",
        "id": 1817,
        "orderedAmount": 6407.695918904932,
        "stockWarning": 6057.749551572577
    }],
    "deliveredDate": 1732182846101,
    "ourReference": "ourReference",
    "storeGroupId": 9433,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 5637,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846101,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 2296,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 3572.648351971259,
    "currencyRate": 8153.426031284603,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846101,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 3403,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Ready for packing multiple orders

PUTUrl: /ready_for_packing

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of multiple customer orders to ready for packing. Picking lists will be created for the orders.

Body:

CustomerOrderRequest

{}

Successfull response:

CustomerOrder

{
    "orderId": 7123,
    "totalPrice": 8074.032284103087,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 775.3240636285208,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 3140.4561048335377,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 2519.435099267947,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 5301.462632460016,
        "costCenter": 893,
        "articleId": "articleId",
        "vat": 9004.892591269394,
        "discount": "0",
        "description": "description",
        "weight": 6544.027717189737,
        "storeId": 7685,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846109,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 7386.449819009613,
        "tg": 2701.214103399161,
        "availableAmount": 4240.36392704357,
        "storeGroupId": 275,
        "rowIndex": 3201,
        "discountType": "AMOUNT",
        "id": 8248,
        "orderedAmount": 7125.285631134902,
        "stockWarning": 3050.6536235351114
    }],
    "deliveredDate": 1732182846108,
    "ourReference": "ourReference",
    "storeGroupId": 4405,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 92,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846108,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 9151,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 3527.575118336348,
    "currencyRate": 3577.7854532741903,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846108,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 3487,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Cancel order

PUTUrl: /{order_id}/cancel

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to cancelled. After this the order is closed and cannot be updated again

Body:

Successfull response:

CustomerOrder

{
    "orderId": 7296,
    "totalPrice": 4831.515789785071,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 944.6048991402922,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 3430.817840228355,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 6607.536797379809,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 3812.96834349258,
        "costCenter": 7611,
        "articleId": "articleId",
        "vat": 3685.883470142819,
        "discount": "0",
        "description": "description",
        "weight": 9375.573444683621,
        "storeId": 3711,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846112,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 6626.030814663823,
        "tg": 6828.048015396401,
        "availableAmount": 4951.47682402152,
        "storeGroupId": 24,
        "rowIndex": 9132,
        "discountType": "AMOUNT",
        "id": 60,
        "orderedAmount": 2760.8982870967848,
        "stockWarning": 8442.786844682207
    }],
    "deliveredDate": 1732182846112,
    "ourReference": "ourReference",
    "storeGroupId": 2610,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 7688,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846112,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 1520,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 3326.3788999695607,
    "currencyRate": 6090.137000972412,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846112,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 1364,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Cancel drop shipment

PUTUrl: /{order_id}/dropshipment/cancel

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Cancel drop shipment purchase orders for this customer order and reset customer order state to ready for packing

Body:

Successfull response:

CustomerOrder

{
    "orderId": 6951,
    "totalPrice": 4320.058110691426,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 2676.2494744477394,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 2951.4694605170534,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 3171.5804681170603,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 5170.361723852789,
        "costCenter": 9693,
        "articleId": "articleId",
        "vat": 1507.2726182546469,
        "discount": "0",
        "description": "description",
        "weight": 6046.54830313919,
        "storeId": 1691,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846117,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 3400.336630577494,
        "tg": 1525.9841735287328,
        "availableAmount": 762.9434332882568,
        "storeGroupId": 5040,
        "rowIndex": 2483,
        "discountType": "AMOUNT",
        "id": 3847,
        "orderedAmount": 7404.628712715086,
        "stockWarning": 9944.077131630114
    }],
    "deliveredDate": 1732182846117,
    "ourReference": "ourReference",
    "storeGroupId": 8119,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 2294,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846117,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 520,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 1224.8816494434222,
    "currencyRate": 318.49121106182764,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846117,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 7416,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Invoice multiple order

PUTUrl: /invoice

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of multiple customer orders to invoiced. If store is connected to an integration with support for invoicing an invoice will be created thru that integration (For example Fortnox)

Valid parameters:

Parameter	Description	Default value	Allowed values
type		invoice	invoice, cash, card, ag

Body:

CustomerOrderRequest

{}

Successfull response:

CustomerOrdersResponse

{
    "ordersCount": 8815,
    "pages": 4716,
    "totalCustomerOrderValue": 2040.8816417063967,
    "pageSize": 6953,
    "orders": [{
        "orderId": 7624,
        "totalPrice": 1917.7605485087356,
        "paymentTermDesc": "paymentTermDesc",
        "freight": 7068.896787598049,
        "phone2": "phone2",
        "deliveryEmail": "deliveryEmail",
        "administrationFee": 8035.302596068474,
        "webshopOrderId": "webshopOrderId",
        "customerOrderNumber": "customerOrderNumber",
        "orderValue": 9324.384989788605,
        "phone1": "phone1",
        "products": [{
            "deliveredAmount": "0",
            "isBundled": false,
            "totalPrice": 8233.00459919087,
            "costCenter": 8176,
            "articleId": "articleId",
            "vat": 572.328009094506,
            "discount": "0",
            "description": "description",
            "weight": 3859.355836978434,
            "storeId": 848,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846120,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "pickedAmount": "0",
            "piecePrice": 6021.030348676682,
            "tg": 4795.435495435841,
            "availableAmount": 6563.958589553017,
            "storeGroupId": 5,
            "rowIndex": 6372,
            "discountType": "AMOUNT",
            "id": 230,
            "orderedAmount": 3050.776210929046,
            "stockWarning": 1421.2779955085387
        }],
        "deliveredDate": 1732182846119,
        "ourReference": "ourReference",
        "storeGroupId": 7944,
        "deliveryTermDesc": "deliveryTermDesc",
        "deliveryZipCode": "deliveryZipCode",
        "wayOfDelivery": "wayOfDelivery",
        "customerId": 6551,
        "currency": "currency",
        "state": "0",
        "deliveryDate": 1732182846119,
        "deliveryCity": "deliveryCity",
        "comments": "comments",
        "yourReference": "yourReference",
        "pricelistId": "-1",
        "deliveryTerm": "deliveryTerm",
        "costCenter": 6523,
        "deliveryAddress2": "deliveryAddress2",
        "externalOrderId": "externalOrderId",
        "deliveryAddress1": "deliveryAddress1",
        "wayOfDeliveryDesc": "wayOfDeliveryDesc",
        "customerName": "customerName",
        "externalInvoiceReference1": "externalInvoiceReference1",
        "externalInvoiceReference2": "externalInvoiceReference2",
        "deliveryCountry": "deliveryCountry",
        "vatIncluded": "true",
        "totalDiscount": 7808.6174325043485,
        "currencyRate": 8233.62861187845,
        "deliveryName": "deliveryName",
        "orderDate": 1732182846119,
        "paymentTerm": "paymentTerm",
        "remarks": "remarks",
        "deliveryStatus": 3482,
        "externalDisplayOrderId": "externalDisplayOrderId"
    }],
    "page": 4117,
    "since": 3933
}

Order freight booked

PUTUrl: /{order_id}/freight_booked

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of customer order to freight booked

Body:

Successfull response:

CustomerOrder

{
    "orderId": 2933,
    "totalPrice": 7842.116824896632,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 1397.6397837105858,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 843.0575179621958,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 8430.983248100556,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 8023.490523474431,
        "costCenter": 471,
        "articleId": "articleId",
        "vat": 5461.411725676359,
        "discount": "0",
        "description": "description",
        "weight": 2454.321576483015,
        "storeId": 1808,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846124,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 2196.1408583687203,
        "tg": 666.4171099141003,
        "availableAmount": 2363.6589773517235,
        "storeGroupId": 8653,
        "rowIndex": 9455,
        "discountType": "AMOUNT",
        "id": 4665,
        "orderedAmount": 4881.720164567906,
        "stockWarning": 4691.172575049747
    }],
    "deliveredDate": 1732182846124,
    "ourReference": "ourReference",
    "storeGroupId": 5576,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 9031,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846124,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 5443,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 3831.9981543216263,
    "currencyRate": 2735.9875226092754,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846124,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 7488,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Send multiple order

PUTUrl: /send

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of multiple customer order to sent

Valid parameters:

Parameter	Description	Default value	Allowed values
finish_pickinglists		false	true,false
create_rest_order		false	true,false

Body:

CustomerOrderRequest

{}

Successfull response:

CustomerOrder

{
    "orderId": 8478,
    "totalPrice": 474.11971108261343,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 2611.749101026263,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 4483.064005995794,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 9031.395992167067,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 7453.240008156633,
        "costCenter": 6016,
        "articleId": "articleId",
        "vat": 8796.93885274848,
        "discount": "0",
        "description": "description",
        "weight": 969.2509787958614,
        "storeId": 1970,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846130,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 2850.8898478590904,
        "tg": 9995.52174354193,
        "availableAmount": 4796.651641724428,
        "storeGroupId": 8587,
        "rowIndex": 8680,
        "discountType": "AMOUNT",
        "id": 3705,
        "orderedAmount": 3600.529599511513,
        "stockWarning": 3380.9678507714802
    }],
    "deliveredDate": 1732182846130,
    "ourReference": "ourReference",
    "storeGroupId": 3958,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 1509,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846130,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 2864,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 273.28863095320787,
    "currencyRate": 2533.064133653464,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846130,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 6655,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Update customer order

PUTUrl: /{id}

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update an existing customer order. Be aware that state cannot be updated thru this request. Use one of the Invoice, Cancel, Ready for packing-methods to update state. Also be aware if the order has been invoiced that the only fields that can be updated are externalInvoiceReference1 and externalInvoiceReference2, all other fields are ignored.

Body:

CustomerOrder

{
    "orderId": 5531,
    "totalPrice": 6740.55377071931,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 3258.4960939070675,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 627.151564295011,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 6713.908650104714,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 1172.1127184535385,
        "costCenter": 81,
        "articleId": "articleId",
        "vat": 6133.115587774324,
        "discount": "0",
        "description": "description",
        "weight": 8884.570435196356,
        "storeId": 1045,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846138,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 6987.909524241682,
        "tg": 4097.762130274885,
        "availableAmount": 6283.614484733632,
        "storeGroupId": 4259,
        "rowIndex": 583,
        "discountType": "AMOUNT",
        "id": 2650,
        "orderedAmount": 9643.277374656243,
        "stockWarning": 9934.099730253158
    }],
    "deliveredDate": 1732182846138,
    "ourReference": "ourReference",
    "storeGroupId": 1301,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 129,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846138,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 1495,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 5684.732744581904,
    "currencyRate": 7114.925655872624,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846138,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 9676,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Successfull response:

CustomerOrder

{
    "orderId": 5223,
    "totalPrice": 8061.948255266089,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 9062.868014393092,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 6572.530722103189,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 772.5877573979178,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": true,
        "totalPrice": 816.4740612975663,
        "costCenter": 7143,
        "articleId": "articleId",
        "vat": 4372.282171305673,
        "discount": "0",
        "description": "description",
        "weight": 3034.9297483890605,
        "storeId": 4358,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846139,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 8110.539245955513,
        "tg": 7953.084162322293,
        "availableAmount": 5786.324941654685,
        "storeGroupId": 6934,
        "rowIndex": 7783,
        "discountType": "AMOUNT",
        "id": 3915,
        "orderedAmount": 2954.879640799979,
        "stockWarning": 7521.26189168754
    }],
    "deliveredDate": 1732182846138,
    "ourReference": "ourReference",
    "storeGroupId": 9993,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 7952,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846138,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 2005,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 3486.5292471212306,
    "currencyRate": 1586.7609564822205,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846138,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 1147,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Update row in customer order

PUTUrl: /{id}/product

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update existing article or textrow in an existing customer order based on row index

Body:

CustomerOrderProduct

{
    "deliveredAmount": "0",
    "isBundled": true,
    "totalPrice": 3790.9670219616087,
    "costCenter": 5349,
    "articleId": "articleId",
    "vat": 1945.293617522994,
    "discount": "0",
    "description": "description",
    "weight": 2104.9916609330144,
    "storeId": 3795,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846144,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "pickedAmount": "0",
    "piecePrice": 2878.217271350171,
    "tg": 5797.269836773788,
    "availableAmount": 8167.924713289269,
    "storeGroupId": 3853,
    "rowIndex": 1092,
    "discountType": "AMOUNT",
    "id": 8026,
    "orderedAmount": 6292.329041495845,
    "stockWarning": 1262.2355935920582
}

Successfull response:

CustomerOrder

{
    "orderId": 3637,
    "totalPrice": 293.47016126840765,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 3111.9523361070947,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 4005.800257485147,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 4847.831194122142,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 3880.89275031715,
        "costCenter": 5645,
        "articleId": "articleId",
        "vat": 1913.683078625663,
        "discount": "0",
        "description": "description",
        "weight": 5727.559902526393,
        "storeId": 7686,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846144,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 4240.22008758233,
        "tg": 2181.222844808839,
        "availableAmount": 443.72278893686223,
        "storeGroupId": 9752,
        "rowIndex": 9647,
        "discountType": "AMOUNT",
        "id": 3416,
        "orderedAmount": 3313.3119660162424,
        "stockWarning": 7689.230687462848
    }],
    "deliveredDate": 1732182846144,
    "ourReference": "ourReference",
    "storeGroupId": 8732,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 7613,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846144,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 33,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 4817.0120534801035,
    "currencyRate": 7535.82284818117,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846144,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 3356,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Remove row in customer order

PUTUrl: /{id}/product/remove

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Remove existing article or textrow in an existing customer order based on row index

Body:

CustomerOrderProduct

{
    "deliveredAmount": "0",
    "isBundled": false,
    "totalPrice": 4633.759069533396,
    "costCenter": 2905,
    "articleId": "articleId",
    "vat": 2836.123422126021,
    "discount": "0",
    "description": "description",
    "weight": 4672.333781052872,
    "storeId": 6342,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846148,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "pickedAmount": "0",
    "piecePrice": 5056.064486951942,
    "tg": 6448.757331823965,
    "availableAmount": 6132.540416184228,
    "storeGroupId": 796,
    "rowIndex": 188,
    "discountType": "AMOUNT",
    "id": 5258,
    "orderedAmount": 7150.143298469425,
    "stockWarning": 8379.069467485984
}

Successfull response:

CustomerOrder

{
    "orderId": 4642,
    "totalPrice": 8375.183871213243,
    "paymentTermDesc": "paymentTermDesc",
    "freight": 427.00282076841734,
    "phone2": "phone2",
    "deliveryEmail": "deliveryEmail",
    "administrationFee": 6166.108192848981,
    "webshopOrderId": "webshopOrderId",
    "customerOrderNumber": "customerOrderNumber",
    "orderValue": 1276.9087551164005,
    "phone1": "phone1",
    "products": [{
        "deliveredAmount": "0",
        "isBundled": false,
        "totalPrice": 3268.7720878324235,
        "costCenter": 5656,
        "articleId": "articleId",
        "vat": 8796.381217110882,
        "discount": "0",
        "description": "description",
        "weight": 8643.331505235088,
        "storeId": 1943,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846149,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "pickedAmount": "0",
        "piecePrice": 5270.64662917182,
        "tg": 1331.6317714681559,
        "availableAmount": 2336.477869845766,
        "storeGroupId": 5124,
        "rowIndex": 6609,
        "discountType": "AMOUNT",
        "id": 9495,
        "orderedAmount": 9825.510061702123,
        "stockWarning": 9541.156547503962
    }],
    "deliveredDate": 1732182846148,
    "ourReference": "ourReference",
    "storeGroupId": 4939,
    "deliveryTermDesc": "deliveryTermDesc",
    "deliveryZipCode": "deliveryZipCode",
    "wayOfDelivery": "wayOfDelivery",
    "customerId": 1492,
    "currency": "currency",
    "state": "0",
    "deliveryDate": 1732182846148,
    "deliveryCity": "deliveryCity",
    "comments": "comments",
    "yourReference": "yourReference",
    "pricelistId": "-1",
    "deliveryTerm": "deliveryTerm",
    "costCenter": 2127,
    "deliveryAddress2": "deliveryAddress2",
    "externalOrderId": "externalOrderId",
    "deliveryAddress1": "deliveryAddress1",
    "wayOfDeliveryDesc": "wayOfDeliveryDesc",
    "customerName": "customerName",
    "externalInvoiceReference1": "externalInvoiceReference1",
    "externalInvoiceReference2": "externalInvoiceReference2",
    "deliveryCountry": "deliveryCountry",
    "vatIncluded": "true",
    "totalDiscount": 1269.501420611151,
    "currencyRate": 5440.320657234903,
    "deliveryName": "deliveryName",
    "orderDate": 1732182846148,
    "paymentTerm": "paymentTerm",
    "remarks": "remarks",
    "deliveryStatus": 96,
    "externalDisplayOrderId": "externalDisplayOrderId"
}

Send confirmation

PUTUrl: /{order_id}/confirmation/send

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Send confirmation of customer order with a confirmation pdf

Body:

Email

{"email": "email"}

Successfull response:

Invoice

Get invoice file

GETUrl: /{id}/invoice/print

Headers:

Accept: application/pdf or application/json

Get invoice binary file by id

Body:

Successfull response:

byte[]

{}

Offers

Get offers

GETUrl: /offers

Headers:

Accept: application/json or application/xml

Get a list of offers

Valid parameters:

Parameter	Description	Default value	Allowed values
since		0
state	-1=ALL, 0=NEW, 1=APPROVED, 2=CANCELLED	-1	-1,0,1,2
page		0
limit		50
query
sort_column		id	id,customer,valid_date,created_date,state
order		desc	asc,desc

Body:

Successfull response:

OffersResponse

{
    "offers": [{
        "pricelistId": 7446,
        "validDate": 1732182846152,
        "customerOrderId": 553,
        "description": "description",
        "rows": [{
            "supplierName": "supplierName",
            "amount": 1803.5178779596029,
            "articleName": "articleName",
            "supplierId": 8118,
            "totalPrice": 7152.6207381255,
            "salesPrice": 9570.66656955853,
            "articleId": "articleId",
            "discount": "0",
            "purchasePrice": 8971.927271533636,
            "storeId": 516,
            "purchaseCurrency": "purchaseCurrency",
            "unit": "unit",
            "purchaseRate": 3314.9805608836814,
            "unitId": 8379,
            "discountType": "AMOUNT",
            "id": 9836
        }],
        "customerName": "customerName",
        "ourReference": "ourReference",
        "customerPhone": "customerPhone",
        "createdDate": 1732182846152,
        "rate": 1233.9966899354793,
        "customerEmail": "customerEmail",
        "customerId": 6794,
        "offerId": 1140,
        "currency": "currency",
        "state": 6550
    }],
    "pages": 3882,
    "offersCount": 9013,
    "pageSize": 7935,
    "page": 7321,
    "since": 3683
}

Get offer

GETUrl: /offers/{offer_id}

Headers:

Accept: application/json or application/xml

Get offer by id

Body:

Successfull response:

OffersResponse

{
    "offers": [{
        "pricelistId": 5814,
        "validDate": 1732182846172,
        "customerOrderId": 2131,
        "description": "description",
        "rows": [{
            "supplierName": "supplierName",
            "amount": 9983.981519516245,
            "articleName": "articleName",
            "supplierId": 6753,
            "totalPrice": 6540.1819683227095,
            "salesPrice": 8211.99951950013,
            "articleId": "articleId",
            "discount": "0",
            "purchasePrice": 6828.385142939875,
            "storeId": 2078,
            "purchaseCurrency": "purchaseCurrency",
            "unit": "unit",
            "purchaseRate": 9408.529601856759,
            "unitId": 1400,
            "discountType": "AMOUNT",
            "id": 7366
        }],
        "customerName": "customerName",
        "ourReference": "ourReference",
        "customerPhone": "customerPhone",
        "createdDate": 1732182846172,
        "rate": 6419.242409811967,
        "customerEmail": "customerEmail",
        "customerId": 4375,
        "offerId": 4780,
        "currency": "currency",
        "state": 7457
    }],
    "pages": 7076,
    "offersCount": 2790,
    "pageSize": 8821,
    "page": 7537,
    "since": 7544
}

Print offer

GETUrl: /offers/{offer_id}/print

Headers:

Accept: application/pdf or application/json

Print offer based on order id

Body:

Successfull response:

byte[]

{}

Get offer for customer order

GETUrl: /{order_id}/offers

Headers:

Accept: application/json or application/xml

Get offer for a chosen customer order

Body:

Successfull response:

OffersResponse

{
    "offers": [{
        "pricelistId": 9162,
        "validDate": 1732182846175,
        "customerOrderId": 5474,
        "description": "description",
        "rows": [{
            "supplierName": "supplierName",
            "amount": 4014.6857523975286,
            "articleName": "articleName",
            "supplierId": 5365,
            "totalPrice": 2329.572241872202,
            "salesPrice": 633.6409336536386,
            "articleId": "articleId",
            "discount": "0",
            "purchasePrice": 1642.8659743618114,
            "storeId": 8817,
            "purchaseCurrency": "purchaseCurrency",
            "unit": "unit",
            "purchaseRate": 8664.35956566868,
            "unitId": 5101,
            "discountType": "AMOUNT",
            "id": 214
        }],
        "customerName": "customerName",
        "ourReference": "ourReference",
        "customerPhone": "customerPhone",
        "createdDate": 1732182846175,
        "rate": 3207.0980512723268,
        "customerEmail": "customerEmail",
        "customerId": 4135,
        "offerId": 2161,
        "currency": "currency",
        "state": 9994
    }],
    "pages": 6921,
    "offersCount": 7316,
    "pageSize": 154,
    "page": 9835,
    "since": 1935
}

Add offer

POSTUrl: /offers

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Add a new offer

Body:

Offer

{
    "ourReference": "ourReference",
    "customerPhone": "customerPhone",
    "pricelistId": 5289,
    "validDate": 1732182846182,
    "customerEmail": "customerEmail",
    "customerId": 2908,
    "description": "description",
    "currency": "currency",
    "rows": [{
        "supplierName": "supplierName",
        "amount": 7723.164556128578,
        "articleName": "articleName",
        "supplierId": 6989,
        "salesPrice": 7932.183052011944,
        "articleId": "articleId",
        "discount": "0",
        "discountType": "AMOUNT",
        "id": 164,
        "purchasePrice": 1593.7811657053435,
        "purchaseCurrency": "purchaseCurrency"
    }],
    "customerName": "customerName"
}

Successfull response:

Offer

{
    "pricelistId": 2411,
    "validDate": 1732182846183,
    "customerOrderId": 4015,
    "description": "description",
    "rows": [{
        "supplierName": "supplierName",
        "amount": 1788.9944939680013,
        "articleName": "articleName",
        "supplierId": 7163,
        "totalPrice": 7891.047965888952,
        "salesPrice": 5528.063279705052,
        "articleId": "articleId",
        "discount": "0",
        "purchasePrice": 4088.046126165631,
        "storeId": 4227,
        "purchaseCurrency": "purchaseCurrency",
        "unit": "unit",
        "purchaseRate": 7610.354750361422,
        "unitId": 3240,
        "discountType": "AMOUNT",
        "id": 8292
    }],
    "customerName": "customerName",
    "ourReference": "ourReference",
    "customerPhone": "customerPhone",
    "createdDate": 1732182846183,
    "rate": 2845.893040238088,
    "customerEmail": "customerEmail",
    "customerId": 4316,
    "offerId": 7025,
    "currency": "currency",
    "state": 9457
}

Update offer

PUTUrl: /offers/{offer_id}

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update an existing new offer

Body:

Offer

{
    "pricelistId": 8983,
    "validDate": 1732182846184,
    "customerOrderId": 4561,
    "description": "description",
    "rows": [{
        "supplierName": "supplierName",
        "amount": 2648.7809603325154,
        "articleName": "articleName",
        "supplierId": 5239,
        "totalPrice": 267.83711527488816,
        "salesPrice": 3469.5742496145067,
        "articleId": "articleId",
        "discount": "0",
        "purchasePrice": 2073.1451224078846,
        "storeId": 7088,
        "purchaseCurrency": "purchaseCurrency",
        "unit": "unit",
        "purchaseRate": 7554.639653766879,
        "unitId": 785,
        "discountType": "AMOUNT",
        "id": 3330
    }],
    "customerName": "customerName",
    "ourReference": "ourReference",
    "customerPhone": "customerPhone",
    "createdDate": 1732182846184,
    "rate": 530.4284384105817,
    "customerEmail": "customerEmail",
    "customerId": 7829,
    "offerId": 4204,
    "currency": "currency",
    "state": 9399
}

Successfull response:

Offer

{
    "pricelistId": 1052,
    "validDate": 1732182846184,
    "customerOrderId": 956,
    "description": "description",
    "rows": [{
        "supplierName": "supplierName",
        "amount": 5568.755111742447,
        "articleName": "articleName",
        "supplierId": 9246,
        "totalPrice": 1338.3558760962699,
        "salesPrice": 8260.231614237582,
        "articleId": "articleId",
        "discount": "0",
        "purchasePrice": 2166.3293778041816,
        "storeId": 3088,
        "purchaseCurrency": "purchaseCurrency",
        "unit": "unit",
        "purchaseRate": 6358.1718783893,
        "unitId": 6491,
        "discountType": "AMOUNT",
        "id": 1827
    }],
    "customerName": "customerName",
    "ourReference": "ourReference",
    "customerPhone": "customerPhone",
    "createdDate": 1732182846184,
    "rate": 6790.096434128836,
    "customerEmail": "customerEmail",
    "customerId": 477,
    "offerId": 1836,
    "currency": "currency",
    "state": 2744
}

Cancel offer

PUTUrl: /offers/{offer_id}/cancel

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of offer to cancelled. After this the order is closed and cannot be updated again

Body:

Successfull response:

Offer

{
    "pricelistId": 9567,
    "validDate": 1732182846188,
    "customerOrderId": 3537,
    "description": "description",
    "rows": [{
        "supplierName": "supplierName",
        "amount": 905.3991180931997,
        "articleName": "articleName",
        "supplierId": 6576,
        "totalPrice": 8698.388425610634,
        "salesPrice": 8157.8247434317955,
        "articleId": "articleId",
        "discount": "0",
        "purchasePrice": 8692.290224306658,
        "storeId": 3784,
        "purchaseCurrency": "purchaseCurrency",
        "unit": "unit",
        "purchaseRate": 9380.710983602536,
        "unitId": 5222,
        "discountType": "AMOUNT",
        "id": 3246
    }],
    "customerName": "customerName",
    "ourReference": "ourReference",
    "customerPhone": "customerPhone",
    "createdDate": 1732182846188,
    "rate": 1777.4644578522814,
    "customerEmail": "customerEmail",
    "customerId": 6019,
    "offerId": 1566,
    "currency": "currency",
    "state": 3556
}

Approve offer

PUTUrl: /offers/{offer_id}/approve

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update state of offer to approved. After this the order is closed and cannot be updated again

Body:

Successfull response:

Offer

{
    "pricelistId": 5708,
    "validDate": 1732182846210,
    "customerOrderId": 8130,
    "description": "description",
    "rows": [{
        "supplierName": "supplierName",
        "amount": 3486.8921156859546,
        "articleName": "articleName",
        "supplierId": 6533,
        "totalPrice": 8963.2747157014,
        "salesPrice": 759.0485644294309,
        "articleId": "articleId",
        "discount": "0",
        "purchasePrice": 6498.209135849748,
        "storeId": 496,
        "purchaseCurrency": "purchaseCurrency",
        "unit": "unit",
        "purchaseRate": 2416.280644801654,
        "unitId": 5697,
        "discountType": "AMOUNT",
        "id": 6130
    }],
    "customerName": "customerName",
    "ourReference": "ourReference",
    "customerPhone": "customerPhone",
    "createdDate": 1732182846210,
    "rate": 6648.2784004993655,
    "customerEmail": "customerEmail",
    "customerId": 251,
    "offerId": 8275,
    "currency": "currency",
    "state": 9749
}

Send offer

PUTUrl: /offers/{offer_id}/send

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Send offer pdf by email to customer

Body:

Email

{"email": "email"}

Successfull response:

Picking lists

Get pickinglists

GETUrl: /{order_id}/picking_lists

Headers:

Accept: application/json or application/xml

Get pickinglists for customer order

Valid parameters:

Parameter	Description	Default value	Allowed values
sort_column		stock_place	art,stock_place
sort_order		asc

Body:

Successfull response:

PickingListsResponse

{
    "listsCount": 5932,
    "pages": 1448,
    "lists": [{
        "orderComment": "orderComment",
        "orderId": 8213,
        "warehouseWorkerName": "warehouseWorkerName",
        "startedDate": 1732182846220,
        "storeId": 6753,
        "title": "title",
        "customerName": "customerName",
        "products": [{
            "customerOrderProductId": 63,
            "bundled": false,
            "articleId": "articleId",
            "stockPlace": "stockPlace",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 2866
                },
                "articleId": "articleId",
                "storegroupId": 9484,
                "convert": 1453.7423427224328,
                "barcode": "barcode"
            }],
            "stockAmount": 9574.71344962283,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846220,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 7752
            },
            "pickedAmount": 5035.5687130228525,
            "name": "name",
            "parts": [{
                "buyPrice": 7956.78023773146,
                "supplierName": "supplierName",
                "amount": 8225.279198569417,
                "articleName": "articleName",
                "supplierId": 2368,
                "unitName": "unitName",
                "articleId": "articleId",
                "externalId": "externalId",
                "stockPlace": "stockPlace",
                "type": "type",
                "buyPriceCurrency": "buyPriceCurrency",
                "reserved": 5348.4149227461585,
                "buyPriceShipment": 3112.26881596925,
                "buyPriceMisc": 6159.346094902455,
                "supplierArticleId": "supplierArticleId",
                "stock": 5956.738525475582,
                "isStock": false,
                "stockWarning": 8549.189200209488
            }],
            "orderedAmount": 7861.689228847834,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits"
        }],
        "warehouseWorkerId": 6100,
        "id": 6903,
        "state": 6901,
        "deliveryDate": 1732182846220,
        "finishedDate": 1732182846220
    }],
    "pageSize": 7042,
    "page": 9693,
    "since": 9658
}

Get pickinglist

GETUrl: /{order_id}/picking_lists/{list_id}

Headers:

Accept: application/json or application/xml

Get pickinglist for customer order

Valid parameters:

Parameter	Description	Default value	Allowed values
sort_column		stock_place	art, name, stock_place
sort_order		asc

Body:

Successfull response:

PickingListsResponse

{
    "listsCount": 373,
    "pages": 2702,
    "lists": [{
        "orderComment": "orderComment",
        "orderId": 4311,
        "warehouseWorkerName": "warehouseWorkerName",
        "startedDate": 1732182846225,
        "storeId": 7582,
        "title": "title",
        "customerName": "customerName",
        "products": [{
            "customerOrderProductId": 7269,
            "bundled": true,
            "articleId": "articleId",
            "stockPlace": "stockPlace",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 2816
                },
                "articleId": "articleId",
                "storegroupId": 288,
                "convert": 6747.7792724516075,
                "barcode": "barcode"
            }],
            "stockAmount": 2161.1770316657585,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846225,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 6998
            },
            "pickedAmount": 9221.860925659026,
            "name": "name",
            "parts": [{
                "buyPrice": 3523.6374666219594,
                "supplierName": "supplierName",
                "amount": 7763.1849158833875,
                "articleName": "articleName",
                "supplierId": 4134,
                "unitName": "unitName",
                "articleId": "articleId",
                "externalId": "externalId",
                "stockPlace": "stockPlace",
                "type": "type",
                "buyPriceCurrency": "buyPriceCurrency",
                "reserved": 2684.760339921216,
                "buyPriceShipment": 1551.7852016833133,
                "buyPriceMisc": 842.7602744703178,
                "supplierArticleId": "supplierArticleId",
                "stock": 8207.705044878612,
                "isStock": false,
                "stockWarning": 581.8357086080327
            }],
            "orderedAmount": 6222.779560094276,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits"
        }],
        "warehouseWorkerId": 3417,
        "id": 5704,
        "state": 2524,
        "deliveryDate": 1732182846225,
        "finishedDate": 1732182846225
    }],
    "pageSize": 7656,
    "page": 3513,
    "since": 28
}

Get your picking lists

GETUrl: /picking_lists

Headers:

Accept: application/json or application/xml

Get a list of picking lists assigned to you, based on search query

Valid parameters:

Parameter	Description	Default value	Allowed values
query
return_unassigned_lists		true
sort_column		art,stock_place
sort_order		asc

Body:

Successfull response:

PickingListsResponse

{
    "listsCount": 7125,
    "pages": 3658,
    "lists": [{
        "orderComment": "orderComment",
        "orderId": 6254,
        "warehouseWorkerName": "warehouseWorkerName",
        "startedDate": 1732182846228,
        "storeId": 5698,
        "title": "title",
        "customerName": "customerName",
        "products": [{
            "customerOrderProductId": 2612,
            "bundled": false,
            "articleId": "articleId",
            "stockPlace": "stockPlace",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 91
                },
                "articleId": "articleId",
                "storegroupId": 1314,
                "convert": 5226.708264888043,
                "barcode": "barcode"
            }],
            "stockAmount": 7504.757187417686,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846228,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 2838
            },
            "pickedAmount": 5553.871092696716,
            "name": "name",
            "parts": [{
                "buyPrice": 5127.693303427809,
                "supplierName": "supplierName",
                "amount": 3076.72349528614,
                "articleName": "articleName",
                "supplierId": 4736,
                "unitName": "unitName",
                "articleId": "articleId",
                "externalId": "externalId",
                "stockPlace": "stockPlace",
                "type": "type",
                "buyPriceCurrency": "buyPriceCurrency",
                "reserved": 4786.880083616454,
                "buyPriceShipment": 6909.463663979724,
                "buyPriceMisc": 5019.897955260469,
                "supplierArticleId": "supplierArticleId",
                "stock": 6724.194799164158,
                "isStock": false,
                "stockWarning": 3992.328213984713
            }],
            "orderedAmount": 6953.775507757099,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits"
        }],
        "warehouseWorkerId": 8000,
        "id": 4903,
        "state": 7298,
        "deliveryDate": 1732182846228,
        "finishedDate": 1732182846228
    }],
    "pageSize": 7354,
    "page": 5956,
    "since": 2891
}

Get unassigned picking lists

GETUrl: /picking_lists/new

Headers:

Accept: application/json or application/xml

Get a list of all unassigned lists

Valid parameters:

Parameter	Default value	Allowed values
page	0
limit	50
sort_column	stock_place	art,stock_place
sort_order	asc

Body:

Successfull response:

PickingListsResponse

{
    "listsCount": 8697,
    "pages": 613,
    "lists": [{
        "orderComment": "orderComment",
        "orderId": 5493,
        "warehouseWorkerName": "warehouseWorkerName",
        "startedDate": 1732182846235,
        "storeId": 7929,
        "title": "title",
        "customerName": "customerName",
        "products": [{
            "customerOrderProductId": 854,
            "bundled": false,
            "articleId": "articleId",
            "stockPlace": "stockPlace",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 7478
                },
                "articleId": "articleId",
                "storegroupId": 2601,
                "convert": 4644.178415972567,
                "barcode": "barcode"
            }],
            "stockAmount": 9512.020116737272,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846236,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 4675
            },
            "pickedAmount": 1445.5656552920616,
            "name": "name",
            "parts": [{
                "buyPrice": 5519.140046833368,
                "supplierName": "supplierName",
                "amount": 7536.139149671667,
                "articleName": "articleName",
                "supplierId": 3644,
                "unitName": "unitName",
                "articleId": "articleId",
                "externalId": "externalId",
                "stockPlace": "stockPlace",
                "type": "type",
                "buyPriceCurrency": "buyPriceCurrency",
                "reserved": 38.62580461049036,
                "buyPriceShipment": 7515.018197433297,
                "buyPriceMisc": 3580.710432112595,
                "supplierArticleId": "supplierArticleId",
                "stock": 258.2120583887193,
                "isStock": true,
                "stockWarning": 5680.3758983304
            }],
            "orderedAmount": 5988.320904239438,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits"
        }],
        "warehouseWorkerId": 9222,
        "id": 5041,
        "state": 4951,
        "deliveryDate": 1732182846235,
        "finishedDate": 1732182846235
    }],
    "pageSize": 8595,
    "page": 4628,
    "since": 6002
}

Get assigned picking lists

GETUrl: /picking_lists/assigned

Headers:

Accept: application/json or application/xml

Get a list of all assigned lists

Valid parameters:

Parameter	Description	Default value
page		0
limit		50
filter_your_lists	If set to true pickinglists assigned to logged in user is filtered out	false

Body:

Successfull response:

PickingListsResponse

{
    "listsCount": 3535,
    "pages": 8067,
    "lists": [{
        "orderComment": "orderComment",
        "orderId": 4125,
        "warehouseWorkerName": "warehouseWorkerName",
        "startedDate": 1732182846240,
        "storeId": 5974,
        "title": "title",
        "customerName": "customerName",
        "products": [{
            "customerOrderProductId": 1539,
            "bundled": true,
            "articleId": "articleId",
            "stockPlace": "stockPlace",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 8818
                },
                "articleId": "articleId",
                "storegroupId": 1809,
                "convert": 8804.731747586073,
                "barcode": "barcode"
            }],
            "stockAmount": 9864.778537027285,
            "batches": [{
                "deliveredAmount": "0",
                "serialNr": "serialNr",
                "pickedAmount": "0",
                "bestBefore": 1732182846240,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 8705
            },
            "pickedAmount": 6356.871453948534,
            "name": "name",
            "parts": [{
                "buyPrice": 9763.833682083528,
                "supplierName": "supplierName",
                "amount": 8243.235401048203,
                "articleName": "articleName",
                "supplierId": 6450,
                "unitName": "unitName",
                "articleId": "articleId",
                "externalId": "externalId",
                "stockPlace": "stockPlace",
                "type": "type",
                "buyPriceCurrency": "buyPriceCurrency",
                "reserved": 7149.6548160598995,
                "buyPriceShipment": 7454.746493790265,
                "buyPriceMisc": 6441.197930459075,
                "supplierArticleId": "supplierArticleId",
                "stock": 7028.178117912689,
                "isStock": false,
                "stockWarning": 4193.009804561378
            }],
            "orderedAmount": 5998.6981274506425,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits"
        }],
        "warehouseWorkerId": 3377,
        "id": 709,
        "state": 2425,
        "deliveryDate": 1732182846240,
        "finishedDate": 1732182846240
    }],
    "pageSize": 664,
    "page": 9837,
    "since": 5471
}

Search pickinglist articles

GETUrl: /{order_id}/picking_lists/{list_id}/articles

Headers:

Accept: application/json or application/xml

Search articles for a specific picking list. Will match based on article-id, article name, barcode, barcode for batches / serialnumbers, and barcodes for article units

Valid parameters:

Parameter	Description	Default value	Allowed values
query
page		0
limit		50

Body:

Successfull response:

PickingListProducts

{"products": [{
    "customerOrderProductId": 8594,
    "bundled": true,
    "articleId": "articleId",
    "stockPlace": "stockPlace",
    "units": [{
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 3990
        },
        "articleId": "articleId",
        "storegroupId": 9245,
        "convert": 7112.273344533339,
        "barcode": "barcode"
    }],
    "stockAmount": 4126.610284533462,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846240,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "unit": {
        "name": "name",
        "externalId": "externalId",
        "id": 5437
    },
    "pickedAmount": 1894.1040675748122,
    "name": "name",
    "parts": [{
        "buyPrice": 446.56499782745,
        "supplierName": "supplierName",
        "amount": 9150.378431229447,
        "articleName": "articleName",
        "supplierId": 4514,
        "unitName": "unitName",
        "articleId": "articleId",
        "externalId": "externalId",
        "stockPlace": "stockPlace",
        "type": "type",
        "buyPriceCurrency": "buyPriceCurrency",
        "reserved": 5682.407230211318,
        "buyPriceShipment": 2633.636589577395,
        "buyPriceMisc": 7142.40688273106,
        "supplierArticleId": "supplierArticleId",
        "stock": 1119.323566419036,
        "isStock": true,
        "stockWarning": 2131.1122352227453
    }],
    "orderedAmount": 7817.08121733293,
    "barcode": "barcode",
    "orderedAmountWithUnits": "orderedAmountWithUnits"
}]}

Picking list rest

POSTUrl: /{order_id}/picking_lists/{list_id}/rest

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Create rest list from a picking list

Body:

Successfull response:

PurchaseOrdersResponse

{
    "ordersCount": 5616,
    "pages": 41,
    "pageSize": 4735,
    "orders": [{
        "paymentTermsDescription": "paymentTermsDescription",
        "deliveryPhone": "deliveryPhone",
        "supplierOrderId": "supplierOrderId",
        "supplierId": 9965,
        "productionOrderId": 1987,
        "deliveryTermsDescription": "deliveryTermsDescription",
        "customerOrderId": 1583,
        "contactPerson": "contactPerson",
        "deliveryZip": "deliveryZip",
        "productCount": 8131,
        "orderValue": 5868.77110600753,
        "confirmedDeliveryDate": 1732182846242,
        "externalInvoiceReference": "externalInvoiceReference",
        "orderValueCurrency": "orderValueCurrency",
        "deliveredDate": 1732182846242,
        "deliveryAddress": "deliveryAddress",
        "orderSentDate": 1732182846242,
        "deliveryContact": "deliveryContact",
        "id": 5789,
        "state": 7253,
        "deliveryDate": 1732182846242,
        "paymentTerms": "paymentTerms",
        "supplierName": "supplierName",
        "deliveryCity": "deliveryCity",
        "deliveryTerms": "deliveryTerms",
        "goodsMarking": "goodsMarking",
        "contactEmail": "contactEmail",
        "isPickNPack": "false",
        "deliveryAddress2": "deliveryAddress2",
        "orderValueStore": 7033.079386498261,
        "storeId": 4693,
        "deliveryCompany": "deliveryCompany",
        "message": "message",
        "deliveryCountry": "deliveryCountry",
        "comment": "comment",
        "articles": [{
            "deliveredAmount": "0",
            "articleName": "articleName",
            "purchasePriceMisc": "0",
            "barcodeType": "EAN",
            "articleId": "articleId",
            "description": "description",
            "purchasePrice": "0",
            "units": [{
                "unit": {
                    "name": "name",
                    "externalId": "externalId",
                    "id": 2659
                },
                "articleId": "articleId",
                "storegroupId": 3295,
                "convert": 7083.318591957798,
                "barcode": "barcode"
            }],
            "type": "type",
            "batches": [{
                "deliveredAmount": "1",
                "serialNr": "serialNr",
                "bestBefore": 8278,
                "batchId": "batchId",
                "orderedAmount": "1"
            }],
            "unit": "unit",
            "availableAmount": "0",
            "rate": 738.0383887603415,
            "supplierArticleId": "supplierArticleId",
            "purchasePriceShipment": "0",
            "id": 6029,
            "orderedAmount": "0",
            "stock": true,
            "barcode": "barcode",
            "orderedAmountWithUnits": "orderedAmountWithUnits",
            "stockWarning": "0"
        }],
        "poReference": "poReference"
    }],
    "page": 9182
}

Assign picking list

PUTUrl: /{order_id}/picking_lists/{list_id}/assign

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Assign a pickinglist to current user. This request requires that device_id or user_id header is present in the request

Body:

Successfull response:

PickingList

{
    "orderComment": "orderComment",
    "orderId": 4224,
    "warehouseWorkerName": "warehouseWorkerName",
    "startedDate": 1732182846243,
    "storeId": 156,
    "title": "title",
    "customerName": "customerName",
    "products": [{
        "customerOrderProductId": 9119,
        "bundled": false,
        "articleId": "articleId",
        "stockPlace": "stockPlace",
        "units": [{
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 8128
            },
            "articleId": "articleId",
            "storegroupId": 633,
            "convert": 725.2168536270898,
            "barcode": "barcode"
        }],
        "stockAmount": 7555.199652116039,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846243,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 7661
        },
        "pickedAmount": 4056.5413470348776,
        "name": "name",
        "parts": [{
            "buyPrice": 7491.489071013446,
            "supplierName": "supplierName",
            "amount": 1908.170548741115,
            "articleName": "articleName",
            "supplierId": 7373,
            "unitName": "unitName",
            "articleId": "articleId",
            "externalId": "externalId",
            "stockPlace": "stockPlace",
            "type": "type",
            "buyPriceCurrency": "buyPriceCurrency",
            "reserved": 4224.971721366844,
            "buyPriceShipment": 353.3827685165336,
            "buyPriceMisc": 7948.902163065474,
            "supplierArticleId": "supplierArticleId",
            "stock": 7175.365251432416,
            "isStock": true,
            "stockWarning": 1362.655721127367
        }],
        "orderedAmount": 6337.98675428008,
        "barcode": "barcode",
        "orderedAmountWithUnits": "orderedAmountWithUnits"
    }],
    "warehouseWorkerId": 4931,
    "id": 7035,
    "state": 7600,
    "deliveryDate": 1732182846243,
    "finishedDate": 1732182846243
}

Assign picking list to user

PUTUrl: /{order_id}/picking_lists/{list_id}/assign/{assigned_user_id}

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Assign a pickinglist to a user

Body:

Successfull response:

PickingList

{
    "orderComment": "orderComment",
    "orderId": 4762,
    "warehouseWorkerName": "warehouseWorkerName",
    "startedDate": 1732182846245,
    "storeId": 6300,
    "title": "title",
    "customerName": "customerName",
    "products": [{
        "customerOrderProductId": 5430,
        "bundled": true,
        "articleId": "articleId",
        "stockPlace": "stockPlace",
        "units": [{
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 4097
            },
            "articleId": "articleId",
            "storegroupId": 2935,
            "convert": 5989.552902020614,
            "barcode": "barcode"
        }],
        "stockAmount": 9352.487576238364,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846245,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 131
        },
        "pickedAmount": 497.78775457870796,
        "name": "name",
        "parts": [{
            "buyPrice": 4107.032557332472,
            "supplierName": "supplierName",
            "amount": 930.4876433900112,
            "articleName": "articleName",
            "supplierId": 7337,
            "unitName": "unitName",
            "articleId": "articleId",
            "externalId": "externalId",
            "stockPlace": "stockPlace",
            "type": "type",
            "buyPriceCurrency": "buyPriceCurrency",
            "reserved": 2867.8724819916547,
            "buyPriceShipment": 9756.606209768912,
            "buyPriceMisc": 2111.889967793249,
            "supplierArticleId": "supplierArticleId",
            "stock": 3873.4955820642626,
            "isStock": false,
            "stockWarning": 4205.574882172685
        }],
        "orderedAmount": 6370.850940428936,
        "barcode": "barcode",
        "orderedAmountWithUnits": "orderedAmountWithUnits"
    }],
    "warehouseWorkerId": 3648,
    "id": 4142,
    "state": 652,
    "deliveryDate": 1732182846245,
    "finishedDate": 1732182846245
}

Finish picking list

PUTUrl: /{order_id}/picking_lists/{list_id}/finish

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update pickinglist and set state to finished

Body:

Successfull response:

PickingList

{
    "orderComment": "orderComment",
    "orderId": 9866,
    "warehouseWorkerName": "warehouseWorkerName",
    "startedDate": 1732182846246,
    "storeId": 5700,
    "title": "title",
    "customerName": "customerName",
    "products": [{
        "customerOrderProductId": 8021,
        "bundled": true,
        "articleId": "articleId",
        "stockPlace": "stockPlace",
        "units": [{
            "unit": {
                "name": "name",
                "externalId": "externalId",
                "id": 4130
            },
            "articleId": "articleId",
            "storegroupId": 9918,
            "convert": 4292.212391509173,
            "barcode": "barcode"
        }],
        "stockAmount": 4701.390001484498,
        "batches": [{
            "deliveredAmount": "0",
            "serialNr": "serialNr",
            "pickedAmount": "0",
            "bestBefore": 1732182846246,
            "batchId": "batchId",
            "orderedAmount": "1"
        }],
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 4036
        },
        "pickedAmount": 5451.892142639939,
        "name": "name",
        "parts": [{
            "buyPrice": 2502.3026006069226,
            "supplierName": "supplierName",
            "amount": 3130.8540627032653,
            "articleName": "articleName",
            "supplierId": 8597,
            "unitName": "unitName",
            "articleId": "articleId",
            "externalId": "externalId",
            "stockPlace": "stockPlace",
            "type": "type",
            "buyPriceCurrency": "buyPriceCurrency",
            "reserved": 6079.439446606055,
            "buyPriceShipment": 2882.3628750081566,
            "buyPriceMisc": 9795.994607726463,
            "supplierArticleId": "supplierArticleId",
            "stock": 7487.875286842046,
            "isStock": false,
            "stockWarning": 6524.671183274101
        }],
        "orderedAmount": 1150.3811337317804,
        "barcode": "barcode",
        "orderedAmountWithUnits": "orderedAmountWithUnits"
    }],
    "warehouseWorkerId": 1461,
    "id": 1468,
    "state": 4027,
    "deliveryDate": 1732182846246,
    "finishedDate": 1732182846246
}

Pick multiple articles

PUTUrl: /{order_id}/picking_lists/{list_id}/pick

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Update articles for a specific picking list

Body:

PickingListProducts

{"products": [{
    "customerOrderProductId": 3698,
    "bundled": true,
    "articleId": "articleId",
    "stockPlace": "stockPlace",
    "units": [{
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 8343
        },
        "articleId": "articleId",
        "storegroupId": 4393,
        "convert": 9980.71189221669,
        "barcode": "barcode"
    }],
    "stockAmount": 518.6641711928553,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846247,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "unit": {
        "name": "name",
        "externalId": "externalId",
        "id": 5638
    },
    "pickedAmount": 5063.003018250708,
    "name": "name",
    "parts": [{
        "buyPrice": 2660.1131549891143,
        "supplierName": "supplierName",
        "amount": 6195.460028031722,
        "articleName": "articleName",
        "supplierId": 4150,
        "unitName": "unitName",
        "articleId": "articleId",
        "externalId": "externalId",
        "stockPlace": "stockPlace",
        "type": "type",
        "buyPriceCurrency": "buyPriceCurrency",
        "reserved": 4738.6316486294,
        "buyPriceShipment": 812.4333454277311,
        "buyPriceMisc": 3762.614044549446,
        "supplierArticleId": "supplierArticleId",
        "stock": 6107.1555166643975,
        "isStock": false,
        "stockWarning": 97.8444779547849
    }],
    "orderedAmount": 985.2378009950713,
    "barcode": "barcode",
    "orderedAmountWithUnits": "orderedAmountWithUnits"
}]}

Successfull response:

PickingListProducts

{"products": [{
    "customerOrderProductId": 5688,
    "bundled": false,
    "articleId": "articleId",
    "stockPlace": "stockPlace",
    "units": [{
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 493
        },
        "articleId": "articleId",
        "storegroupId": 1199,
        "convert": 6391.7783089469085,
        "barcode": "barcode"
    }],
    "stockAmount": 6720.811210551744,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846247,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "unit": {
        "name": "name",
        "externalId": "externalId",
        "id": 823
    },
    "pickedAmount": 41.41620671458735,
    "name": "name",
    "parts": [{
        "buyPrice": 7424.3612352770515,
        "supplierName": "supplierName",
        "amount": 262.3951789932488,
        "articleName": "articleName",
        "supplierId": 9431,
        "unitName": "unitName",
        "articleId": "articleId",
        "externalId": "externalId",
        "stockPlace": "stockPlace",
        "type": "type",
        "buyPriceCurrency": "buyPriceCurrency",
        "reserved": 6402.025459083415,
        "buyPriceShipment": 4881.684020955337,
        "buyPriceMisc": 4714.09493348388,
        "supplierArticleId": "supplierArticleId",
        "stock": 6653.29605393971,
        "isStock": true,
        "stockWarning": 388.1180105574378
    }],
    "orderedAmount": 7621.589353613548,
    "barcode": "barcode",
    "orderedAmountWithUnits": "orderedAmountWithUnits"
}]}

Change picking list state

PUTUrl: /{order_id}/picking_lists/{list_id}/packing

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Change picking list state to packing

Body:

Successfull response:

Pick article

PUTUrl: /{order_id}/picking_lists/{list_id}/pick/{article_id : .+}

Headers:

Accept: application/json or application/xml
Content-type: application/json or application/xml

Pick an article from a specific picking list. This request requires that device_id or user_id header is present in the request

Body:

PickingListProduct

{
    "customerOrderProductId": 7257,
    "bundled": true,
    "articleId": "articleId",
    "stockPlace": "stockPlace",
    "units": [{
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 616
        },
        "articleId": "articleId",
        "storegroupId": 689,
        "convert": 33.896768760480754,
        "barcode": "barcode"
    }],
    "stockAmount": 157.04933807906275,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846248,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "unit": {
        "name": "name",
        "externalId": "externalId",
        "id": 5472
    },
    "pickedAmount": 7091.654519800238,
    "name": "name",
    "parts": [{
        "buyPrice": 4515.921696038874,
        "supplierName": "supplierName",
        "amount": 7671.936397621694,
        "articleName": "articleName",
        "supplierId": 6228,
        "unitName": "unitName",
        "articleId": "articleId",
        "externalId": "externalId",
        "stockPlace": "stockPlace",
        "type": "type",
        "buyPriceCurrency": "buyPriceCurrency",
        "reserved": 3585.2579710440814,
        "buyPriceShipment": 7995.382495792543,
        "buyPriceMisc": 5219.82188347457,
        "supplierArticleId": "supplierArticleId",
        "stock": 8012.235337951142,
        "isStock": true,
        "stockWarning": 2807.298345455368
    }],
    "orderedAmount": 9277.765639687572,
    "barcode": "barcode",
    "orderedAmountWithUnits": "orderedAmountWithUnits"
}

Successfull response:

PickingListProduct

{
    "customerOrderProductId": 3833,
    "bundled": true,
    "articleId": "articleId",
    "stockPlace": "stockPlace",
    "units": [{
        "unit": {
            "name": "name",
            "externalId": "externalId",
            "id": 5006
        },
        "articleId": "articleId",
        "storegroupId": 5382,
        "convert": 2414.5278793796897,
        "barcode": "barcode"
    }],
    "stockAmount": 3632.2920001124494,
    "batches": [{
        "deliveredAmount": "0",
        "serialNr": "serialNr",
        "pickedAmount": "0",
        "bestBefore": 1732182846250,
        "batchId": "batchId",
        "orderedAmount": "1"
    }],
    "unit": {
        "name": "name",
        "externalId": "externalId",
        "id": 1476
    },
    "pickedAmount": 988.4029919314863,
    "name": "name",
    "parts": [{
        "buyPrice": 579.7220825727312,
        "supplierName": "supplierName",
        "amount": 3204.1816988466053,
        "articleName": "articleName",
        "supplierId": 8257,
        "unitName": "unitName",
        "articleId": "articleId",
        "externalId": "externalId",
        "stockPlace": "stockPlace",
        "type": "type",
        "buyPriceCurrency": "buyPriceCurrency",
        "reserved": 992.0629077910181,
        "buyPriceShipment": 285.7346423619456,
        "buyPriceMisc": 422.5156927893592,
        "supplierArticleId": "supplierArticleId",
        "stock": 6513.5241147352845,
        "isStock": false,
        "stockWarning": 3518.6927251903844
    }],
    "orderedAmount": 4980.692535803925,
    "barcode": "barcode",
    "orderedAmountWithUnits": "orderedAmountWithUnits"
}

Print

Print pickinglist

GETUrl: /{order_id}/pickinglist/{list_id}/print

Headers:

Accept: application/pdf or application/json

Print pickinglist for customer order

Body:

Successfull response:

byte[]

{}

Print customer order

GETUrl: /{id}/print

Headers:

Accept: application/pdf or application/json

Print customer order based on order id

Body:

Successfull response:

byte[]

{}

Print delivery note

GETUrl: /{id}/delivery_note/print

Headers:

Accept: application/pdf or application/json

Print delivery note for a customer orders based on order id

Valid parameters:

Parameter	Description	Default value	Allowed values
picking_list_id

Body:

Successfull response:

byte[]

{}

Print all delivery notes

GETUrl: /delivery_notes/print

Headers:

Accept: application/pdf or application/json

Print delivery notes for all customer orders that are packed and ready to be sent

Valid parameters:

Parameter	Default value	Allowed values
state	20	0,5,10,15,20,30,40,45,50,60
page	0
page_size	25
sort_order	asc	asc,desc
sort_column	id	id,delivery_date,delivered_date,state

Body:

Successfull response:

byte[]

{}

Print labels

GETUrl: /print_labels

Headers:

Accept: application/pdf
Content-type: application/json or application/xml

Print customer orders data to a labels file (Excel)

Valid parameters:

Parameter	Default value	Allowed values
page	0
page_size	25
sort_order	asc	asc,desc
sort_column	id	id,delivery_date,delivered_date,state

Body:

Successfull response:

byte[]

{}

Print all pickinglists

GETUrl: /pickinglists/print

Headers:

Accept: application/pdf or application/json

Print all pickinglists for customer orders that are ready to be picked

Valid parameters:

Parameter	Description	Default value	Allowed values
page		0
page_size		25

Body:

Successfull response:

byte[]

{}

Rest articles

Get rest articles for supplier

GETUrl: /rest_articles/supplier/{supplier_id}/

Headers:

Accept: application/json or application/xml

Get rest articles for supplier with customer orders

Valid parameters:

Parameter	Default value	Allowed values
order	asc	asc,desc
sort_column	deliveryDate	deliveryDate, available
page	0
limit	50

Body:

Successfull response:

RestOrderResponse

{
    "pages": 4868,
    "pageSize": 2772,
    "page": 8480,
    "articlesCount": 3360,
    "articles": [{
        "date": 1732182846252,
        "customerOrders": [{
            "desiredDelivery": 1732182846252,
            "reserved": 5490.206584145568,
            "customerId": 3269,
            "id": 601,
            "state": "state",
            "displayId": "displayId",
            "customerName": "customerName"
        }],
        "name": "name",
        "available": 6772.030838425953,
        "deliver": 3536.542206525933,
        "id": "id"
    }]
}

Get rest articles for purchase order

GETUrl: /rest_articles/purchaseorder/{order_id}/

Headers:

Accept: application/json or application/xml

Get rest articles for purchase order with customer orders

Valid parameters:

Parameter	Default value	Allowed values
order	asc	asc,desc
sort_column	deliveryDate	deliveryDate, available
page	0
limit	50

Body:

Successfull response:

RestOrderResponse

{
    "pages": 2731,
    "pageSize": 7837,
    "page": 6554,
    "articlesCount": 1048,
    "articles": [{
        "date": 1732182846253,
        "customerOrders": [{
            "desiredDelivery": 1732182846253,
            "reserved": 7848.431356156365,
            "customerId": 6164,
            "id": 2287,
            "state": "state",
            "displayId": "displayId",
            "customerName": "customerName"
        }],
        "name": "name",
        "available": 6300.495130055392,
        "deliver": 8188.330387371955,
        "id": "id"
    }]
}

Classes:

Article

Field	Type	Description	Default	Mandatory	Accepted values	Access
articleId	String	Write only with POST		Post		R,W
externalId	String	External article id				R,W
active	Boolean		true			R,W
name	String			Post		R,W
bundled	Boolean	Write only with POST	false			R,W
parts	List	If article is bundled this is the parts contained in the article. When updating an existing bundled article this list will replace old list. If list is null, no replacement will be made. If list is empty, all parts will be removed				R,W
batches	ArticleBatches	Returns the first 20 batches and the first 20 serial numbers connected to this article				R
description	String					R,W
category	String		övrigt			R,W
amount	Double	Available amount. This means stock amount reduced by reserved amount				R,W
reserved	Double	Reserved amount				R
barcode	String					R,W
barcodeType	String		EAN		EAN, CODE128, QR, UPC	R,W
price	Double					R,W
prices	List					R,W
supplier	Long	If article is bundled, supplier information will be ignored			if not null, must point to an existing supplier	R,W
supplierExternalId	String	external id of Supplier				R
supplierName	String	If article is bundled, supplier information will be ignored			if not null, must point to an existing supplier	R,W
supplierArticleId	String	If article is bundled, supplier information will be ignored				R,W
supplierAutomaticOrder	Boolean	If article is bundled, supplier information will be ignored				R,W
supplierBuyPrice	Double	Total buy price including shipment and misc costs. If article is bundled, supplier information will be ignored				R,W
supplierBuyPriceShipment	Double	If article is bundled, supplier information will be ignored				R,W
supplierArticles	List	If article is bundled, supplier information will be ignored				R,W
supplierBuyPriceMisc	Double	If article is bundled, supplier information will be ignored				R,W
supplierBuyCurrency	String					R
supplierBuyRate	Double					R
unit	String		st			R,W
vat	Double	Vat in percentage. If both vat-account and vat is submitted, vat-account takes precedence		Post		R,W
vatAccount	Integer	If both vat-account and vat is submitted, vat-account takes precedence				R,W
imageLastUpdated	Long					R
type	String	Stock means it's a physical product and service means it's work and lacks stock-amount		Post	Stock, Service	R,W
stock	Boolean	True means it's a physical article in stock and false means it's an article that needs to be ordered from supplier	true			R,W
webshopArticle	Boolean		false			R,W
manufacturer	String					R,W
manufacturerArticleId	String					R,W
customFields	List	if you have need for other type of fields then what lagerkoll offers you can use this key-value list. When creating / updating an article the content of this list will replace the list of fields in the existing article				R,W
links	List					R,W
tags	List	Make sure you provide tagId for existing tags, otherwise new ones will be created				R,W
width	Double					R,W
height	Double					R,W
depth	Double					R,W
weight	Double					R,W
stockPlace	String					R,W
stockWarning	Double					R,W
criticalLevel	Double	When amount reaches the critical level it is automatically added to a purchase order, with amount set to order level				R,W
orderLevel	Double	When amount reaches the critical level it is automatically added to a purchase order, with amount set to order level				R,W
automaticOrder	Boolean	Set flag to true if the article should be automatically added to a purchase order when stock level reaches the critical level				R,W
nextDeliveryDate	Long	If there is a purchase order for this article, this would be the delivery date for that order				R
orderedAmount	Double	If there is a purchase order for this article, this would be the ordered amount for that order				R
deliveredAmount	Double	If there is a purchase order for this article, this would be the delivered amount for that order				R
availableAmount	Double	Amount available for given deliveryDate				R

ArticleBatch

Field	Type	Description	Default	Mandatory	Access
articleId	String	Id of article the batch/serialnumber is connected to			R
articleName	String	Name of article			R
batchId	String	batch-id or serial-nr must be set, Write only with POST		Post	R,W
serialNr	String	batch-id or serial-nr must be set, Write only with POST		Post	R,W
amount	double		1		R,W
reserved	double	Reserved is set automatically when part of a customer order that has not yet been invoiced			R
barcode	String	Write only with POST			R,W
bestBefore	Long	ms since 1970, Write only with POST			R,W

ArticleBatches

Field	Type	Description	Access
totalBatches	Integer	Total number of batches for an article	R
batches	List	Current page of batches for an article	R
totalSerialNumbers	Integer	Total number of serial numbers for an article	R
serialNumbers	List	Current page of serial numbers for an article	R
totalBatchesInStock	Double	Total batches in stock	R
totalBatchesReserved	Double	Total batches reserved	R
totalSerialNumbersInStock	Double	Total serial numbers in stock	R
totalSerialNumbersReserved	Double	Total serial numbers reserved	R

ArticleLink

Field	Type	Mandatory	Accepted values	Access
name	String	Post		R,W
url	String	Post		R,W
type	String	Post	unknown, webpage, image, document, lagerkoll_document	R,W

ArticleTag

Field	Type	Description	Mandatory	Access
id	long	Write only with POST	Post	R,W
externalId	String			R,W
name	String		Post	R,W
desc	String		Post	R,W

ArticleUnit

Field	Type	Description	Mandatory	Access
storegroupId	long			R
articleId	String	Article id		R
unit	Unit	Unit id	true	R,W
convert	Double	Conversion coefficient between unit and the article base unit	true	R,W
barcode	String	Barcode conected to unit		R,W

BundledArticle

Field	Type	Description	Mandatory	Accepted values	Access
articleId	String				R,W
articleName	String				R
externalId	String	External article id			R
amount	Double	Amount of this article for a single bundled article	Post/Put		R,W
isStock	Boolean	Is article is of type stock			R
stockWarning	Double	Warning for low stock level			R
stock	Double	Number of articles in stock			R
reserved	Double	Number of articles reserved. Number of available = stock - reserved			R
type	String	Stock means it's a physical product and service means it's work and lacks stock-amount	Post	Stock, Service	R,W
unitName	String				R
stockPlace	String				R
buyPrice	Double				R
buyPriceShipment	Double				R
buyPriceMisc	Double				R
buyPriceCurrency	String				R
supplierId	Long				R
supplierName	String				R
supplierArticleId	String				R

CustomerOrder

Field	Type	Description	Default	Mandatory	Accepted values	Access
orderId	long					R
externalOrderId	String	CustomerOrder-id from an external system if such exists				R,W
externalDisplayOrderId	String	Displayable CustomerOrder-id from an external system if such exists				R,W
webshopOrderId	String	CustomerOrder-id from your webshop if such exists				R,W
storeGroupId	long					R
customerId	Long			POST	must point to an existing customer	R,W
customerName	String				returns name from existing customer	R
customerOrderNumber	String					R,W
state	Integer	Write only with POST	0		NEW = 0, READY_FOR_PACKING = 5, PACKING = 10, DROP SHIPMENT = 15, PACKED = 20, PARTLY SENT = 30, SENT = 40, CANCELLED = 50, INVOICED = 60	R,W
administrationFee	Float					R,W
currency	String	if null, currency is fetched from customer			if not null, must point to an existing currency	R,W
currencyRate	Float	If omitted when creating the order, the exchange rate between customer currency and store sales currency is calculated and set				R,W
comments	String					R,W
deliveryAddress1	String	if null, address is fetched from customer				R,W
deliveryAddress2	String	if null, address is fetched from customer				R,W
deliveryZipCode	String	if null, zipcode is fetched from customer				R,W
deliveryCity	String	if null, city is fetched from customer				R,W
deliveryCountry	String	if null, country is fetched from customer			if not null, must point to an existing country	R,W
deliveryDate	Date	If null when creating new CustomerOrder, value from orderDate is used				R,W
deliveryName	String					R,W
deliveryEmail	String					R,W
freight	Float					R,W
orderDate	Date	If set to null when creating the order it will default to current time				R,W
deliveredDate	Date					R
ourReference	String					R,W
phone1	String					R,W
phone2	String					R,W
remarks	String					R,W
deliveryTerm	String	if not null, must point to an existing delivery term				R,W
deliveryTermDesc	String	description of an existing delivery term				R
paymentTerm	String	if not null, must point to an existing payment term				R,W
paymentTermDesc	String	description of an existing payment term				R
vatIncluded	Boolean		true			R,W
wayOfDelivery	String	if not null, must point to an existing way of delivery				R,W
wayOfDeliveryDesc	String	description of an existing way of delivery				R
yourReference	String					R,W
products	List	List of CustomerOrderProducts				R,W
pricelistId	Long		-1		must point to an existing pricelist	R,W
externalInvoiceReference1	String					R,W
externalInvoiceReference2	String					R,W
costCenter	Long				if not null, must point to an existing cost center. Send -1 to remove cost center from existing order	R,W
totalPrice	Double	Total price of all articles, ex vat. Excluding discount				R
totalDiscount	Double	Total discount of all articles				R
deliveryStatus	Integer	Stock state for the order			1 = All in stock, 2 = Not all in stock, 3 = None in stock	R
orderValue	Double	Order value fo the order				R

CustomerOrderBatchProduct

Field	Type	Description	Default	Mandatory	Access
batchId	String	batch-id or serial-nr must be set, Write only with POST		POST	R,W
serialNr	String	batch-id or serial-nr must be set, Write only with POST		POST	R,W
orderedAmount	Double	If value missing defaultValue will be set	1	POST & PUT	R,W
pickedAmount	Double	If value missing defaultValue will be set	0	POST & PUT	R,W
deliveredAmount	Double	If value missing defaultValue will be set	0	POST & PUT	R,W
bestBefore	Date				R

CustomerOrderCost

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
orderId	long						R
productCosts	List	List of CustomerOrderProductCosts					R,W

CustomerOrderProduct

Field	Type	Description	Default	Mandatory	Accepted values	Access
id	Long	id is created by system, but must be supplied when updating order or matching product row won´t be found		POST & PUT		R
storeId	long					R
storeGroupId	long					R
articleId	String	Mandatory if this is not a freetext row. If this is a freetext row all fields except description is ignored		POST		R,W
rowIndex	Integer					R,W
orderedAmount	Double			POST		R,W
pickedAmount	Double		0			R,W
deliveredAmount	Double		0			R,W
piecePrice	Double	If omitted default price from pricelist will be used. Price is ex vat				R,W
totalPrice	Double	If omitted, default price from pricelist will be used to calculate the total price for the article. If bulk-prices exists for the pricelist, that will be used. Price is ex vat and excluding discounts				R,W
vat	Double	VAT connected to article				R
discountType	String		AMOUNT		PERCENT, AMOUNT	R,W
discount	Double		0			R,W
description	String					R,W
costCenter	Long	If omitted cost center from order will be used			if not null, must point to an existing cost center	R,W
isBundled	boolean					R,W
weight	Double					R,W
batches	List	If an article contains batches or serial numbers and this should be defined in the customer order this list contains that information. If this list is null, no updates are done. Otherwise the content of this list replaces existing list				R,W
stockWarning	double					R,W
availableAmount	double					R,W
tg	Double					R

CustomerOrderProductCost

Field	Type	Access
articleId	String	R
deliveredAmount	Double	R
totalCost	Double	R

CustomerOrdersResponse

Field	Type	Access
page	int	R
pages	int	R
pageSize	int	R
ordersCount	int	R
since	long	R
totalCustomerOrderValue	Double	R
orders	List	R

CustomField

Field	Type	Mandatory	Accepted values	Access
name	String	Post		R,W
type	String	Post	String, Number, Int, Long, Float, Double Boolean, Date, Json, JsonArray, Email	R,W
value	String	Post		R,W
validValues	List			R

CustomFieldValidValue

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
value	String						R
description	String						R

Email

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
email	String	Email address					R,W

Offer

Field	Type	Description	Mandatory	Accepted values	Access
offerId	long	Id of offer			R
customerId	Long	If offer points to an existing customer, this is the id of the customer			R,W
customerName	String	Name of customer	POST		R,W
customerPhone	String	Phone number of customer	POST		R,W
customerEmail	String	Email address of customer	POST		R,W
state	int	State of offer		0=NEW, 1=CLOSED, 2=CANCELLED	R
pricelistId	Long	Id of pricelist	POST		R,W
currency	String	Sales currency, 3 letter code	POST		R,W
rate	Double	Rate for sales currency			R
description	String	Description			R,W
ourReference	String	Our reference (selling part)			R,W
validDate	Date	Valid until			R,W
createdDate	Date	Creation date			R
customerOrderId	Long	Id of connected customer order			R
rows	List	Rows in offer. Can be existing articles or free text rows that can later be converted to articles			R,W

OfferRow

Field	Type	Description	Default	Mandatory	Accepted values	Access
id	Long	id is created by system, but must be supplied when updating offer or matching row won´t be found		POST & PUT		R
storeId	Long	Id of store the article belongs to				R
articleId	String	Id of existing article				R,W
articleName	String	Name of article				R,W
amount	Double	Offered amount		POST		R,W
unitId	Long	Unit id for article				R
unit	String	Unit name for article				R
salesPrice	Double	Sales price of article		POST		R,W
discountType	String		AMOUNT		PERCENT, AMOUNT	R,W
discount	Double		0			R,W
purchasePrice	Double	Purchase price of article		POST		R,W
purchaseCurrency	String	Purchase currency		POST		R,W
purchaseRate	Double	Exchange rate for purchase price				R
supplierId	Long	Id of existing supplier. If this is a text row this can be null				R,W
supplierName	String	Name of existing supplier. If this is a text row this can be null				R,W
totalPrice	Double	Total price for this row, including bracket prices				R

OffersResponse

Field	Type	Access
page	int	R
pages	int	R
pageSize	int	R
offersCount	int	R
since	long	R
offers	List	R

PickingList

Field	Type	Description	Accepted values	Access
id	long	picking list id		R
orderId	long	order id		R
storeId	long	id of store the list belongs to		R
title	String	title of customer order		R
state	int	state of picking list	NEW = 0, PACKING = 10, PACKED = 20, CLOSED = 30	R
warehouseWorkerId	Long	user id of the warehouse worker assigned to the picking list		R
warehouseWorkerName	String	name of the warehouse worker assigned to the picking list		R
startedDate	Date	start date when picking list was assigned		R
finishedDate	Date	finish date when picking list was closed		R
deliveryDate	Date	delivery date for the customer order		R
customerName	String	name of the customer		R
orderComment	String	order comment		R
products	List	list of products in the picking list		R

PickingListProduct

Field	Type	Description	Mandatory	Access
customerOrderProductId	Long	Customer order product id must be sent when updating a picking list product	PUT	R
articleId	String	Article id	Mandatory with PUT and POST	W,R
name	String	Name of article		R
barcode	String	Barcode of article		R
orderedAmount	Double	Ordered amount for current order		R
pickedAmount	Double	Picked amount for current order	Mandatory with PUT and POST. If product contains batches, this field must add up to the same amount the batches does	W,R
stockAmount	Double	Current stock amount for article		R
stockPlace	String	Stockplace for the article		R
unit	Unit			R
bundled	Boolean	Flag to indicate if article is bundled or not		R
parts	List	If article is bundled this is the parts contained in the article. When updating an existing bundled article this list will replace old list. If list is empty no replacement will be made		R
batches	List	If an article contains batches or serial numbers and this should be defined in the customer order this list contains that information. If this list is null, no updates are done. Otherwise the content of this list replaces existing list	Optional with PUT and POST	W,R
units	List	List of units connected to the article, with factor and barcode. This does not contain information about the main unit on the article		R
orderedAmountWithUnits	String	If article contains multiple units this string represents the most optimal package variants		R

PickingListProducts

Field	Type	Description	Default	Mandatory	Accepted values	Example values	Access
products	List	List of picking list articles					R,W

PickingListsResponse

Field	Type	Access
page	int	R
pages	int	R
pageSize	int	R
listsCount	int	R
since	long	R
lists	List	R

Price

Field	Type	Description	Default	Mandatory	Access
listId	Long	Write only with POST		Post	R,W
listExternalId	String	External id of pricelist			R
articleId	String	Write only with POST		Post	R,W
fromQuantity	double	Write only with POST	0		R,W
price	Double	To remove a price, send null to server	0		R,W

PurchaseOrder

Field	Type	Description	Default	Mandatory	Accepted values	Access
id	long					R
storeId	long					R
poReference	String	Must be a unique id		POST		R,W
supplierId	Long			POST		R,W
supplierName	String					R
orderSentDate	Date					R
deliveryDate	Date			POST		R,W
confirmedDeliveryDate	Date					R,W
deliveredDate	Date					R
paymentTerms	String	Payment terms code				R,W
paymentTermsDescription	String	Payment terms description				R
deliveryTerms	String	Delivery terms code				R,W
deliveryTermsDescription	String	Delivery terms description				R
deliveryContact	String					R,W
deliveryCompany	String					R,W
deliveryPhone	String					R,W
deliveryAddress	String			POST		R,W
deliveryAddress2	String					R,W
deliveryCity	String			POST		R,W
deliveryZip	String			POST		R,W
deliveryCountry	String			POST		R,W
contactPerson	String			POST		R,W
contactEmail	String			POST		R,W
productCount	Integer					R
state	Integer				NEW = 0, SENT = 1, RECEIVED = 2, FINISHED = 3, CANCELLED = 4	R,W
supplierOrderId	String					R,W
customerOrderId	Long					R,W
productionOrderId	Long					R,W
message	String					R,W
isPickNPack	Boolean		false			R,W
comment	String					R,W
externalInvoiceReference	String					R,W
goodsMarking	String					R,W
orderValue	Double	Order value based on the supplier's currency				R
orderValueCurrency	String	Supplier's currency for the order value				R
orderValueStore	Double	Order value based on the store's currency				R
articles	List	List of PurchaseOrderArticles				R,W

PurchaseOrderArticle

Field	Type	Description	Default	Mandatory	Accepted values	Access
id	Long	id is created by system, but must be supplied when updating order or matching product row won´t be found		PUT		R
articleId	String	Mandatory if this is not a freetext row. If this is a freetext row all fields except articleName is ignored		POST, DELETE		R,W
articleName	String	Name of article, or freetext row if articleId is missing				R,W
supplierArticleId	String	If omitted, article id from supplier is used				R,W
orderedAmount	Double		0			R,W
deliveredAmount	Double		0			R,W
availableAmount	Double		0			R
stockWarning	Double		0			R
barcode	String					R
barcodeType	String		EAN		EAN, CODE128, QR, UPC	R
purchasePrice	Double	If omitted, price from supplier is used	0			R,W
purchasePriceMisc	Double	If omitted, price from supplier is used	0			R,W
purchasePriceShipment	Double	If omitted, price from supplier is used	0			R,W
rate	Double					R
description	String					R,W
unit	String					R
type	String	Stock means it's a physical product and service means it's work and lacks stock-amount			Stock, Service	R
stock	Boolean	True means it's a physical article in stock and false means it's an article that needs to be ordered from supplier				R
batches	List	If an article contains batches or serial numbers and this should be defined in the purchase order this list contains that information. If this list is null, no updates are done. Otherwise the content of this list replaces existing list				R,W
units	List	List of units connected to the article, with factor and barcode. This does not contain information about the main unit on the article				R
orderedAmountWithUnits	String	If article contains multiple units this string represents the most optimal package variants				R

PurchaseOrderArticleBatch

Field	Type	Description	Default	Mandatory	Access
batchId	String	batch-id or serial-nr must be set, Write only with POST		Post	R,W
serialNr	String	batch-id or serial-nr must be set, Write only with POST		Post	R,W
orderedAmount	Double		1		R,W
deliveredAmount	Double		1		R,W
bestBefore	Long	ms since 1970, Write only with POST			R,W

PurchaseOrdersResponse

Field	Type	Access
page	int	R
pages	int	R
pageSize	int	R
ordersCount	int	R
orders	List	R

RestOrderArticle

Field	Type	Description	Access
id	String	Article id	R
name	String	Article name	R
date	Date	Oldest delivery date in the orders-list	R
deliver	double	Total amount to deliver in the orders-list	R
available	double	Amount available in stock	R
customerOrders	List	List of customer orders this article is in	R

RestOrderCustomerOrder

Field	Type	Description	Accepted values	Access
id	long	Order id		R
displayId	String	Display id		R
state	String	Customer order state	NEW = 0, READY_FOR_PACKING = 5, PACKING = 10, DROP SHIPMENT = 15, PACKED = 20, PARTLY SENT = 30, SENT = 40, CANCELLED = 50, INVOICED = 60	R
customerId	long	Customer id		R
customerName	String	Customer name		R
desiredDelivery	Date	Delivery date of order		R
reserved	double	Amount ordered that has been reserved in stock		R

RestOrderResponse

Field	Type	Description	Access
pages	int	Total pages	R
page	int	Current page	R
pageSize	int	Articles per page	R
articlesCount	int	Total amount of articles	R
articles	List	List of articles	R

SupplierArticle

Field	Type	Description	Default	Accepted values	Access
supplier	Long			if not null, must point to an existing supplier	R,W
supplierName	String			if not null, must point to an existing supplier	R,W
supplierArticleId	String				R,W
supplierAutomaticOrder	boolean				R
supplierBuyPrice	Double	Total buy price including shipment and misc costs			R,W
supplierBuyPriceShipment	Double				R,W
supplierBuyPriceMisc	Double				R,W
supplierBuyCurrency	String	If omitted, supplier's currency is used. If supplier is missing, it defaults to store's currency	Store currency		R,W
supplierBuyRate	Double	If supplier's currency differ from store's currency, provide an exchange rate. If rate is omitted, the supplier's rate is used. If supplier is missing, it defaults to 1.0	1.0		R,W

Unit

Field	Type	Description	Access
id	Long		R,W
externalId	String		R
name	String	Name of unit	R,W