Files
dashback/docs/api/routes/shipping/_id/package.post.md
2026-10-09 10:41:21 +02:00

1.3 KiB

POST /shipping/{id}/package

Protected. Requires a valid session cookie (credentials: 'include').

Create package for a shipping

Creates a package for the shipping. The package number is allocated from the package number sequence. entityaddressId is required (target address).

Path parameters

Param Required Type Description
id yes integer Shipping ID

Body (JSON)

Field Required Type Description
entityaddressId yes integer
type yes string
state yes string
details no string
{
  "entityaddressId": 1,
  "type": "…",
  "state": "…",
  "details": "…"
}

Response 201

Created package

{
  "package": {
    "id": 1,
    "shippingId": 1,
    "entityaddressId": 1,
    "number": "…",
    "type": "…",
    "state": "…",
    "details": "…"
  }
}

Errors

Status Description
400 Validation error or no company selected — {"error":"…"}
401 Unauthorized — {"error":"…"}
403 Not authorized — {"error":"…"}
404 Shipping or entity address not found — {"error":"…"}

Generated from @openapi JSDoc. Do not edit by hand — run npm run docs:api.