Skip to content

Designed
Create a packaging component

Request

Creates a packaging component owned by your company, born published and in progress (status inProgress): it can be referenced by a packaging system right away. Atomic: a refused value rejects the whole component and nothing is created.

Security
oauth2(Required scopes: t1_api)
Headers
Idempotency-Keystring, <= 255 characters

Not active yet. A unique key per create: a retried call with the same key will answer the result of the first call instead of creating again. Until it is active, check whether the item exists before retrying a create.

Bodyapplication/jsonrequired
namestringrequired

Unique among your company's packaging components.

usageLevelstringrequired
Enum:"primary""secondary""tertiary"
packagingComponentTypeIdstring, (uuid)required
isPrintableboolean or null
weightobject(Measurement)
widthobject(Measurement)
heightobject(Measurement)
lengthobject(Measurement)
diameterobject(Measurement)
packagingUsageIdsArray of strings or null, (uuid)
internalCodestring or null
technicalDesignationstring or null
commercialDesignationstring or null
isComponentInDirectContactWithProductboolean or null
suppliersArray of objects or null(PackagingSupplierWrite)
materialsobject or null(PackagingMaterialsWrite)
componentCharacteristicsobject or null(ComponentCharacteristicsWrite)
printingobject or null(PrintingWrite)
substancesArray of objects or null(PackagingSubstance)
curl -i -X POST \
  https://apis.traceone.com/spec/v2/library/packaging-components \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "name": "string",
    "usageLevel": "primary",
    "packagingComponentTypeId": "b957a9cf-73c1-4e0a-8800-a676add2ba67",
    "isPrintable": true,
    "weight": {
      "value": 0.1,
      "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed"
    },
    "width": {
      "value": 0.1,
      "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed"
    },
    "height": {
      "value": 0.1,
      "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed"
    },
    "length": {
      "value": 0.1,
      "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed"
    },
    "diameter": {
      "value": 0.1,
      "unitId": "b3eb5f92-604a-46b9-9881-9d84000fd7ed"
    },
    "packagingUsageIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "internalCode": "string",
    "technicalDesignation": "string",
    "commercialDesignation": "string",
    "isComponentInDirectContactWithProduct": true,
    "suppliers": [
      {
        "supplierName": "string",
        "supplierInternalCode": "string",
        "marketId": "4e934bc8-bf09-4970-9252-7ebc32247830",
        "countryId": "bd2b151e-bbbf-43a3-8058-286e653dfac0",
        "regionId": "a29f01e1-8a8d-451e-b685-f8b0b4ec4767",
        "zoneId": "c3920607-5069-4ac3-ba10-00754e7a8e8b"
      }
    ],
    "materials": {
      "packagingMaterials": [
        {
          "packagingMaterialId": "3f233df0-ac0e-41c3-90b5-9e55e7b8da56",
          "percentageOfMaterial": 0,
          "thicknessInMicrons": 0,
          "percentageOfRecycledMaterials": 0,
          "percentageOfRecycledMaterialsIncludingPcr": 0,
          "percentageOfRenewableResources": 0
        }
      ]
    },
    "componentCharacteristics": {
      "isRecyclable": true,
      "detachableForWashing": {
        "isDetachableForWashing": true,
        "detachableForWashingPrecisionId": "3a0520f6-64e9-4fe4-916e-52457b2e6fb0"
      },
      "plasticCharacteristics": {
        "densityId": "be0a3953-b372-4020-ac10-929a5d92587f",
        "rigidityId": "aade5dde-a348-4aee-9dfd-8f4473a28b15",
        "tintId": "e4d79d42-e49d-4f72-a3a4-c01bdfa41067",
        "transparencyId": "27d899f1-b5f6-4e07-8dda-4f06a8bd0202"
      },
      "additives": [
        {
          "packagingAdditiveId": "c1733388-57b1-4772-b0e8-633b6b0cffb3",
          "percentage": 0
        }
      ]
    },
    "printing": {
      "printingTypeId": "783bcca7-18a0-404a-bb22-09e69436ef79",
      "numberOfColors": 0,
      "inkTypeId": "970c0c70-31fb-4283-aa41-bbd604399bcf",
      "varnishTypeId": "1cfc89de-884e-4552-82ae-068bcc7f79de",
      "glueTypeId": "ecb48be6-00bf-425a-b409-b717ae0b3037"
    },
    "substances": [
      {
        "substanceId": "3803e2f4-0a8a-4e83-90d3-08cc74e12f0a",
        "percentage": 0,
        "presentAtNanoscale": true,
        "presenceAtNanoscale": {
          "size": 0,
          "specificSurface": 0
        }
      }
    ]
  }'

Responses

The component was created

Bodyapplication/json
packagingComponentIdstring, (uuid)
Response
{
  "packagingComponentId": "2ba6d6df-1033-471d-b787-87ae63c06cad"
}