CS SSCC Management

Creating No. series

Endpoint:

POST /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccNumberSeries

Example:

json

{

"code": "SSCC",

"description": "Default SSCC number series",

"startNo": "00000000000000001",

"endNo": "00000000099999999",

"warningNo": "00000000090000000"

}

Important Notice:

- startNo, endNo and warningNo must contain 17 digits.

- lastUsedNo is readonly and will be maintained by the app.

Creating Package Type

Endpoint: 

POST /api/centralSolutions/sscc/v1.0/companies({companyId})/packageTypes

Example:

 json

{

"code": "PALLET",

"description": "Pallet",

"externalCode": "PAL",

"defaultWeight": 0,

"noSeriesCode": "SSCC",

"labelReportId": 70799100

}

Important Notice:

 - code is mandatory.

- noSeriesCode must refer to an existing SSCC no. series.

- labelReportCaption is readonly.

Creating an SSCC Header

Endpoint:

POST /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccHeaders

Example:

json

{

"packageType": "PALLET",

"userId": "USER01",

 "locationCode":

"BLUE"

}

Example Response:

json

{

"id": "00000000-0000-0000-0000-000000000000",

"ssccNo": "000000000000000018",

"packageType": "PALLET",

"status": "New",

"userId": "USER01",

"locationCode": "BLUE",

"creatorUserId": "APIUSER",

"creationDateTime": "2026-06-15T20:00:00Z",

 "totalSSCCLines": 0,

"totalQuantityBase": 0

}

Important Notice:

 - packageType is mandatory.

- ssccNo will be generated based on the no. series of the package type.

- ssccNo, creatorUserId, creationDateTime, totalSSCCLines and totalQuantityBase are readonly.

- Modifying and Deleting an SSCC header via API is not allowed.

- An error occurs if the license is not valid.

Assigning SSCC Koppelen to warehouse documents

Endpoint:

POST /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccLines

Example for a warehouse shipment:

json

{

 "documentType":

"Warehouse Shipment",

"documentNo": "WHS-SHIP-0001",

 "documentLineNo": 10000,

"ssccNo": "000000000000000018",

"quantity": 5

}

Example for a warehouse receipt:

json

{

"documentType": "Warehouse Receipt",

"documentNo": "WHS-REC-0001",

"documentLineNo": 10000,

"ssccNo": "000000000000000018",

"quantity": 5

}

lineNo can be included optionally:

json

{

"documentType": "Warehouse Shipment",

"documentNo": "WHS-SHIP-0001",

"documentLineNo": 10000,

"lineNo": 10000,

"ssccNo": "000000000000000018",

"quantity": 5

}

Important Notice:

- Supported documentType values for API entry are Warehouse Shipment and Warehouse Receipt.

- If the lineNo is not included the API will choose the next line no. automatically.

- The API retrieves item, variant and unit of measure from the document line.

- In warehouse shipments, the Qty. to Ship will be modified.

- In warehouse receipts, the Qty. to Receive will be modified.

- Modifying and Deleting SSCC lines via API is not allowed.

Reading Data

Examples:

GET /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccHeaders

GET /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccLines

GET /api/centralSolutions/sscc/v1.0/companies({companyId})/packageTypes

GET /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccNumberSeries

Use the id to retrieve a specific record:

GET /api/centralSolutions/sscc/v1.0/companies({companyId})/ssccHeaders({id})

Recommended Process

1. Create a number series via ssccNumberSeries.

2. Create a package type via packageTypes and link it to the number series.

3. Create an SSCC header via ssccHeaders.

4. Link the generated ssccNo to a warehouse shipment or receipt line via ssccLines.

Common Errors

`The SSCC license key is not valid.`

Indicates that the license period has been expired or the license has not been activated.

Check the license settings in Business Central, contact support to renew the license key.

`Package Type must be specified.`

Property packageType is missing when creating an SSCC header.

Enter an existing package type code. This property is mandatory.

`Document type ... is not supported by the SSCC Lines API.`

An unsupported document type has been used.

Use Warehouse Shipment or Warehouse Receipt as Document Type.

‘Number sequence error’

One or more of the properties startNo, endNo or warningNo is not a 17-digit value.

Use exactly 17 digits for each of these properties.