NAV Navbar
json

Introduction

Welcome to the WICS Service Layer API! You can use the Server Layer API to access various methods WICS provide.

With this api you can communicate with your WICS WMS application. The docs will provide examples in php and shell curl.

Documentation

Please follow the right link for your environment. Check in your browser address bar if you have openend the right documentation.

Environment Link
Production/Live Production documentation
Test TEST documentation

API Rate Limiting

The maximum daily requests that can be sent is 20.000 requests per day per user.

The maximum requests that can be sent is 150 requests per minute per user. If an API user exceeds the maximum requests per minute, the user will be blocked for one minute (First violation level). Ignoring the message and sending a new request will block the user for an additional five minutes (Second violation level). If requests continue to be sent, the user will be blocked for a maximum of fifteen minutes (Third violation level) .

For more information about basic authentication, please visit the following link

Authentication

The Service Layer uses basic authentication for authorization of the request. You have to use the API key and API secret provided by the Service Layer.

curl --user {apikey}:{apisecret} "https://test.servicelayer.wics.nl/api/endpoint" -X [GET/POST/PUT/DELETE]

Webhooks

Implementing Webhooks

You can use webhook subscriptions to receive instantly notifications about events in your plugin/webshop. After you've subscribed to a webhook, your plugin or webshop can receive data immediately, instead of having to make API calls periodically to check the status of data .

For example, you can rely on webhooks to receive data to your plugin/webshop when an order is shipped succesfully, or when a stock change is done in the WICS Warehouse. By using webhooks subscriptions you can make fewer API calls overall, which makes sure that your plugins/webshops are more efficient and are update instantly.

Webhook diagram

When the servicelayer sents a webhook to a connector it will expect an HTTP 200 response. If the response is anything else the webhook will be retried.

Retrying

A usecase could arise where the webhook can not be reached. This could be because the webshop or webapplication is down. The Service Layer will retry 10 times within 24 hours to deliver the data. The first retry is after 90 seconds, the second retry 360 seconds, and so on. This is processed very effectively, so there is no loss of data if the plugin / webshop is back online within 24 hours.

Attempt Minutes timeout
1 1.5
2 4.5
3 10.5
4 22.5
5 46.5
6 94.5
7 190.5
8 382.5
9 766.5
10 1534.5

Configure

After you configure a webhook subscription (see chapter Webhooks), the events that you specified will trigger a webhook notification each time they occur. This notification contains JSON body with data. Webhook subscriptions are scoped only to the APIkey en APIsecret (login) that they're registered to. This means that when a webhook subscription is registered to a login, other logins can't view, modify, or delete it.

However it is possible to subscribe with multiple urls as long they are unique. Another possibility is that when multi-shop is used, multiple events can be registered per webshopID. So when Shop A and B uses the same items with stocklevels, they both can receive stock updates at te same time.

On the events can be subscribed, in the Service Layer we call them 'topics'.

How to subscribe to the Webhooks is explained below in the documentation
- Create/subscribe a webhook
- Shows the current subcribed webhooks
- Delete/unsubscrib a webhook

Handle

When you have subscribed and configured a webhook, WICS is almost ready to publisch events to your pluging/webshop. It is important that the webhooks are enabled in WICS, when enabled WICS will automatically publish data to the subscribed webhooks.

Every Webhook will be sent with an Autorization header containing the apikey and apisecret of the customer/connector.

Authorization: Basic {apikey}:{apisecret}

List Webhooks

GET
/api/webhook

The request returns the following JSON:

#HTTP/1.1 200 OK
{
    "code": 200,
    "message": "List of Webhooks",
    "success": true,
    "data": [
        {
            "id": 15,
            "topic": "STOCK",
            "url": "http://mywebshop.shop.com/stock"
        }
    ]
}

This endpoint retrieves all the Webhooks.

Query Parameters

Parameter Type Description
page Integer If supplied the results will show the page listed.
pageSize Integer If supplied te number of result will be the amount listed.

Field descriptions

Field Type Description Format
topic String The topic of the webhook. Supported topic's
url String The url of your webshop. The Service Layer will call this url when a Webhook event is triggered.

Create Webhook

POST
/api/webhook
{
    "topic": "STOCK",
    "url":"http://mywebshop.shop.com/stock"
}

The request returns the following JSON:

#HTTP/1.1 201 Created
{
    "code": 200,
    "message": "Webhook registered",
    "success": true,
    "data": [
      "<identifier>"
    ]
}

This endpoint creates/subscribe a new webhook.

Field descriptions

The fields marked with a asterix (*) are required.

Field Type Description Format
topic* String The topic of the webhook. Supported topic's
url* String Define here the url of your webshop. The Service Layer will call this url when a Webhook event is triggered.

Delete Webhook

DELETE
/api/webhook/{identifier}

The request returns the following JSON:

{
    "code": 200,
    "message": "<Identifier> deleted succesfully",
    "success": true,
    "data": null
}

This endpoint deletes a webhook.

Topic's

We support a number of different webhooks.

Topic Shipment

{
  "metaFields": "",
  "shipmentNr": 9313,
  "orderReference": "WT 95",
  "deliveryDate": "2021-09-13T00:00:00.000+02:00",
  "shipperCode": "9000000",
  "shipperName": "PostNL",
  "trackAndTrace": "3SDEVC0052846",
  "trackAndTraceUrl": "http://postnl.nl/tracktrace/?D=NL&B=3SDEVC0052846&P=4251BC&L=NL&T=C",
  "hasSerialNumbers": false,
  "shippingLines": [
    {
      "metaFields": "",
      "orderLine": 1,
      "orderLineExternal": null,
      "itemCode": "16082",
      "itemDescription": "Jack Kabel 1m",
      "quantityOrdered": 1,
      "quantityDelivered": 1,
      "unit": "ST",
      "hasSerialNumbers": false,
      "bestBeforeDate": null,
      "lotNumber": "",
      "EANSSCC": "WICS2260"
    }
  ]
}

The json message delivered by the shipment webhook.

Topic Receipt

{
  "metaFields": "",
  "number": "1175",
  "reference": "WT 93",
  "receiptDate": "2021-09-13T00:00:00.000+02:00",
  "remarks": "",
  "warehouse": null,
  "stockStatusCode": null,
  "stockStatusDescription": null,
  "statusCode": null,
  "statusDescription": null,
  "hasSerialNumbers": false,
  "customerNumber": 0,
  "lines": [
    {
      "metaFields": "",
      "lineNumber": null,
      "itemCode": "WTI-027",
      "itemDescription": null,
      "quantityExpected": 0,
      "quantityReceived": 4,
      "unit": "ST",
      "statusCode": null,
      "statusDescription": null,
      "hasSerialNumbers": false,
      "bestBeforeDate": null,
      "lotNumber": "",
      "EANSSCC": "WICS2261",
      "stockStatusCode": "31",
      "stockStatusDescription": "Vrij",
    }
  ]
}

The json message delivered by the receipt webhook.

Topic Stock

{
  "itemCode": "CS1001",
  "itemDescription": "Pillow one size",
  "stockKeeping": null,
  "physical": 20639,
  "nettoSalable": 20599,
  "announced": 3,
  "customerNumber": 10011
}

The json message delivered by the stock webhook.

Topic StockMutation

{
    "EANSSCC": "WICS0885",
    "bestBeforeDate": null,
    "customerNumber": 14,
    "hasSerialNumbers": false,
    "itemCode": "16080",
    "location": "AA01A3",
    "lotNumber": "",
    "quantity": -1,
    "reasonCode": 10,
    "reasonCodeDescription": "Manuele creatie / mutatie",
    "registrationDate": "2022-05-02 T09:48:11.000+02:00",
    "stockKeepingUnit": "ST",
    "stockStatus": 31,
    "typeMove": 99,
    "warehouseCode": "WHS"
}

The json message delivered by the stockMutation webhook.

Topic Announcement status

{
    "announcementNr": 10344,
    "reference": "WT-2508-4",
    "statusCode": "00",
    "statusDescription": "Aangemaakt",
    "oldStatusCode": "",
    "oldStatusDescription": ""
}

The json message delivered by the announcementStatus webhook.

Topic Order status

{
  "orderNr": 10344,
  "orderReference": "WT-2508-4",
  "statusCode": "00",
  "statusDescription": "Aangemaakt",
  "oldStatusCode": "",
  "oldStatusDescription": ""
}

The json message delivered by the orderStatus webhook.

Topic OrderLineStatus

{
  "orderNr": 10344,
  "orderReference": "WT-2508-4",
  "lines": [
    {
      "lineNumber": 1,
      "statusCode": "30",
      "statusDescription": "Bevestigd",
      "oldStatusCode": "00",
      "oldStatusDescription": "Ingevoerd"
    },
    {
      "lineNumber": 1,
      "statusCode": "30",
      "statusDescription": "Bevestigd",
      "oldStatusCode": "",
      "oldStatusDescription": ""
    }
  ]
}

The json message delivered by the orderLineStatus webhook.

Topic PickslipLineStatus

{
  "orderNr": 9897,
  "orderReference": "Exact ShopOrder 1050",
  "lines": [{
    "lineNumber": 3,
    "statusCode": "60",
    "statusDescription": "Afgehandeld, volledige levering",
    "oldStatusCode": "40",
    "oldStatusDescription": "In uitvoering"
  }]
}

The json message delivered by the pickslipLineStatus webhook.

Topic RMA

{
    "orderReference": "200122",
    "lines": [{
        "lineNumber": 2,
        "itemCode": "WTI-028",
        "itemDescription": "Hans Test item 28",
        "quantity": 1,
        "questions": [{
            "questionNumber": 4,
            "question": "Is het artikel beschadigd?",
            "answerNumber": 2,
            "answer": "Ja"
        }]
    }]
}

The json message delivered by the RMA webhook.

Metafields

Introduction metafields

The metafield object allows you to store additional information for several entities, these are commonly used for third party applications.

You can send special data in the metafields which will be later sent back to your application. For example: your application has a unique identifier (orderline number GUID), when this data is sent to create order in WICS, you will receive this back in the shipment. So you can match the shipment data to your own identifier in the metafields.

A metafield consists of a key and and a value in JSON.

Supported methods

On the following methods are the metafields available:
Announcement header
Announcement lines
Receipt header
Receipt lines
Order header
Order lines
Shipment lines

Examples

Example 1

{
  "metaFields": {
    "wishlist": "WISH_1024"
  }
}

Metafields must be described in json, they can be simply added by a property:

Example 2

{
  "metaFields": {
    "ERP_App": {
      "division": 2479893,
      "guid": "99566b2c-27dd-47d4-b7dc-492f048566c8"
    }
  }
}

If you wish to add more properties:

Example 3

{
    "reference": "API-1503-01",
    "plannedDate": "2022-05-25",
    "type": "005",
    "warehouse": "WHS",
    "door": "D02",
    "carrier": 9000000,
    "stockstatus": 31,
    "metaFields": {
        "wishlist": "WISH_1024"
    },
    "lines": [
        {
            "lineNumber": 1,
            "itemCode": "16080",
            "itemDescription": "Jack Kabel 16080",
            "quantityExpected": 1,
            "metaFields": {
                "Webshop_app": {
                    "external_line": 73.0,
                    "guid": "444d244f-b881-4b0a-91c1-0c7bb63ed558"
                }
            },
            {
                "lineNumber": 2,
                "itemCode": "16081",
                "itemDescription": "UTO Kabel",
                "quantityExpected": 2,
                "metaFields": {
                    "Webshop_app": {
                        "external_line": 74.0,
                        "guid": "809eee3f-4b32-431d-bd3c-316365c00ed5"
                    }
                }
            ]
        }

As long as they are valid JSON, you can add this to the defined enitities in WICS. For example create announcement:

Filters

The Service Layer provides an option to filter data on list endpoints.

The filters can be added to the url using query parameters. Example: The list order endpoint can be filtered by reference. The url to achieve this would be:

{{url}}/api/order?reference=YOURREFERENCE

You are not limited to filtering a single field. You can add as many filters as you want:

{{url}}/api/order?priority=1&method=WEB&webshopId=1

You can also use operators get results greater or less than a certain value. This url returns all stock items with a nettoSalable greater than or equal to 1000:

{{url}}/api/stock?nettoSalable[gte]=1000

You can also filter on date fields. This url returns all receipts with a receipt date equals to "2022-04-18"

{{url}}/api/receipt?receiptDate=2022-04-18

This url returns all receipts with a receipt date greater than or equals to "2022-04-18"

{{url}}/api/receipt?receiptDate[gte]=2022-04-18

The operator for each field are added starting with a [ and ending with a ]. If there is no operator supplied, the equals operator is used.

The following operators are available:

Operator Description
eq Equals
neq Not Equals
gt Greater then
lt Less then
gte Greater then equals
lte Less then equals

Login

GET
/api/login

The request returns the following JSON:

#HTTP/1.1 200 OK
{
    "code": 200,
    "message": "API User authenticated succesfully as {apikey} | My company name is: {company name} | My customer name is: {customer name}",
    "success": true,
    "data": null
}

To verify the credentials you can use the login endpoint. This endpoint does nothing except verify your credentials.

Announcements

List Announcements

GET
/api/announcement
{
  "code": 200,
  "message": "List of 20 announcements",
  "success": true,
  "data": [
    {
      "number": "2454",
      "reference": "PO150001",
      "plannedDate": "2022-08-15",
      "type": "005",
      "warehouseCode": "WHS",
      "supplier": 0,
      "carrier": 0,
      "stockStatus": 31
    },
    {...},
  ]
}

This endpoint retrieves all the announcements.

This endpoint can be filtered

Query Parameters

Parameter Type Description
page Integer If supplied the results will show the page listed.
pageSize Integer If supplied te number of result will be the amount listed.

Field descriptions

Field Type Description Format
number * String The wics identifier of the announcement
reference * String The reference of the announcement.
additionalReference String The additional reference of the announcement.
plannedDate * String The date that the announcement is planned. (YYYY-MM-DD)
type String The announcement type of the announcement. Note: This field is optional.
warehouseCode String The warehouse code for the the announcement.
supplier Integer The supplier number of the announcement.
carrier Integer The carrier code for the announcement.
stockStatus * Integer The stock status code where the announcement should be received.

Get Announcement

GET
/api/announcement/{identifier}
{
  "code": 200,
  "message": "Announcement PO150001",
  "success": true,
  "data": {
    "number": "2453",
    "reference": "PO150001",
    "plannedDate": "2022-08-14",
    "type": "005",
    "warehouseCode": "WHS",
    "supplier": 0,
    "carrier": 0,
    "stockStatus": 31,
    "lines": [
      {
        "lineNumber": 1,
        "itemCode": "16080",
        "itemDescription": "Jack Kabel 16080",
        "unit": "ST",
        "quantityExpected": 30,
        "lotNumber": "6851993",
        "bestBeforeDate": "2024-02-14"
      }
    ]
  }
}

This endpoint retrieves a announcement.

Field descriptions

Field Type Description Format
number * String The wics identifier of the announcement
reference * String The reference of a announcement.
additionalReference String The additional reference of the announcement.
plannedDate * String The date that the announcement is planned. (YYYY-MM-DD)
type String The announcement type of the announcement. Note: This field is optional.
warehouseCode String The warehouse code for the the announcement.
door String The door code of the warehouse.
supplier Integer The supplier number of the announcement.
carrier Integer The carrier code for the announcement.
stockStatus * Integer The stock status code where the announcement should be received.

Announcement lines

Field Type Description Format
lineNumber Integer The current linenumber of the announcement line.
itemCode* String The identifier of an item.
itemDescription String The description of an item.
unit String The unit of an item.
quantityExpected* Integer The amount of an item.
lotNumber* String A lotnumber of an item.
bestBeforeDate* String A bestbefore date of an item.

Create Announcement

POST
/api/announcement
{
  "reference": "PO150002",
  "additionalReference": "amazon",
  "plannedDate": "2022-08-12",
  "type": "005",
  "warehouse": "WHS",
  "door": "D01",
  "carrier": 9000000,
  "stockStatus": 31,
  "supplier": 86,
  "lines": [
    {
      "lineNumber": 1,
      "itemCode": "16082",
      "itemDescription": "Jack Kabel 1m",
      "unit": "ST",
      "quantityExpected": 1,
      "lotNumber": "6851993",
      "bestBeforeDate": "2024-02-14"
    }
  ]
}

This endpoint creates a announcement.

Field descriptions The fields marked with a asterix (*) are required.

Field Type Description Format
reference * String The reference of the announcement.
additionalReference String The additional reference of the announcement.
plannedDate * String The date that the announcement is planned. (YYYY-MM-DD)
type String The announcement type of the announcement. Note: This field is optional.
warehouseCode String The warehouse code for the the announcement.
door String The door code of the warehouse.
supplier Integer The supplier number of the announcement.
carrier Integer The carrier code for the announcement.
stockStatus * Integer The stock status code where the announcement should be received.
supplier * Integer The addressnumber for the supplier you want to use.

Announcement lines

Field Type Description Format
lineNumber Integer The current linenumber of the announcement line.
itemCode* String The identifier of an item.
itemDescription String The description of an item.
unit String The unit you want to use.
quantityExpected* Integer The amount of an item.
lotNumber* String A lotnumber of an item.
bestBeforeDate* String A bestbefore date of an item.

Update Announcement

PUT
/api/announcement/{identifier}
{
  "reference": "PO150003",
  "additionalReference": "bol",
  "plannedDate": "2024-08-30",
  "type": "007",
  "warehouse": "WHS",
  "door": "D45",
  "carrier": 9001000,
  "stockStatus": 30,
  "supplier": 14,
  "lines": [
    {
      "lineNumber": 1,
      "itemCode": "16082",
      "itemDescription": "Jack Kabel 1m",
      "unit": "PAL",
      "quantityExpected": 10,
      "lotNumber": "6851994",
      "bestBeforeDate": "2024-02-15"
    }
  ]
}

The request returns the following JSON:


{
  "code": 200,
  "message": "Announcement with number <Identifier> has been updated.",
  "success": true,
  "data": [
    "<identifier>"
  ]
}

This endpoint updates an announcement.

Field descriptions

Field Type Description Format
reference String The reference of the announcement.
additionalReference String The additional reference of the announcement.
plannedDate String The date that the announcement is planned. (YYYY-MM-DD)
type String The announcement type of the announcement. Note: This field is optional.
warehouseCode String The warehouse code for the the announcement.
door String The door code of the warehouse.
supplier Integer The supplier number of the announcement.
carrier Integer The carrier code for the announcement.
stockStatus Integer The stock status code where the announcement should be received.
supplier Integer The addressnumber for the supplier you want to use.

Announcement lines

Field Type Description Format
lineNumber Integer The current linenumber of the announcement line.
itemCode String The identifier of an item.
itemDescription String The description of an item.
unit String The unit you want to use.
quantityExpected Integer The amount of an item.
lotNumber String A lotnumber of an item.
bestBeforeDate String A bestbefore date of an item.

Delete Announcement

DELETE
/api/announcement/{identifier}

This endpoint deletes a announcement.

Receipts

List Receipts

GET
/api/receipt

This endpoint retrieves all the receipts.

This endpoint can be filtered

{
  "code": 200,
  "message": "List of 20 receipts",
  "success": true,
  "data": [
    {
      "number": "1564",
      "reference": "PO15001",
      "receiptDate": "2022-08-16",
      "warehouse": "WHS",
      "stockStatusCode": "31",
      "stockStatusDescription": "Vrij",
      "typeCode": "005",
      "typeDescription": "Normaal, wel naar RF",
      "statusCode": "60",
      "statusDescription": "Opgeslagen",
      "hasSerialNumbers": false,
      "customerNumber": 14
    },
    {...}
  ]
}

Field descriptions

Field Type Description Format
number String The identifier of the receipt.
reference String The reference of the receipt.
receiptDate String The date of the receipt. (YYYY-MM-DD)
warehouseCode String The warehouse where the item is stored.
stockStatusCode String The identifier of the stock status.
stockStatusDescription String The description of the stock status.
typeCode String The identifier of a type.
typeDescription String The description of the type of the receipt.
statusCode String The identifier of the status.
statusDescription String The description of the status.
hasSerialNumbers Boolean Shows if there is a serialnumber present for the receipt.
customerNumber Integer The customer number that request the receipts.

Get Receipt

GET
/api/receipt/{identifier}

This endpoint returns a receipt for a specific identifier.

{
  "code": 200,
  "message": "Receipt 1625",
  "success": true,
  "data": {
    "number": "1625",
    "reference": "200116 - 1",
    "receiptDate": "2022-06-24",
    "warehouse": "WHS",
    "stockStatusCode": "31",
    "stockStatusDescription": "Vrij",
    "typeCode": "005",
    "typeDescription": "Normaal, wel naar RF",
    "statusCode": "60",
    "statusDescription": "Opgeslagen",
    "hasSerialNumbers": false,
    "customerNumber": 14,
    "lines": [
      {
        "lineNumber": 1,
        "itemCode": "WTI-030",
        "itemDescription": "TESTING",
        "quantityExpected": 10,
        "quantityReceived": 10,
        "unit": "ST",
        "statusCode": "60",
        "statusDescription": "Opgeslagen",
        "stockStatusCode": "31",
        "stockStatusDescription": "Vrij",
        "hasSerialNumbers": false,
        "warehouseCode": "WHS",
        "EANSSCC": "WICS2881"
      }
    ]
  }
}

Field descriptions

Field Type Description Format
number String The identifier of the receipt.
reference String The reference of the receipt.
receiptDate String The date of the receipt. (YYYY-MM-DD)
warehouseCode String The warehouse where the item is stored.
customerNumber Integer The customer number that request the receipts.
stockStatusCode String The identifier of the stock status.
stockStatusDescription String The description of the stock status.
typeCode String The identifier of a type.
typeDescription String The description of the type of the receipt.
statusCode String The identifier of the status.
statusDescription String The description of the status.
hasSerialNumbers Boolean Shows if there is a serialnumber present for the receipt.

Receipt line

Field Type Description
lineNumber Integer The current linenumber of the receipt line.
itemCode String The identifier of an item.
itemDescription String The description of an item.
quantityReceived Integer The quantity that is received.
quantityExpected Integer The quantity that is expected.
unit String The unit of the component.
statusCode String The identifier of the status of the receipt line.
statusDescription String The description of the status of the receipt line.
stockStatusCode String The identifier of the stock status.
stockStatusDescription String The description of the stock status.
hasSerialNumbers Boolean Shows if there is a serialnumber present for the receipt.
bestBeforeDate String The best before date of this quantity on this receipt line.
lotNumber String The lotnumber of this quantity on this receipt line.
EANSSCC String The EANSSCC of this quantity on this receipt line.
warehouseCode String The warehouse where the receipt is used.

List serial numbers for receipt

GET
/api/receipt/{identifier}/serialnumber
{
  "code": 200,
  "message": "List of 2 serialnumbers",
  "success": true,
  "data": [
    {
      "itemCode": "190140",
      "description": "DIN Kabel",
      "lineNumber": 1,
      "serialNumbers": [
        [
          "TB001"
        ],
        [
          "TB002"
        ],
        [
          "TB003"
        ],
        [
          "TB004"
        ],
        [
          "TB005"
        ]
      ]
    },
    {
      "itemCode": "190130",
      "description": "XLR Kabel",
      "lineNumber": 2,
      "serialNumbers": [
        [
          "TB01AA"
        ],
        [
          "TB02AA"
        ],
        [
          "TB03AA"
        ],
        [
          "TB04AA"
        ],
        [
          "TB05AA"
        ],
        [
          "TB06AA"
        ],
        [
          "TB07AA"
        ]
      ]
    }
  ]
}

This endpoint retrieves serial numbers for a receipt.

Field descriptions

Field Type Description Format
itemCode String The identifier of an item.
description String The description of an item.
lineNumber String The current linenumber of the receipt.
serialNumbers Array A list of serialnumbers related to the receipt

Orders

List Orders

GET
/api/order
{
  "code": 200,
  "message": "List of 20 orders",
  "success": true,
  "data": [
    {
      "number": "13291",
      "reference": "000123666",
      "deliveryDate": "2022-08-10",
      "pickupPoint": "null",
      "method": "POR",
      "webshopId": 1,
      "paid": true,
      "priority": 2,
      "rideNumber": 0,
      "termsOfDelivery": "CPT",
      "ride": {
        "number": 0,
        "routeCode": "null",
        "stopNumber": 0
      },
      "statusCode": "Bevestigd",
      "prices": {
        "currency": "null",
        "totalPriceNet": 0,
        "totalPriceGross": 0,
        "totalDiscount": 0,
        "handlingCost": 0,
        "shippingCost": 0,
        "rembours": 0
      },
      "invoiceAddress": {
        "number": 0,
        "name": "Dennis van Schaik",
        "nameExtension": ".",
        "company": "CrossMotion",
        "street": "Betuwehaven",
        "streetNumber": 16,
        "zipcode": "1234",
        "city": "Antwerpen",
        "country": "NL",
        "phoneNumber": "12345678941",
        "email": "dennis@crossmotion.nl",
        "language": "NL"
      },
      "deliveryAddress": {
        "number": 0,
        "name": "Dennis van Schaik",
        "nameExtension": ".",
        "company": "CrossMotion",
        "street": "Betuwehaven",
        "streetNumber": 16,
        "zipcode": "1234",
        "city": "Antwerpen",
        "country": "NL",
        "phoneNumber": "12345678941",
        "email": "dennis@crossmotion.nl",
        "language": "NL"
      }
    },
    {
      ...
    }
  ]
}

This endpoint retrieves orders.

This endpoint can be filtered

Query Parameters

Parameter Type Description
page Integer If supplied the results will show the page listed.
pageSize Integer If supplied te number of result will be the amount listed.

Field descriptions

Field Type Description Format
reference String The reference of a order.
additionalReference String The additional reference of a order.
deliveryDate String The date that the order should be delivered. (YYYY-MM-DD)
webshopId Integer The identifier that corresponds to the webshop account of Transmart or Paazl.
note String A note that will shown alongside the order.
shippingTag or tag String A shippingTag or tag that is linked with a shipment option in WICS.
pickupPoint String A place for picking up the order.
termsOfDelivery String The delivery condition.
method String The order method.
type String The order type of the order. Note: This field is optional.
priority Integer The priority of an order. (Can be 1: high, 2:medium or 3:low).
rideNumber Integer The ride number of an order.

Ride (Order header)

Field Type Description Format
number Decimal
routeCode String
stopNumber Decimal

Prices (Order header)

Field Type Description Format
currency String The currency code
totalPriceNet Decimal
totalPriceGross Decimal
totalDiscount Decimal
handlingCost Decimal
shippingCost Decimal
rembours Decimal

Invoice address

Field Type Description Format
name String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber Integer The streetnumber of the address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode String The zipcode of the address.
city String The city of the address.
state String The state of the address.
country String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person .
email String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Delivery address

Field Type Description Format
name String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode String The zipcode of the address.
city String The city of the address.
state String The state of the address.
country String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person .
email String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Order lines

Field Type Description Format
lineNumber Integer The current linenumber of the orderline.
itemCode String The identifier of an item.
itemDescription String The description of an item.
quantity Integer The amount of an item.
variantCode String The variant code of the item.
salesUnitCode String The unit code of the item. For example: ST.

Prices (Order line)

Field Type Description Format
vatPercentage Decimal
unitPriceNet Decimal
unitPriceGross Decimal
priceNet Decimal
priceGross Decimal
discount Decimal

Get Order

GET
/api/order/{identifier}

This endpoint retrieves an order.

{
  "code": 200,
  "message": "Order SO510001",
  "success": true,
  "data": {
    "number": "13295",
    "reference": "SO510001",
    "additionalReference": "153266",
    "deliveryDate": "2022-08-15",
    "note": "Inpakken met cadeaupapier",
    "pickupPoint": "134",
    "termsOfDelivery": "CPT",
    "method": "WEB",
    "webshopId": 2,
    "paid": true,
    "warehouseCode": "whs",
    "priority": 2,
    "rideNumber": 160622,
    "ride": {
      "number": 160622,
      "routeCode": "400",
      "stopNumber": 4
    },
    "statusCode": "Bevestigd",
    "edi": {
      "char2": "",
      "char3": "",
      "char4": "",
      "char5": "",
      "char6": "",
      "char7": "",
      "char8": "",
      "char9": "",
      "char10": ""
    },
    "prices": {
      "currency": "EUR",
      "totalPriceNet": 12,
      "totalPriceGross": 10,
      "totalDiscount": 0,
      "handlingCost": 1,
      "shippingCost": 2,
      "rembours": 3
    },
    "invoiceAddress": {
      "number": 0,
      "name": "Hans de Groot",
      "nameExtension": ".",
      "street": "Concordiaweg",
      "streetNumber": 157,
      "extension": "A",
      "secondAddressLine": "Bovenste verdieping",
      "zipcode": "4206BK",
      "city": "Gorinchem",
      "state": "Zuid-Holland",
      "country": "NL",
      "phoneNumber": "0183507020",
      "email": "info@wics.nl",
      "language": "NL"
    },
    "deliveryAddress": {
      "number": 0,
      "name": "Hans de Groot",
      "nameExtension": ".",
      "street": "Concordiaweg",
      "streetNumber": 157,
      "extension": "A",
      "secondAddressLine": "Bovenste verdieping",
      "zipcode": "4206BK",
      "city": "Gorinchem",
      "state": "Zuid-Holland",
      "country": "NL",
      "phoneNumber": "0183507020",
      "email": "info@wics.nl",
      "language": "NL"
    },
    "lines": [
      {
        "lineNumber": 10001,
        "itemCode": "16082",
        "itemDescription": "Jack kabel 1m",
        "quantity": 1,
        "quantityDelivered": 0,
        "unit": "DS",
        "prices": {
          "unitPriceNet": 0,
          "unitPriceGross": 0,
          "priceNet": 0,
          "priceGross": 0,
          "vatPercentage": 0,
          "discount": 0
        }
      },
      {
        "lineNumber": 20002,
        "itemCode": "16084",
        "itemDescription": "Speaker kabel",
        "quantity": 4,
        "quantityDelivered": 0,
        "unit": "ST",
        "prices": {
          "unitPriceNet": 0,
          "unitPriceGross": 0,
          "priceNet": 0,
          "priceGross": 0,
          "vatPercentage": 0,
          "discount": 0
        }
      }
    ]
  }
}

Field descriptions

Field Type Description Format
reference String The reference of a order.
additionalReference String The additional reference of a order.
deliveryDate String The date that the order should be delivered. (YYYY-MM-DD)
webshopId Integer The identifier that corresponds to the webshop account of Transmart or Paazl.
note String A note that will shown alongside the order.
shippingTag or tag String A shippingTag or tag that is linked with a shipment option in WICS.
warehouseCode String The warehouse used for this order.
pickupPoint String A place for picking up the order.
termsOfDelivery String The delivery condition.
method String The order method.
type String The order type of the order. Note: This field is optional.
priority Integer The priority of an order. (Can be 1: high, 2:medium or 3:low).
rideNumber Integer The ride number of an order.

Ride (Order header)

Field Type Description Format
number Decimal
routeCode String
stopNumber Decimal

Prices (Order header)

Field Type Description Format
currency String The currency code
totalPriceNet Decimal
totalPriceGross Decimal
totalDiscount Decimal
handlingCost Decimal
shippingCost Decimal
rembours Decimal

Invoice address

Field Type Description Format
name* String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. May be empty on a foreign address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode* String The zipcode of the address.
city* String The city of the address.
state String The state of the address.
country* String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person.
email* String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Delivery address

Field Type Description Format
name* String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. May be empty on a foreign address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode* String The zipcode of the address.
city* String The city of the address.
state String The state of the address.
country* String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person.
email* String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Order lines

Field Type Description Format
lineNumber Integer The current linenumber of the orderline.
itemCode* String The identifier of an item.
itemDescription String The description of an item.
quantity* Integer The amount of an item.
variantCode String The variant code of the item.
salesUnitCode String The unit code of the item. For example: ST.

Prices (Order line)

Field Type Description Format
vatPercentage Decimal
unitPriceNet Decimal
unitPriceGross Decimal
priceNet Decimal
priceGross Decimal
discount Decimal

Lotnumbers (Order line)

Field Type Description Format
lotnumber String Lotnumber that will be reserved for the order.
quantity Integer The quantity of the reservation.

Create Order

POST
/api/order
{
  "reference": "SO510001",
  "additionalReference": "153266",
  "deliveryDate": "2022-08-15",
  "note": "Inpakken met cadeaupapier",
  "shippingTag": "Bezorgen bij een afhaalpunt",
  "pickupPoint": "134",
  "termsOfDelivery": "CPT",
  "method": "WEB",
  "webshopId": 2,
  "type": "STDRF",
  "priority": 2,
  "ride": {
    "number": 160622,
    "routeCode": "400",
    "stopNumber": 4
  },
  "texts": {
    "packingTable": "Reclame folder toevoegen."
  },
  "prices": {
    "totalPriceNet": 12.10,
    "totalPriceGross": 10,
    "totalDiscount": 0,
    "handlingCost": 1,
    "shippingCost": 2,
    "rembours": 3
  },
  "invoiceAddress": {
    "name": "Hans de Groot",
    "nameExtension": "",
    "company": "WICS",
    "street": "Concordiaweg",
    "streetNumber": 157,
    "extension": "A",
    "secondAddressLine": "Bovenste verdieping",
    "thirdAddressLine": "",
    "zipcode": "4206BK",
    "city": "Gorinchem",
    "state": "Zuid-Holland",
    "country": "NL",
    "phoneNumber": "0183507020",
    "mobileNumber": "",
    "email": "info@wics.nl",
    "language": "NL"
  },
  "deliveryAddress": {
    "name": "Hans de Groot",
    "nameExtension": "",
    "company": "WICS",
    "street": "Concordiaweg",
    "streetNumber": 157,
    "extension": "A",
    "secondAddressLine": "Bovenste verdieping",
    "thirdAddressLine": "",
    "zipcode": "4206BK",
    "city": "Gorinchem",
    "state": "Zuid-Holland",
    "country": "NL",
    "phoneNumber": "0183507020",
    "mobileNumber": "",
    "email": "info@wics.nl",
    "language": "NL"
  },
  "lines": [
    {
      "lineNumber": 10001,
      "itemCode": "16082",
      "itemDescription": "Jack kabel 1m",
      "quantity": 1,
      "prices": {
          "unitPriceNet": 11,
          "unitPriceGross": 12,
          "priceNet": 23,
          "priceGross": 15,
          "vatPercentage": 17,
          "discount": 20
      },
      "unit": "DS",
      "lotnumbers": [
       {
        "lotnumber": "4535",
        "quantity": 1
       },
       {
         "lotnumber": "3532",
         "quantity": 1
       }]
     },
    {
      "lineNumber": 20002,
      "itemCode": "16084",
      "itemDescription": "Speaker kabel",
      "quantity": 4
    }
  ]
}

The request returns the following JSON:

#HTTP/1.1 201 Created
{
"code": 201,
"message": "Order with number <Identifier> created successfully",
"success": true,
"data": [
"<identifier>"
]
}

This endpoint creates a order.

Field descriptions

Field Type Description Format
reference String The reference of a order.
additionalReference String The additional reference of a order.
deliveryDate * String The date that the order should be delivered. (YYYY-MM-DD)
paid Boolean Sets the order to a paid status or not Default: true
webshopId Integer The identifier that corresponds to the webshop account of Transmart or Paazl.
warehouseCode String The warehouse used for this order.
note String A note that will shown alongside the order.
shippingTag or tag String A shippingTag or tag that is linked with a shipment option in WICS.
pickupPoint String A place for picking up the order.
termsOfDelivery String The delivery condition.
method String The order method.
type String The order type of the order. Note: This field is optional.
priority Integer The priority of an order. (Can be 1: high, 2:medium or 3:low).

Ride (Order header)

Field Type Description Format
number Decimal
routeCode String
stopNumber Decimal

Prices (Order header)

Field Type Description Format
currency String The currency code.
totalPriceNet Decimal The total netto price.
totalPriceGross Decimal The total gross price.
totalDiscount Decimal The total amount of discount.
handlingCost Decimal The cost that are related to the handling.
shippingCost Decimal The cost that are related to shipping.
rembours Decimal Rembour costs.

Texts (Order header)

Field Type Description Format
picking String Text which shows on the picking
scanner String Text which shows on the scanner
packingTable String Text which shows on the packingtable
packingSlip String Text which shows on the packingslip
shippingLabel String Text which shows on the shippinglabel

Invoice address

Field Type Description Format
name* String The persons name of the address.
nameExtension String The additional name of a persons of the address.
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode* String The zipcode of the address.
city* String The city of the address.
state String The state of the address.
country* String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person.
email* String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Delivery address

Field Type Description Format
name* String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example housnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode* String The zipcode of the address.
city* String The city of the address.
state String The state of the address.
country* String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person.
email* String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Order lines

Field Type Description Format
lineNumber Integer The current linenumber of the orderline.
itemCode* String The identifier of an item.
itemDescription String The description of an item.
quantity* Integer The amount of an item.

Prices (Order line)

Field Type Description Format
vatPercentage Decimal The percentage of the VAT.
unitPriceNet Decimal The netto unit price.
unitPriceGross Decimal The gross unit price.
priceNet Decimal The netto price.
priceGross Decimal The gross price
discount Decimal The discount of the order line.

Lotnumbers (Order line)

Field Type Description Format
lotnumber String The lotnumber that will be used for the order line.
quantity Integer The amount of units that will be reserved.

Texts (Order line)

Field Type Description Format
picking String Text which shows on the picking
scanner String Text which shows on the scanner
packingTable String Text which shows on the packingtable
packingSlip String Text which shows on the packingslip

Update Order

PUT
/api/order/{identifier}
{
  "reference": "SO510001",
  "additionalReference": "153266",
  "deliveryDate": "2022-08-15",
  "note": "Inpakken met cadeaupapier",
  "shippingTag": "Bezorgen bij een afhaalpunt",
  "pickupPoint": "134",
  "termsOfDelivery": "CPT",
  "method": "WEB",
  "webshopId": 2,
  "type": "STDRF",
  "priority": 2,
  "ride": {
    "number": 160622,
    "routeCode": "4000",
    "stopNumber": 4
  },
  "texts": {
    "packingTable": "Reclame folder toevoegen."
  },
  "prices": {
    "totalPriceNet": 12.10,
    "totalPriceGross": 10,
    "totalDiscount": 0,
    "handlingCost": 1,
    "shippingCost": 2,
    "rembours": 3
  },
  "invoiceAddress": {
    "name": "Hans de Groot",
    "nameExtension": "",
    "company": "WICS",
    "street": "Concordiaweg",
    "streetNumber": 157,
    "extension": "A",
    "secondAddressLine": "Bovenste verdieping",
    "thirdAddressLine": "",
    "zipcode": "4206BK",
    "city": "Gorinchem",
    "state": "Zuid-Holland",
    "country": "NL",
    "phoneNumber": "0183507020",
    "mobileNumber": "",
    "email": "info@wics.nl",
    "language": "NL"
  },
  "deliveryAddress": {
    "name": "Hans de Groot",
    "nameExtension": "",
    "company": "WICS",
    "street": "Concordiaweg",
    "streetNumber": 157,
    "extension": "A",
    "secondAddressLine": "Bovenste verdieping",
    "thirdAddressLine": "",
    "zipcode": "4206BK",
    "city": "Gorinchem",
    "state": "Zuid-Holland",
    "country": "NL",
    "phoneNumber": "0183507020",
    "mobileNumber": "",
    "email": "info@wics.nl",
    "language": "NL"
  },
  "lines": [
    {
      "lineNumber": 10001,
      "itemCode": "16082",
      "itemDescription": "Jack kabel 1m",
      "quantity": 2,
      "unit": "DS"
    },
    {
      "lineNumber": 20002,
      "itemCode": "16084",
      "itemDescription": "Speaker kabel",
      "quantity": 5
    }
  ]
}

The request returns the following JSON:


{
  "code": 200,
  "message": "Order with number <Identifier> has been updated.",
  "success": true,
  "data": [
    "<identifier>"
  ]
}

This endpoint updates an order.

Field descriptions

Field Type Description Format
reference String The reference of a order.
additionalReference String The additional reference of a order.
deliveryDate String The date that the order should be delivered. (YYYY-MM-DD)
webshopId Integer The identifier that corresponds to the webshop account of Transmart or Paazl.
warehouseCode String The warehouse used for this order.
note String A note that will shown alongside the order.
shippingTag or tag String A shippingTag or tag that is linked with a shipment option in WICS.
pickupPoint String A place for picking up the order.
termsOfDelivery String The delivery condition.
type String The order type of the order. Note: This field is optional.

Ride (Order header)

Field Type Description Format
number Decimal
routeCode String
stopNumber Decimal

Prices (Order header)

Field Type Description Format
currency String The currency code
totalPriceNet Decimal
totalPriceGross Decimal
totalDiscount Decimal
handlingCost Decimal
shippingCost Decimal
rembours Decimal

Invoice address

Field Type Description Format
name* String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode* String The zipcode of the address.
city* String The city of the address.
state String The state of the address.
country* String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person .
email* String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Delivery address

Field Type Description Format
name* String The persons name of the address.
nameExtension String The additional name of a persons of the address
company String The company name of the address.
street String The streetname of the address.
streetNumber* Integer The streetnumber of the address. Note: It consists only of a number.
extension String The addition of the streetnumber. For example streetnumber 16 and extension B.
secondAddressLine String The second additional address line. For example: Second floor.
thirdAddressLine String The third additional address line. For example: Around the corner.
zipcode* String The zipcode of the address.
city* String The city of the address.
state String The state of the address.
country* String Two characters that consist of the country of the address.
phoneNumber String A phonenumber of the person.
mobileNumber String A mobile number of the person .
email* String A emailaddress of the person.
language String The language the order will be saved. Note: This will be used for custom documents in WICS.

Order lines

Field Type Description Format
lineNumber Integer The current linenumber of the orderline.
itemCode* String The identifier of an item.
itemDescription String The description of an item.
quantity* Integer The amount of an item. `

Prices (Order line)

Field Type Description Format
vatPercentage Decimal
unitPriceNet Decimal
unitPriceGross Decimal
priceNet Decimal
priceGross Decimal
discount Decimal

Delete Order

DELETE
/api/order/{identifier}

The request returns the following JSON:

#HTTP/1.1 200 OK
{
"code": 200,
"message": "<Identifier> deleted succesfully",
"success": true,
"data": null
}

This endpoint deletes a order.

List serial numbers for order

GET
/api/order/{identifier}/serialnumber

The request returns the following JSON:

#HTTP/1.1 200 OK
{
"code": 200,
"message": "List of 2 serial numbers",
"success": true,
"data": [
{
"itemCode": "16080",
"description": "Jack Kabel 16080",
"serialNumber": "4567895467868654"
},
{
"itemCode": "16080",
"description": "Jack Kabel 16080",
"serialNumber": "6754367545678568"
}
]
}

This endpoint retrieves serial numbers for an order.

Field descriptions

Field Type Description
itemCode String The identifier of an item.
description String The description label of an item.
serialNumber String The serialnumber that corresponds with the current order.

List shipments for order

GET
/api/order/{reference}/shipment

The request returns the following JSON:

#HTTP/1.1 200 OK
{
"code": 200,
"message": "List of 1 shipments",
"success": true,
"data": [
{
"shipmentNr": 20071,
"colloId": "6173",
"orderReference": "13217",
"additionalReference": "",
"shipperCode": "9000000",
"shipperName": "PostNL",
"trackAndTrace": "3SDEVC4119986",
"trackAndTraceUrl": "http://postnl.nl/tracktrace/?L=NL&B=3SDEVC4119986&P=4251%20BC&D=NL&T=C",
"hasSerialNumbers": false,
"shippingLines": [
{
"orderLine": 1,
"orderLineExternal": 1,
"itemCode": "16082",
"itemDescription": "Jack kabel 1m",
"quantityOrdered": 1,
"quantityDelivered": 1,
"unit": "ST",
"hasSerialNumbers": false,
"EANSSCC": "WICS1738"
}
]
}
]
}

This endpoint retrieves all the shipments for orders.

Field descriptions

Field Type Description
shipmentNr Integer The identifier of a shipment.
colloId Integer The identifier of a shipment.
orderReference String The reference of an order.
additionalReference String An additional reference of an order.
shipperCode String Corresponds to the addressnumber of the carrier.
shipperName String Corresponds to name of the carrier.
trackAndTrace String The label code of the track and trace.
trackAndTraceUrl String The uniform resource locator (url) of the track and trace, also known as the https link.
hasSerialNumbers Boolean Shows if there is a serialnumber present for the shipment.

Shipment line

Field Type Description
orderLine Integer The current linenumber of the shipmentline.
orderLineExternal Integer The current extnal line number of the shipmentline.
itemCode String The identifier of an item.
itemDescription String The description of an item.
quantityOrdered Integer The amount that has been ordered.
quantityDelivered Integer The amount that has been delivered.
unit String The unit of the item. For example: ST.
bestBeforeDate String The best before date of this quantity on this shipment line
lotNumber String The lotnumber of this quantity on this shipment line
EANSSCC String The EANSSCC of this quantity on this shipment line

Paid Order

POST
/api/order/{reference}/paid

The request returns the following JSON:

#HTTP/1.1 200 OK
{
"code": 200,
"message": "Succesfully set order to paid <Identifier>",
"success": true,
"data": null
}

This endpoint set an order to paid.

Items

List Items

GET
/api/item

The request returns the following JSON:

{
  "code": 200,
  "message": "List of 20 items",
  "success": true,
  "data": [
    {
      "code": "001-0203",
      "internalDescription": "Honeycomb",
      "description": "Honeycomb",
      "itemGroup": "ALG",
      "defaultUnit": "DR",
      "assembled": false,
      "statusCode": "30"
    },
    {...},
  ]
}

This endpoint returns a list of items.

This endpoint can be filtered

Field descriptions

Field Type Description
code String The identifier of an item.
internalDescription String The internal description of an item.
description String The description of an item.
assembled Boolean True or false if the item is assembled.
assemblyType String If the item is assembled the type can be set with picking or stock.
itemGroup String The itemgroup of the item.
defaultUnit String The default unit of the item.
statusCode Integer Status of the item.
barcode String A barcode can be set on the item.

Convert EAN

GET
/api/item/ean-item/{EAN}

The request returns the following JSON:

#HTTP/1.1 200 OK
{
  "code": 200,
  "message": "Found itemcode for EAN 1274",
  "success": true,
  "data": "16082"
}

This endpoint converts a EAN to item code.

Convert Item Code

GET
/api/item/item-ean/{itemCode}

The request returns the following JSON:

#HTTP/1.1 200 OK
{
  "code": 200,
  "message": "Found EAN for item code VAR006",
  "success": true,
  "data": "00000000000918"
}

This endpoint converts an item code to EAN.

Create Item

POST
/api/item
{
  "code": "starterset-01",
  "description": "School startset",
  "internalDescription": "School startset",
  "assembled": false,
  "itemGroup": "DIV",
  "defaultUnit": "ST",
  "statusCode": 30,
  "weight": "3.75",
  "bestBefore": {
    "receiptDateEntry": "bestbefore",
    "bestBeforePeriod": 10,
    "quarantinePeriod": 20,
    "warrantyPeriod": 30
  },
  "units": [
    {
      "unit": "ST",
      "length": 13,
      "width": 5,
      "height": 7,
      "amountSKU": 1,
      "barcode": "1398854674"
    },
    {
      "unit": "DS",
      "length": 130,
      "width": 50,
      "height": 70,
      "amountSKU": 5,
      "barcode": "8710405785"
    }
  ],
  "warehouses": [
    {
      "code": "WHS",
      "minimumQuantity": 1,
      "maximumQuantity": 9999,
      "safeQuantity": 10,
      "reorderQuantity": 1
    }
  ]
}

The request returns the following JSON:

#HTTP/1.1 201 Created
{
    "code": 201,
    "message": "Item with <Identifier> created successfully",
    "success": true,
    "data": null
}

This endpoint creates an item.

Field descriptions

Field Type Description
code String The identifier of an item.
description String The description of an item.
internalDescription String The internal description of an item. The maximum number of characters is 40. Note: This is only required for WICS.
assembled Boolean True or false if the item is assembled.
assemblyType String If the item is assembled the type can be set with picking or stock.
barcode String The barcode of the item.
itemGroup String The itemgroup of the item.
defaultUnit String The default unit of the item.
safetyDataSheet String The number that is used when using dangerous goods.
statusCode Integer Status of the item.
traceability String The management type. Can be lot, serialnumber or none.
barcode String A barcode can be set on the item.
weight Decimal The weight of the item.

Best before

If bestBefore information is supplied the outbound algorithm of the item will be set to FEFO.

Field Type Description Format
receiptDateEntry String The entry type. Can be bestbefore or production.
bestBeforePeriod Integer The number of days for best before.
quarantinePeriod Integer The number of days for the quarantine.
warrantyPeriod Integer The number of days for the warranty.

Components

Field Type Description Format
code String The itemcode of the component.
skuCode String The unit of the component.
quantity BigDecimal The quantity of this component.

Units

Field Type Description Format
unit String The identifier of an item.
width BigDecimal The width dimension of an item.
length BigDecimal The length dimension of an item.
height BigDecimal The height of an item.
amountSKU Integer The description of an item.
barcode String The barcode for a unit.

Warehouses

Field Type Description Format
code String The identifier of an item.
minimumQuantity Integer The minimum quantity in the warehouse.
maximumQuantity Integer The maximum quantity in the warehouse.
safeQuantity Integer The safe quantity in the warehouse.
reorderQuantity Integer The reorder quantity in the warehouse.

Create Items

POST
/api/item/list
[
  {
    "code": "starterset-01",
    "description": "School startset",
    "internalDescription": "School startset",
    "assembled": false,
    "itemGroup": "DIV",
    "defaultUnit": "ST",
    "statusCode": 30,
    "weight": "3.75",
    "bestBefore": {
      "receiptDateEntry": "bestbefore",
      "bestBeforePeriod": 10,
      "quarantinePeriod": 20,
      "warrantyPeriod": 30
    },
    "units": [{
      "unit": "ST",
      "length": 13,
      "width": 5,
      "height": 7,
      "amountSKU": 1
    },
      {
        "unit": "DS",
        "length": 130,
        "width": 50,
        "height": 70,
        "amountSKU": 5
      }
    ],
    "warehouses": [{
      "code": "WHS",
      "minimumQuantity": 1,
      "maximumQuantity": 9999,
      "safeQuantity": 10,
      "reorderQuantity": 1
    }]
  },
  {...}
]

The request returns the following JSON:

#HTTP/1.1 201 Created
{
    "code": 201,
    "message": "Item with <Identifier> created successfully",
    "success": true,
    "data":  null
}

This endpoint creates items.

Field descriptions

Field Type Description
code String The identifier of an item.
internalDescription String The internal description of an item. The maximum number of characters is 40. Note: This is only required for WICS.
description String The description of an item.
assembled Boolean True or false if the item is assembled.
assemblyType String If the item is assembled the type can be set with picking or stock.
itemGroup String The itemgroup of the item.
defaultUnit String The default unit of the item.
statusCode Integer Status of the item.
safetyDataSheet String The number that is used when using dangerous goods.
traceability String The management type. Can be lot, serialnumber or none.
barcode String A barcode can be set on the item.
weight Decimal The weight of the item.

Best before

Field Type Description Format
receiptDateEntry String The entry type. Can be lot, serial or none.
bestBeforePeriod Integer The number of days for best before.
quarantinePeriod Integer The number of days for the quarantine.
warrantyPeriod Integer The number of days for the warranty.

Components

Field Type Description Format
code String The itemcode of the component.
skuCode String The unit of the component.
quantity BigDecimal The quantity of this component.

Units

Field Type Description Format
unit String The identifier of an item.
width BigDecimal The width dimension of an item.
length BigDecimal The length dimension of an item.
height BigDecimal The height of an item.
amountSKU Integer The description of an item.
barcode String The barcode for a unit.

Warehouses

Field Type Description Format
code String The identifier of an item.
minimumQuantity Integer The minimum quantity in the warehouse.
maximumQuantity Integer The maximum quantity in the warehouse.
safeQuantity Integer The safe quantity in the warehouse.
reorderQuantity Integer The reorder quantity in the warehouse.

Update Item

PUT
/api/item/{identifier}
{
  "statusCode": 10,
  "weight": "1"
}

The request returns the following JSON:


{
    "code": 200,
    "message": "Item with number <Identifier> has been updated.",
    "success": true,
    "data": [
      "<identifier>"
    ]
}

This endpoint updates an item.

Field descriptions

Field Type Description
description String The description of an item.
assembled Boolean True or false if the item is assembled.
defaultUnit String The default unit of the item.
safetyDataSheet String The number that is used when using dangerous goods.
statusCode Integer Status of the item.
traceability String The management type. Can be lot, serialnumber or none.
weight Decimal The weight of the item.

Best before

Field Type Description Format
receiptDateEntry String The entry type. Can be lot, serial or none.
bestBeforePeriod Integer The number of days for best before.
quarantinePeriod Integer The number of days for the quarantine.
warrantyPeriod Integer The number of days for the warranty.

Units

Field Type Description Format
width BigDecimal The width dimension of an item.
length BigDecimal The length dimension of an item.
height BigDecimal The height of an item.
amountSKU Integer The description of an item.
barcode String The barcode for a unit.

Shipment

List serial numbers for shipment

GET
/api/shipment/{identifier}/serialnumber

The request returns the following JSON:

#HTTP/1.1 200 OK
{
  "code": 200,
  "message": "List of 2 serialnumbers",
  "success": true,
  "data": [
    {
      "itemCode": "16080",
      "description": "Jack Kabel 16080",
      "lineNumber": 1,
      "serialNumbers": [
        [
          "4444444444444445"
        ]
      ]
    },
    {
      "itemCode": "16080",
      "description": "Jack Kabel 16080",
      "lineNumber": 2,
      "serialNumbers": [
        [
          "4444444444444446"
        ]
      ]
    }
  ]
}

This endpoint retrieves serial numbers for a shipment.

Field descriptions

Field Type Description Format
itemCode String The identifier of an item.
description String The description of an item.
lineNumber String The current linenumber of the order.
serialNumbers Array A list of serialnumbers related to the shipment

Stock

List serial numbers by EANSSCC

GET
/api/stock/{EANSSCC}/serialnumber

The request returns the following JSON:

#HTTP/1.1 200 OK
{
    "code": 200,
    "message": "List of 7 serialnumbers",
    "success": true,
    "data": [
        {
            "itemCode": "190130",
            "description": "XLR Kabel",
            "lineNumber": 0,
            "serialNumbers": [
                [
                    "TB01AA",
                    "TB02AA",
                    "TB03AA",
                    "TB04AA",
                    "TB05AA",
                    "TB06AA",
                    "TB07AA"
                ]
            ]
        }
    ]
}

This endpoint returns a list of serialnumbers found by EANSSCC.

Field descriptions

Field Type Description Format
itemCode String The identifier of an item.
description String The description of an item.
serialNumbers Array A list of serialnumbers for the given EANSSCC

List stock items

GET
/api/stock

The request returns the following JSON:

#HTTP/1.1 200 OK
{
    "code": 200,
    "message": "List of 47 items",
    "success": true,
    "data": [
        {
            "itemCode": "PEN001",
            "itemDescription": "Pen blauw 001",
            "physical": 25,
            "nettoSalable": 23,
            "announced": 3,
            "customerNumber": 14,
            "warehouses": [{
                  "announced": 2,
                  "physical": 10,
                  "nettoSalable": 10,
                  "warehouseCode": "WXS"
              },
              {
                  "announced": 3,
                  "physical": 25,
                  "nettoSalable": 23,
                  "warehouseCode": "WHS"
              }]
        },
        {
            "itemCode": "A001",
            "itemDescription": "Money Box Elephant",
            "physical": 250,
            "nettoSalable": 141,
            "announced": 116,
            "customerNumber": 14
            "warehouses": [{
                  "announced": 116,
                  "physical": 250,
                  "nettoSalable": 141,
                  "warehouseCode": "WHS"
            }]
        },...
    ]
}

This endpoint returns a list of stock items.

This endpoint can be filtered

Query Parameters

Parameter Type Description
page Integer If supplied the results will show the page listed.
pageSize Integer If supplied te number of result will be the amount listed.

Field descriptions

Field Type Description
itemCode String The identifier of an item.
itemDescription String The description of an item.
physical String Stock that is allocated physically.
nettoSalable String Stock that can be sold.
customerNumber Integer The customer number of which the stock is being requested.

Warehouses

Field Type Description Format
announced Integer Stock that has been announced.
physical Integer Stock that is allocated physically.
nettoSalable Integer Stock that can be sold.
warehouseCode String The warehouse that is used.

Get stock item

GET
/api/stock/{itemCode}

The request returns the following JSON:

{
  "code": 200,
  "message": "Stock 16080",
  "success": true,
  "data": {
    "itemCode": "16080",
    "itemDescription": "Jack Kabel 16080",
    "physical": 40565,
    "nettoSalable": 10387,
    "announced": 1411,
    "customerNumber": 14,
    "warehouses": [
      {
        "announced": 1411,
        "physical": 40565,
        "nettoSalable": 10387,
        "warehouseCode": "WHS"
      },
      {
        "announced": 61,
        "physical": 364,
        "nettoSalable": 364,
        "warehouseCode": "WXS"
      }
    ]
  }
}

This endpoint returns a stock item.

Field descriptions

Field Type Description
itemCode String The identifier of an item.
itemDescription String The description of an item.
physical String Stock that is allocated physically.
nettoSalable String Stock that can be sold.
customerNumber Integer The customer number of which the stock is being requested.

Warehouses

Field Type Description Format
announced Integer Stock that has been announced.
physical Integer Stock that is allocated physically.
nettoSalable Integer Stock that can be sold.
warehouseCode String The warehouse that is used.

List stock detail

GET
/api/stock/detail

Query Parameters

Parameter Type Description
page Integer If supplied the results will show the page listed.
pageSize Integer If supplied te number of result will be the amount listed.

The request returns the following JSON:

{
  "code": 200,
  "message": "List of 20 stock details",
  "success": true,
  "data": [
    {
      "itemCode": "16082",
      "itemDescription": "Jack Kabel 1m",
      "customerNr": 14,
      "warehouseCode": "WHS",
      "location": "AA02D4",
      "stockStatusCode": "02",
      "stockStatusDescription": "In picking/batchpicking",
      "bestBefore": "2024-11-11",
      "lotNumber": "654321",
      "quantitySKU": 1,
      "skuCode": "ST",
      "quantityHU": 1,
      "huCode": "ST",
      "eansscc": "WICS0541"
    },
    {...},
  ]
}

This endpoint returns a list of stock details.

This endpoint can be filtered

Field descriptions

Field Type Description Format
itemCode String The identifier of an item.
itemDescription String The description of an item.
customerNr Integer The customer number in WICS.
warehouseCode String The warehouse where the item is stored.
location String The location where the item is stored.
stockStatusCode String The identifier of the stock status.
stockStatusDescription String The description of the stock status.
bestBefore String The date that the item is preserved. (YYYY-MM-DD)
lotNumber String The identifier when useing lotnumbers.
eansscc String The barcode of the item.
skuCode String The stock keeping unit identifier.
quantitySKU Integer The quantity of the stock keeping unit.
huCode String The handling unit identifier.
quantityHU Integer The quantity of the handling unit.

Get stock detail

GET
/api/stock/{itemCode}/detail

The request returns the following JSON:

{
  "code": 200,
  "message": "List of 20 stock details",
  "success": true,
  "data": [
    {
      "itemCode": "16082",
      "itemDescription": "Jack Kabel 1m",
      "customerNr": 14,
      "warehouseCode": "WHS",
      "location": "AA02D4",
      "stockStatusCode": "02",
      "stockStatusDescription": "In picking/batchpicking",
      "bestBefore": "2024-11-11",
      "lotNumber": "654321",
      "quantitySKU": 1,
      "skuCode": "ST",
      "quantityHU": 1,
      "huCode": "ST",
      "eansscc": "WICS0541"
    },
    {
      "itemCode": "16082",
      "itemDescription": "Jack Kabel 1m",
      "customerNr": 14,
      "warehouseCode": "WHS",
      "location": "BA01B1",
      "stockStatusCode": "02",
      "stockStatusDescription": "In picking/batchpicking",
      "bestBefore": null,
      "lotNumber": "",
      "quantitySKU": 10,
      "skuCode": "ST",
      "quantityHU": 10,
      "huCode": "ST",
      "eansscc": "WICS1738"
    },
    {...},
  ]
}

This endpoint returns a list of stock details for a specific item.

Field descriptions

Field Type Description Format
itemCode String The identifier of an item.
itemDescription String The description of an item.
customerNr Integer The customer number in WICS.
warehouseCode String The warehouse where the item is stored.
location String The location where the item is stored.
stockStatusCode String The identifier of the stock status.
stockStatusDescription String The description of the stock status.
bestBefore String The date that the item is preserved. (YYYY-MM-DD)
lotNumber String The identifier when useing lotnumbers.
eansscc String The barcode of the item.
skuCode String The stock keeping unit identifier.
quantitySKU Integer The quantity of the stock keeping unit.
huCode String The handling unit identifier.
quantityHU Integer The quantity of the handling unit.
json