SHARK WMS RESTAPI Version 1.2 1.2.2#

SHARK WMS RESTAPI - REST based web service for SHARK WMS. The main purpose of the API is to maintain master data and to create orders from a Host system (ERP).

Contact: support@logiware.dk

License: Apache 2.0

Servers#

Description	URL
Endpoint to be used for cloud based installations. Access requires a token for authentication.	https://restapi.sharkwms.com/1.2
Endpoint when accessing the REST API locally.	http://localhost:8086/api/1.2

Articles#

GET /article#

Search for one or more articles.

Description

Get information about the specified article(s). Returns the relevant information.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`articleNumber`	query	string		No	Specify the article number to find. A procent sign can be used for pattern matching.
`owner`	query	string		No	For sites with multiple owners of the articles, specify the actually owner.
`page`	query	number		No	Page number if the response is paged.
`pageSize`	query	number		No	Number of returned rows in the response set.

Response 200 OK

application/json

[
    {
        "articleNumber": "ART001",
        "owner": "string",
        "description": "Screwdriver",
        "description1": "string",
        "description2": "string",
        "ean": "string",
        "erpcount": 10.12,
        "locationstrategy": "FIFO",
        "markForDeletion": false,
        "batchNumberRequired": false,
        "serialNumberRequired": "NEVER",
        "alternativeArticleNumber1": "string",
        "alternativeArticleNumber2": "string",
        "group": "string",
        "pickingRate": "string",
        "unit": "string",
        "packages": [
            {
                "name": "P1",
                "height": 0.1,
                "width": 0.1,
                "depth": 0.1,
                "weight": 1.5,
                "qty": 1.0,
                "ean": "string",
                "unit": "string"
            }
        ],
        "replenishment": [
            {
                "packageName": "string",
                "zone": "string",
                "ReplenishmentFrom": "string",
                "minQty": 10.12,
                "maxQty": 10.12,
                "replenishmentQty": 10.12,
                "locationStrategy": "FIFO"
            }
        ],
        "locationTypes": [
            {
                "name": "string",
                "qty": 10.12
            }
        ],
        "misc": {
            "misc1": "string",
            "misc2": "string",
            "misc3": "string",
            "misc4": "string",
            "misc5": "string",
            "misc6": "string",
            "misc7": "string",
            "misc8": "string",
            "misc9": "string",
            "misc10": "string"
        }
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/MasterDataJS"
    }
}

Response 400 Bad Request

Response 500 Internal Server Error

POST /article#

Add or update master data for articles.

Description

Master data is basic information about the articles. The most important information is the article number and description, but other information can be transferred as well. SHARK will create new articles and update the description, when met in an imported order, but the Master Data allows more information and will also work if SHARK is used with the Manual Transactions (transactions with no host-orders), this could be the case in an initial store process, where goods are moved from old locations into SHARK without orders.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Request body

application/json

Schema of the request body

{
    "items": {
        "$ref": "#/components/schemas/MasterDataJS"
    }
}

Response 201 Created

Response 400 Bad Request

Response 409 Conflict

Response 500 Internal Server Error

DELETE /article#

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`articleNumber`	query	string		No	Specify the article number to find. A procent sign can be used for pattern matching.
`owner`	query	string		No	For sites with multiple owners of the articles, specify the actually owner.

Response 200 OK

Response 400 Bad Request

PUT /articleRename#

Rename an article.

Description

Rename an article. This is used to rename an article number. The new article number must not exist.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`articleNumber`	query	string		No	Specify the article number to find. A procent sign can be used for pattern matching.
`newArticleNumber`	query	string		No	Specify the new article number.
`owner`	query	string		No	For sites with multiple owners of the articles, specify the actually owner.

Response 200 OK

Response 400 Bad Request

Response 409 Conflict

Orders#

POST /order#

Create a new order in SHARK.

Description

Used to create all kind of orders in SHARK, like inbound, outbound and stock counting. The OrderTypeID defines the type of the order.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Request body

application/json

Schema of the request body

{
    "required": [
        "orderNumber",
        "orderTypeID"
    ],
    "properties": {
        "orderNumber": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50,
            "example": "ORD0001",
            "description": "The order number is a reference number, that in combination with the OrderType and the DeliveryNoteNumber defines a unique order."
        },
        "owner": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50,
            "description": "Optional owner (company) of this order. In case an owner is specified, all articles in the order must be owned by the specified owner."
        },
        "deliveryNoteNumber": {
            "type": "string",
            "minLength": 1,
            "maxLength": 50,
            "description": "A delivery number, a shipment number."
        },
        "orderTypeID": {
            "type": "integer",
            "minimum": 1,
            "maximum": 32768,
            "example": 1,
            "description": "OrderTypeID defines the type of the order. The default types are: 1=outbound (pick), 2=inbound (put-away). Other types can be defined as needed."
        },
        "priority": {
            "type": "integer",
            "minimum": 1,
            "maximum": 255,
            "default": 127,
            "example": 127,
            "description": "Priority is a number between 0 and 255. Default is 127, 0 is lowest and 255 is express orders."
        },
        "deliveryDate": {
            "type": "string",
            "format": "date",
            "description": "Date the order should be delivered. Format: YYYY-MM-DD"
        },
        "note": {
            "type": "string",
            "minLength": 0,
            "maxLength": 512,
            "description": "Free order note."
        },
        "shipment": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50,
            "description": "Type of shipment. Information to the consolidation and shipment area and to an optional freight system."
        },
        "carrier": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50,
            "description": "Name of the transport company that will pick up a pick order."
        },
        "tour": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50,
            "description": "Orders can be picked to different tours. This parameter can be used to tell the system, that the order must be delivered with the specified tour."
        },
        "gate": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50,
            "description": "Where the order will be picked up, when leaving the warehouse."
        },
        "customer": {
            "$ref": "#/components/schemas/CustomerJS"
        },
        "deliveryaddress": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/DeliveryAddressJS"
            }
        },
        "misc": {
            "$ref": "#/components/schemas/MiscFields"
        },
        "orderline": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/OrderLineJS"
            }
        },
        "partlist": {
            "type": "object",
            "items": {
                "$ref": "#/components/schemas/PartListJS"
            }
        }
    }
}

Response 201 Created

Response 400 Bad Request

Response 409 Conflict

DELETE /order#

Delete an order from SHARK

Description

Delete an order from SHARK. This is only possible, if the order is not working. Actually the order is only cancelled, it will still exists, but is not visible. When the order is cancelled, it can be overwritten with a new order with same order number.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`deliveryNoteNumber`	query	string		No	Delivery Note Number
`orderNumber`	query	string		No	Order Number
`orderTypeID`	query	number		No	Default IDs are 1 for outbound (picking), 2 for inbound (store), 19 for at stock counting request. New order types can be created in SHARK.
`owner`	query	string		No	Owner

Response 201 Created

Response 404 Not Found

Response 406 Not Acceptable

PUT /startOrder#

Start an order by Host control.

Description

The normal way is that an order is started from Shark. This method allows an order to be started by a Host system.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`deliveryNoteNumber`	query	string		No
`orderNumber`	query	string		No
`orderTypeID`	query	integer		No
`workstation`	query	string		No	The order must be started related to a workstation. The workstation relation is used to define where the order execution belongs and the work group for the order.

Response 201 Created

Response 400 Bad Request

Response 421 Misdirected Request

GET /confirmation#

Get acknowledgements from executed orders.

Description

Returns information about order transactions that has been fullfilled or canceled. Confirmations are logged as documents with an ID number. Store the returned next id and use that for the next call. The confirmations can be generated at order, order line or at transaction level, depending on the configured confirmation mode.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`expandPartLists`	query	boolean		No	Set to true to return detailed information about part lists in the order.
`maxdocs`	query	integer		No	The maximum number of entries to return.
`nextID`	query	integer		No	Return all confirmations from this ID and forward.

Response 200 OK

application/json

[
    {
        "nextID": 0,
        "documentID": 0,
        "status": "string",
        "orderTypeID": 0,
        "orderNumber": "string",
        "deliveryDate": "2022-04-13T15:42:05.901Z",
        "owner": "string",
        "deliverNoteNumber": "string",
        "carrier": "string",
        "weight": "string",
        "colli": "string",
        "misc": {
            "misc1": "string",
            "misc2": "string",
            "misc3": "string",
            "misc4": "string",
            "misc5": "string",
            "misc6": "string",
            "misc7": "string",
            "misc8": "string",
            "misc9": "string",
            "misc10": "string"
        },
        "orderline": null,
        "partlist": null
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/OrderConfirmationJS"
    }
}

Response 400 Bad Request

Response 401 Unauthorized

PUT /orderStatus#

Change the order state to closed. Used to close an inbound or outbound order not yet fully processed.

Description

Order status

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`close`	query	boolean		No
`deliveryNoteNumber`	query	string		No	Delivery Note Number
`orderNumber`	query	string		No	Order Number
`OrderTypeID`	query	number		No
`owner`	query	string		No	Owner

Response 200 OK

application/json

{
    "orderNumber": "string",
    "deliverNoteNumber": "string",
    "owner": "string",
    "status": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "orderNumber": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "deliverNoteNumber": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "owner": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "status": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50,
            "description": "Returned status values: OK, Waiting, Partly, Cancel. OK: The order is finalized. Waiting: The order is open and not yet started picking or stored. Partly: The order is in progress and is partly processed. Cancel: The order is cancelled in the WMS system or by a Host order."
        }
    }
}

Response 400 Bad Request

Response 421 Misdirected Request

Response 422 Unprocessable Entity

Response 423 Locked

GET /orderStatus#

Returns status of an order

Description

Order status

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`deliveryNoteNumber`	query	string		No	Delivery Note Number
`orderNumber`	query	string		No	Order Number
`orderTypeID`	query	number		No	Required order type id. Standard values are 1 for outbound and 2 for inbound, but order types can be customized for the installation.
`owner`	query	string		No	Used if the system is running with multiple owners of the warehouse, eg. the warehouse is used for 3PL.

Response 200 OK

application/json

{
    "orderNumber": "string",
    "deliverNoteNumber": "string",
    "owner": "string",
    "status": "string"
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "orderNumber": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "deliverNoteNumber": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "owner": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "status": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50,
            "description": "Returned status values: OK, Waiting, Partly, Cancel. OK: The order is finalized. Waiting: The order is open and not yet started picking or stored. Partly: The order is in progress and is partly processed. Cancel: The order is cancelled in the WMS system or by a Host order."
        }
    }
}

Response 401 Unauthorized

Response 420

Response 421 Misdirected Request

Response 422 Unprocessable Entity

GET /orderStatusExt#

Returns status of an order

Description

Order status

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`deliveryNoteNumber`	query	string		No	Delivery Note Number
`orderNumber`	query	string		No	Order Number
`orderTypeID`	query	integer		No
`owner`	query	string		No	Owner

Response 200 OK

application/json

{
    "orderNumber": "string",
    "deliverNoteNumber": "string",
    "owner": "string",
    "orderTypeID": 10.12,
    "statusText": "string",
    "statusID": 10.12,
    "released": true,
    "working": true,
    "consolidated": true,
    "cancelAllowed": true,
    "backOrderStatusID": 10.12,
    "backOrderStatusText": "string",
    "deliveryDate": "2022-04-13T15:42:05.901Z",
    "createdDate": "2022-04-13T15:42:05.901Z",
    "startTime": "2022-04-13T15:42:05.901Z",
    "completedTime": "2022-04-13T15:42:05.901Z",
    "OrderLineStatusListJS": [
        {
            "orderLineID": 10.12,
            "orderID": 10.12,
            "lineNumber": 10.12,
            "itemID": 10.12,
            "qtyRequested": 10.12,
            "qtyDelivered": 10.12,
            "qtyReported": 10.12,
            "priority": "string",
            "statusID": 10.12,
            "statusText": "string",
            "description": "string",
            "pickedBy": "2022-04-13T15:42:05.901Z",
            "pickStart": "2022-04-13T15:42:05.901Z",
            "pickEnd": "2022-04-13T15:42:05.901Z",
            "location": "string",
            "articleNumber": "string",
            "batchNumber": "string",
            "batchDate": "2022-04-13T15:42:05.901Z",
            "articleOnStockID": 10.12,
            "articleOnStockText": "string",
            "misc1": "string",
            "misc2": "string",
            "misc3": "string",
            "misc4": "string",
            "misc5": "string",
            "misc6": "string",
            "misc7": "string",
            "misc8": "string",
            "misc9": "string",
            "misc10": "string",
            "serialNumbers": [
                {
                    "number": "string"
                }
            ]
        }
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "orderNumber": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "deliverNoteNumber": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "owner": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "orderTypeID": {
            "type": "number"
        },
        "statusText": {
            "type": "string",
            "minLength": 0,
            "maxLength": 50
        },
        "statusID": {
            "type": "number",
            "default": "1=The order is finished (OK), 2=Not started, 4=Partly processed"
        },
        "released": {
            "type": "boolean",
            "default": "True if the order is released."
        },
        "working": {
            "type": "boolean",
            "default": "True if the order is processed."
        },
        "consolidated": {
            "type": "boolean",
            "default": "True if the order is consolidated (shipped)"
        },
        "cancelAllowed": {
            "type": "boolean",
            "default": "True if the order can be cancelled (deleted)."
        },
        "backOrderStatusID": {
            "type": "number"
        },
        "backOrderStatusText": {
            "type": "string"
        },
        "deliveryDate": {
            "type": "string",
            "format": "date-time"
        },
        "createdDate": {
            "type": "string",
            "format": "date-time"
        },
        "startTime": {
            "type": "string",
            "format": "date-time"
        },
        "completedTime": {
            "type": "string",
            "format": "date-time"
        },
        "OrderLineStatusListJS": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/OrderLineStatusJS"
            }
        }
    }
}

Response 401 Unauthorized

Response 420

Response 421 Misdirected Request

Response 422 Unprocessable Entity

POST /subscribeConfirm#

Subscribe to a webhook. (Not yet fully functional)

Description

Subscribe to a webhook. Webhooks are user-defined HTTP callbacks. When a new confirmation is available in SHARK, it will post to the specified URL. Thereby polling can be avoided.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Request body

application/json

{
    "url": "http://localhost:1234/events",
    "type": "ORDERCONFIRM",
    "includeContent": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "url",
        "type"
    ],
    "properties": {
        "url": {
            "type": "string",
            "example": "http://localhost:1234/events",
            "description": "URL that will be used as endpoint for the webhook."
        },
        "type": {
            "type": "string",
            "enum": [
                "ORDERCONFIRM",
                "ORDERSTATECHANGED"
            ],
            "description": "Type of event to receive.",
            "default": "ORDERCONFIRM",
            "example": "ORDERCONFIRM"
        },
        "includeContent": {
            "type": "boolean",
            "default": false,
            "description": "If true the document that is waiting will be included in the body of the webhook postin."
        }
    }
}

Response 201 Created

POST /subscribeOrderStateChanged#

Get a post every time an order change the state. (Not yet fully functional)

Description

Subscribe to a webhook. Webhooks are user-defined HTTP callbacks. When a new confirmation is available in SHARK, it will post to the specified URL. Thereby polling can be avoided.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Request body

application/json

{
    "url": "http://localhost:1234/events",
    "type": "ORDERCONFIRM",
    "includeContent": true
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "object",
    "required": [
        "url",
        "type"
    ],
    "properties": {
        "url": {
            "type": "string",
            "example": "http://localhost:1234/events",
            "description": "URL that will be used as endpoint for the webhook."
        },
        "type": {
            "type": "string",
            "enum": [
                "ORDERCONFIRM",
                "ORDERSTATECHANGED"
            ],
            "description": "Type of event to receive.",
            "default": "ORDERCONFIRM",
            "example": "ORDERCONFIRM"
        },
        "includeContent": {
            "type": "boolean",
            "default": false,
            "description": "If true the document that is waiting will be included in the body of the webhook postin."
        }
    }
}

Response 201 Created

Inventory#

GET /stockreport#

Get a stock report from system.

Description

Return a complete stock report as a snapshot when the call is received. This is typically requested when the two systems are in an idle state – in other words, when no orders are in progress.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`articleNumber`	query	string		No	The specify an article number to return info for only this number.
`page`	query	number		No	Page number if the response is paged.
`pageSize`	query	number		No	Number of returned rows in the response set.

Response 200 OK

application/json

[
    {
        "articleNumber": "string",
        "owner": "string",
        "batchnumber": "string",
        "unit": "string",
        "qty": 10.12,
        "qtyAvailable": 10.12,
        "qtyAtGoodsReception": 10.12,
        "qtyAtConsolidation": 10.12,
        "qtyPendingPicks": 10.12,
        "qtyPendingStore": 10.12,
        "locations": null
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/StockJS"
    }
}

Response 400 Bad Request

GET /locations#

Get all locations

Description

Return a list of all locations including stock

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`locationaddress`	query	string		No	Optional location address to search for. A procent sign can be used for pattern matching.
`page`	query	number		No	Page number if the response is paged.
`pageSize`	query	number		No	Number of returned rows in the response set.

Response 200 OK

application/json

[
    {
        "location": "string",
        "locationType": "string",
        "articleNumber": "string",
        "owner": "string",
        "batchnumber": "string",
        "unit": "string",
        "qty": 10.12,
        "palletID": "string",
        "locked": true,
        "orderRef": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LocationJS"
    }
}

Response 400 Bad Request

PUT /lockBatchNumber#

Lock stock by batch number

Description

Lock or unlock locations by batch number. This might be used to avoid picking from a specific batch number, for example if the batch is expired.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`article`	query	string		No	The article number.
`batchNumber`	query	string		No	Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
`lock`	query	boolean		No	Lock or unlock the locations.
`owner`	query	string		No	Optional owner of the article number.

Response 200 OK

application/json

[
    {
        "location": "string",
        "locationType": "string",
        "articleNumber": "string",
        "owner": "string",
        "batchnumber": "string",
        "unit": "string",
        "qty": 10.12,
        "palletID": "string",
        "locked": true,
        "orderRef": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LocationJS"
    }
}

Response 400 Bad Request

Response 409 Conflict

GET /inspection#

Get all items in inspection (Not yet fully functional)

Description

Return a list of all locations with articles stored waiting for inspection.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`page`	query	number		No	Page number if the response is paged.
`pageSize`	query	number		No	Number of returned rows in the response set.

Response 200 OK

application/json

[
    {
        "location": "string",
        "locationType": "string",
        "articleNumber": "string",
        "owner": "string",
        "batchnumber": "string",
        "unit": "string",
        "qty": 10.12,
        "palletID": "string",
        "locked": true,
        "orderRef": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LocationJS"
    }
}

Response 400 Bad Request

PUT /inspection#

Maintain articles that was stored for inspection. Default is release stock that was locked until quality inspection has been fullfilled. Can also be used to reject inspected articles, by setting the passed flag to false.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`action`	query	string		No	What to do with the articles. If ACCEPTED the articles specified by qty will be unlocked and available as ordinary stock, if qty is less than the locked quantity, it will be removed (supposed already to be removed). If REJECTED the stock will be removed. If MOVE_TO_QUARATINE, the articles will be moved to a quaratine zone and still be locked. If MOVE_TO_SCRAP, the articles will be moved to a scrap zone and not any longer be available.
`article`	query	string		No	The article number.
`batchNumber`	query	string		No	Batch numbers for inventoring orders are actually not supported and will be ignored if specified.
`location`	query	string		No	Optionally support for specifying a specific location where the articles are stored.
`orderNumber`	query	string		No	This is the inbound order number, original used when the articles were received. It is required in all requests to identify the articles.
`owner`	query	string		No	Owner is only required in setups for 3PL where the warehouse supports multiple owners of the stock.
`qty`	query	number		No	This is used to define how many items are accepted or rejected currently in inspection. If the quantity is lower than the actually quantity in inspection, the stock will be adjusted to that value.
`serialNumber`	query	string		No	Optional serial number (only one can be specified). So far not supported.

Response 200 OK

application/json

[
    {
        "location": "string",
        "locationType": "string",
        "articleNumber": "string",
        "owner": "string",
        "batchnumber": "string",
        "unit": "string",
        "qty": 10.12,
        "palletID": "string",
        "locked": true,
        "orderRef": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/LocationJS"
    }
}

Response 400 Bad Request

Response 409 Conflict

XML#

POST /xml#

Post SHARK standard XML.

Description

This allows existing SHARK XML files to be posted, using the REST API (Not yet fully functional)

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Request body

application/json

"string"

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the request body

{
    "type": "string",
    "format": "xml"
}

Response 201 Created

Response 407 Proxy Authentication Required

Response 408 Request Timeout

System#

GET /statistics#

Get statistic information

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`page`	query	number		No	Page number if the response is paged.
`pageSize`	query	number		No	Number of returned rows in the response set.

Response 200 OK

application/json

[
    {
        "zone": "string",
        "orders": 0,
        "lines": 0,
        "lastTransaction": "2022-04-13T15:42:05.901Z",
        "pickLastHour": 0,
        "storeLastHour": 0
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/StatisticJS"
    }
}

Response 400 Bad Request

GET /report#

Get a custom data report.

Description

SHARK allows customized reports to be generated as views in the database. This call can be used to extract the report data.

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.
`columns`	query	string		No	Optional list of comma separated column names to return. Default is all columns.
`filter`	query	string		No	Filter for a single column. Format colname EQ/NEQ/GT/LT value.
`page`	query	number		No	Page number if the response is paged.
`pageSize`	query	number		No	Number of returned rows in the response set.
`reportName`	query	string		No	This is the name of the predefined report in the SHARK system.
`sort`	query	string		No	Comma separated list of column names to order by.

Response 200 OK

application/json

{
    "metadata": [
        {
            "name": "string",
            "datatype": "string"
        }
    ],
    "data": [
        [
            "string"
        ]
    ]
}

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "object",
    "properties": {
        "metadata": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ReportMetaDataJS"
            }
        },
        "data": {
            "type": "array",
            "items": {
                "$ref": "#/components/schemas/ReportDataJS"
            }
        }
    }
}

Response 400 Bad Request

GET /health#

Get general health information (Not yet fully functional)

Input parameters

Parameter	In	Type	Default	Nullable	Description
`bearerAuth`	header	string	N/A	No	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Response 200 OK

application/json

[
    {
        "name": "string",
        "class": "DEVICES",
        "level": "INFO",
        "note": "string"
    }
]

⚠️ This example has been generated automatically from the schema and it is not accurate. Refer to the schema for more information.

Schema of the response body

{
    "type": "array",
    "items": {
        "$ref": "#/components/schemas/HealthJS"
    }
}

Response 400 Bad Request

Schemas#

CustomerJS#

Type:

DeliveryAddressJS#

Type:

HealthJS#

Name	Type
`class`	string
`level`	string
`name`	string
`note`	string

HealthListJS#

Type: Array<HealthJS>

LocationJS#

Name	Type
`articleNumber`	string
`batchnumber`	string
`location`	string
`locationType`	string
`locked`	boolean
`orderRef`	string
`owner`	string
`palletID`	string
`qty`	number
`unit`	string

LocationListJS#

Type: Array<LocationJS>

LocationTypeJS#

Name	Type
`name`	string
`qty`	number

LocationTypeListJS#

Type: Array<LocationTypeJS>

MasterDataJS#

Name	Type
`alternativeArticleNumber1`	string
`alternativeArticleNumber2`	string
`articleNumber`	string
`batchNumberRequired`	boolean
`description`	string
`description1`	string
`description2`	string
`ean`	string
`erpcount`	number
`group`	string
`locationstrategy`	string
`locationTypes`	LocationTypeListJS
`markForDeletion`	boolean
`misc`	MiscFields
`owner`	string
`packages`	PackagesListJS
`pickingRate`	string
`replenishment`	ReplenishmentListJS
`serialNumberRequired`	string
`unit`	string

MasterDataListJS#

Type:

MiscFields#

Name	Type
`misc1`	string
`misc10`	string
`misc2`	string
`misc3`	string
`misc4`	string
`misc5`	string
`misc6`	string
`misc7`	string
`misc8`	string
`misc9`	string

OrderConfirmationJS#

Name	Type
`carrier`	string
`colli`	string
`deliverNoteNumber`	string
`deliveryDate`	string(date-time)
`documentID`	integer
`misc`	MiscFields
`nextID`	integer
`orderline`
`orderNumber`	string
`orderTypeID`	integer
`owner`	string
`partlist`
`status`	string
`weight`	string

OrderConfirmationListJS#

Type: Array<OrderConfirmationJS>

OrderJS#

Type:

OrderLineAckJS#

Name	Type
`articleNumber`	string
`costCenter`	string
`costCenterText`	string
`lineNumber`	integer
`misc`
`qty`	number
`qtyOrdered`	number
`serialNumbers`	Array<SerialNumberJS>
`status`	string
`time`	string(date-time)
`transactions`	Array<TransactionListJS>
`user`	string

OrderLineJS#

Name	Type
`articleDescription`	string
`articleNumber`	string
`auto`	boolean
`batchDate`	string(date)
`batchNumber`	string
`expireDate`	string(date)
`lineNumber`	integer
`location`	string
`misc`	MiscFields
`note`	string
`qty`	number
`qualityInspection`	boolean
`reservation`	string
`serialNumbers`	Array<SerialNumberJS>
`targetZone`	string
`unit`	string

OrderLineStatusJS#

Name	Type
`articleNumber`	string
`articleOnStockID`	number
`articleOnStockText`	string
`batchDate`	string(date-time)
`batchNumber`	string
`description`	string
`itemID`	number
`lineNumber`	number
`location`	string
`misc1`	string
`misc10`	string
`misc2`	string
`misc3`	string
`misc4`	string
`misc5`	string
`misc6`	string
`misc7`	string
`misc8`	string
`misc9`	string
`orderID`	number
`orderLineID`	number
`pickedBy`	string(date-time)
`pickEnd`	string(date-time)
`pickStart`	string(date-time)
`priority`	string
`qtyDelivered`	number
`qtyReported`	number
`qtyRequested`	number
`serialNumbers`	Array<SerialNumberJS>
`statusID`	number
`statusText`	string

OrderSpecifierJS#

Name	Type
`deliverNoteNumber`	string
`orderNumber`	string
`orderTypeID`	integer
`owner`	string

OrderStateJS#

Name	Type
`createdDate`	string(date-time)
`deliveryNoteNumber`	string
`orderNumber`	string
`orderTypeID`	integer
`owner`	string
`state`	string

OrderStatusExtJS#

Name	Type
`backOrderStatusID`	number
`backOrderStatusText`	string
`cancelAllowed`	boolean
`completedTime`	string(date-time)
`consolidated`	boolean
`createdDate`	string(date-time)
`deliverNoteNumber`	string
`deliveryDate`	string(date-time)
`OrderLineStatusListJS`	Array<OrderLineStatusJS>
`orderNumber`	string
`orderTypeID`	number
`owner`	string
`released`	boolean
`startTime`	string(date-time)
`statusID`	number
`statusText`	string
`working`	boolean

OrderStatusJS#

Name	Type
`deliverNoteNumber`	string
`orderNumber`	string
`owner`	string
`status`	string

PackagesJS#

Name	Type
`depth`	number
`ean`	string
`height`	number
`name`	string
`qty`	number
`unit`	string
`weight`	number
`width`	number

PackagesListJS#

Type: Array<PackagesJS>

partListAckJS#

Name	Type
`lines`
`orderTypeID`	number
`partListNumber`	string

PartListJS#

Name	Type
`asSubOrder`	boolean
`orderTypeID`	number
`partlistline`	Array<PartListLineJS>
`partListNumber`	string
`qty`	number
`storePickPartList`	boolean

PartListLineJS#

Name	Type
`articleNumber`	string
`lineNumber`	integer
`qty`	number

partListLinesAckJS#

Name	Type
`articleNumber`	string
`lineNumber`	number
`qty`	number

ReplenishmentJS#

Name	Type
`locationStrategy`	string
`maxQty`	number
`minQty`	number
`packageName`	string
`ReplenishmentFrom`	string
`replenishmentQty`	number
`zone`	string

ReplenishmentListJS#

Type: Array<ReplenishmentJS>

ReportDataJS#

Type: Array<string>

ReportDataListJS#

Name	Type
`data`	Array<ReportDataJS>
`metadata`	Array<ReportMetaDataJS>

ReportMetaDataJS#

Name	Type
`datatype`	string(enum - STRING - INTEGER - DOUBLE - DATETIME)
`name`	string

SerialNumberJS#

Name	Type
`number`	string

StatisticJS#

Name	Type
`lastTransaction`	string(date-time)
`lines`	integer
`orders`	integer
`pickLastHour`	integer
`storeLastHour`	integer
`zone`	string

StatisticListJS#

Type: Array<StatisticJS>

StockJS#

Name	Type
`articleNumber`	string
`batchnumber`	string
`locations`
`owner`	string
`qty`	number
`qtyAtConsolidation`	number
`qtyAtGoodsReception`	number
`qtyAvailable`	number
`qtyPendingPicks`	number
`qtyPendingStore`	number
`unit`	string

StockListJS#

Type: Array<StockJS>

TransactionJS#

Name	Type
`batchNumber`	string
`deliveryReference`	string
`location`	string
`qty`	number
`qualityCheck`	boolean
`user`	string

TransactionListJS#

Type: Array<TransactionJS>

WebHook#

Name	Type
`includeContent`	boolean
`type`	string
`url`	string

WebHookStateChanged#

Name	Type
`includeContent`	boolean
`type`	string
`url`	string

Security schemes#

Name	Type	Scheme	Description
bearerAuth	http	bearer	The API uses Bearer Token for authentication. Bearer authentication (also called token authentication) is an HTTP authentication scheme that involves security tokens called bearer tokens. The private token is either obtained from Logiware or generated by the SHARK PC Client. The client must send this token in the Authorization header.

Tags#

Name	Description
Orders	Create and maintain orders generated by a Host System.
Inventory	Get stock and location reports. Maintain quality inspection.
Articles	Maintain article master data.
XML	Write data in XML format.
System	System related queries.