🔒 Create product packaging unit V3

post

https://{xentralId}.xentral.biz/api/v3/products/{productId}/packagingUnits

This endpoint is currently in Beta and available for testing. It may contain bugs, and breaking changes can occur at any time without prior notice. We do not recommend using Beta endpoints in production environments. Should you choose to use it in production, you assume full responsibility for any resulting issues.

This endpoint requires the following scopes: packagingUnit:create.

Create a packaging unit of a product. A barcode must not be used by another packaging unit of any product or as a product number; such a barcode is rejected with 409 Conflict. Packaging units are read through include=packagingUnits on the product.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

productId

string

required

Body Params

A packaging unit of a product: a box holding a fixed number of items, together with the pallet layout it is stacked in. Every field except quantity is optional; an omitted measure or pallet value is 0. The computed fields boxVolume, netWeight and grossWeight of the response are read-only: sending one, even as null, is rejected with 400.

quantity

float

required

≤ 9999999999.9999

Number of items contained in one box. Must be greater than 0, with at most four decimal places.

barcode

string | null

Barcode of the packaging unit, scanned to identify the box during stock-in. It must not be used by another packaging unit of any product, deleted ones included, or as a product number (409 Conflict otherwise). Null or an empty string stores no barcode. Requests writing the same barcode run one after the other; one that waits longer than 5 seconds is refused with 409 and the problem type https://api.xentral.biz/problems/resource-locked.

description

string | null

Free-text description of the packaging unit. Null stores no description.

length

float

0 to 9999999999.9999

Length of the box in centimeters. At most four decimal places.

width

float

0 to 9999999999.9999

Width of the box in centimeters. At most four decimal places.

height

float

0 to 9999999999.9999

Height of the box in centimeters. At most four decimal places.

tareWeight

float

0 to 9999999999.9999

Weight of the empty packaging (tare) in grams. At most four decimal places.

pallet

object

Pallet layout of the packaging unit.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

401

Unauthorized

403

Forbidden

404

Not Found

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Create a packaging unit of a product. A barcode must not be used by another packaging unit of any product or as a product number; such a barcode is rejected with 409 Conflict. Packaging units are read through include=packagingUnits on the product.

400Failed validation

409Problem occurred

429Too Many Requests