WinShopAPI docs
ReferenceItem lists

SSCC codes

List sscc codes

GET
/api/item-lists/sscc-codes

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Response Body

application/json
  1. response
[index: integer]?
curl -X GET 'https://<your-instance>/api/item-lists/sscc-codes' \  -H 'Authorization: Bearer <access-token>'
[  {    "branchId": 0,    "customerId": 0,    "date": "2019-08-24T14:15:22Z",    "id": 0,    "isActive": true,    "isPrinted": true,    "note": "string",    "sscc": "string",    "ssccInternalNumber": 0,    "warehouseId": 0,    "warehouseToId": 0  }]

Generate an SSCC code

POST
/api/item-lists/sscc-codes

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. body
branchId*integer
Formatint32
customerId*integer
Formatint32
note?string
warehouseId*integer
Formatint32
warehouseToId*integer
Formatint32

Response Body

application/json
  1. response
branchId?integer
Formatint32
customerId?integer
Formatint32
date?string
Formatdate-time
id?integer
Formatint32
isActive?boolean
isPrinted?boolean
note?string
sscc?string
Lengthlength <= 25
ssccInternalNumber?integer
Formatint32
warehouseId?integer
Formatint32
warehouseToId?integer
Formatint32
curl -X POST 'https://<your-instance>/api/item-lists/sscc-codes' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{  "branchId": 0,  "customerId": 0,  "warehouseId": 0,  "warehouseToId": 0}'
{  "branchId": 0,  "customerId": 0,  "date": "2019-08-24T14:15:22Z",  "id": 0,  "isActive": true,  "isPrinted": true,  "note": "string",  "sscc": "string",  "ssccInternalNumber": 0,  "warehouseId": 0,  "warehouseToId": 0}
PATCH
/api/item-lists/sscc-codes/batch-update

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. body
[index: integer]?

Response Body

application/json
  1. response
[index: integer]?
curl -X PATCH 'https://<your-instance>/api/item-lists/sscc-codes/batch-update' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '[  {}]'
[  {    "branchId": 0,    "customerId": 0,    "date": "2019-08-24T14:15:22Z",    "id": 0,    "isActive": true,    "isPrinted": true,    "note": "string",    "sscc": "string",    "ssccInternalNumber": 0,    "warehouseId": 0,    "warehouseToId": 0  }]

Search SSCC codes

POST
/api/item-lists/sscc-codes/filter-paginated

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Request Body

application/json
  1. body
filter?

Endpoint-specific filter. Every field is optional; the ones you set are combined with AND.

limitFields?array<string>|

Names of the fields to return; omit it for all of them. Which fields exist depends on the instance's data-grid view.

orderBy?array<string>|

Sort order, one entry per level, each written as Field or Field desc. Which fields can be sorted on depends on the instance's data-grid view.

pageNumber?integer

1-based page to return. 0 and 1 both mean the first page.

Formatint32
pageSize?integer

Rows per page. Defaults to every matching row, and -1 asks for every row explicitly.

Formatint32

Response Body

application/json
  1. response
currentPage?integer

1-based number of the page in this response.

Formatint32
data?array<>

The rows of this page, shaped by the request's limitFields.

hasNextPage?boolean

True when a page follows this one.

hasPreviousPage?boolean

True when a page precedes this one.

pageSize?integer

Rows per page actually applied, which is 10 when the request asked for a non-positive size.

Formatint32
totalCount?integer

Number of rows matching the filter across every page.

Formatint32
totalPages?integer

Number of pages the whole result set spans at this page size.

Formatint32
curl -X POST 'https://<your-instance>/api/item-lists/sscc-codes/filter-paginated' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "currentPage": 0,  "data": [    {      "branchId": 0,      "customerId": 0,      "date": "2019-08-24T14:15:22Z",      "id": 0,      "isActive": true,      "isPrinted": true,      "note": "string",      "sscc": "string",      "ssccInternalNumber": 0,      "warehouseId": 0,      "warehouseToId": 0    }  ],  "hasNextPage": true,  "hasPreviousPage": true,  "pageSize": 0,  "totalCount": 0,  "totalPages": 0}

Get a sscc code

GET
/api/item-lists/sscc-codes/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

application/json
  1. response
branchId?integer
Formatint32
customerId?integer
Formatint32
date?string
Formatdate-time
id?integer
Formatint32
isActive?boolean
isPrinted?boolean
note?string
sscc?string
Lengthlength <= 25
ssccInternalNumber?integer
Formatint32
warehouseId?integer
Formatint32
warehouseToId?integer
Formatint32
curl -X GET 'https://<your-instance>/api/item-lists/sscc-codes/0' \  -H 'Authorization: Bearer <access-token>'
{  "branchId": 0,  "customerId": 0,  "date": "2019-08-24T14:15:22Z",  "id": 0,  "isActive": true,  "isPrinted": true,  "note": "string",  "sscc": "string",  "ssccInternalNumber": 0,  "warehouseId": 0,  "warehouseToId": 0}

Update an SSCC code

PATCH
/api/item-lists/sscc-codes/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Request Body

application/json
  1. body
branchId?|
Formatint32
customerId?|
Formatint32
id?integer
Formatint32
isActive?boolean|null
isPrinted?boolean|null
note?string|null
warehouseId?|
Formatint32

Response Body

application/json
  1. response
branchId?integer
Formatint32
customerId?integer
Formatint32
date?string
Formatdate-time
id?integer
Formatint32
isActive?boolean
isPrinted?boolean
note?string
sscc?string
Lengthlength <= 25
ssccInternalNumber?integer
Formatint32
warehouseId?integer
Formatint32
warehouseToId?integer
Formatint32
curl -X PATCH 'https://<your-instance>/api/item-lists/sscc-codes/0' \  -H 'Authorization: Bearer <access-token>' \  -H 'Content-Type: application/json' \  -d '{}'
{  "branchId": 0,  "customerId": 0,  "date": "2019-08-24T14:15:22Z",  "id": 0,  "isActive": true,  "isPrinted": true,  "note": "string",  "sscc": "string",  "ssccInternalNumber": 0,  "warehouseId": 0,  "warehouseToId": 0}

Delete a sscc code

DELETE
/api/item-lists/sscc-codes/{id}

Authorization

Bearer
headerAuthorizationBearer <token>

OAuth 2.0 client credentials. Obtain a client id/secret from Winshop support ([email protected]), then POST to the token URL.

Path Parameters

id*integer
Formatint32

Response Body

curl -X DELETE 'https://<your-instance>/api/item-lists/sscc-codes/0' \  -H 'Authorization: Bearer <access-token>'
Empty