Skip to content

Designed
Get food specifications by IDs

Request

Returns multiple food specifications (identity + chapter refs) in a single call. Maximum 50 IDs per request. All or nothing: one unknown id, or an id that is not a food specification, answers 404; one specification you cannot read answers 403.

Security
oauth2(Required scopes: t1_api)
Bodyapplication/jsonrequired
specificationIdsArray of strings, (uuid), [ 1 .. 50 ] itemsrequired
curl -i -X POST \
  https://apis.traceone.com/spec/v2/food/specifications/collection \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "specificationIds": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Returns the requested food specifications

Bodyapplication/json
Array [
specificationIdstring, (uuid)read-only
namestring or nullread-only

Derived from the trade item

Example:"Organic Strawberry Yogurt 150g"
templateTypestringread-only
Example:"Food"
templateIdstring, (uuid)
tradeItemIdstring or null, (uuid)
ownerCompanyIdstring, (uuid)read-only
ownerUserIdstring, (uuid)

The user of the owner company who owns the specification

supplierCompanyIdstring, (uuid)
languageCodestring or null
Example:"en-US"
reasonForThisVersionstring or null
folderIdstring or null, (uuid)

The folder the specification is placed in; null when it is in none

statusstring(SpecificationStatus)read-only

Lifecycle status of a specification version. Draft: not yet in progress. InProgress: being filled. ValidatedBySupplier / ValidatedByRetailer: validated by that party. LockedForSupplierSignature / LockedForRetailerSignature: locked while that party signs. SignedBySupplier / SignedByRetailer: signed by that party. InRevisionBySupplier / InRevisionByRetailer: reopened for revision by that party.

Enum:"Draft""InProgress""ValidatedBySupplier""ValidatedByRetailer""LockedForSupplierSignature""LockedForRetailerSignature""SignedBySupplier""SignedByRetailer""InRevisionBySupplier""InRevisionByRetailer"
sharedWithCompanyIdsArray of strings, (uuid)read-only

Companies with access to the specification: the owner always, the supplier once the specification has been shared (POST .../share or the share of its folder).

contactsArray of objects(SpecificationPartyContact)read-only

Contacts of both parties

versionobject(ObjectVersion)
creationDateUtcstring, (date-time)read-only
lastUpdateDateUtcstring, (date-time)read-only
signaturesobject or null(SpecificationSignatures)read-only

The signature of this specification version. Absent (null) until a signature process starts.

libraryLinkedChaptersArray of objects(LinkedChapter)read-only

Library chapters linked to the specification (empty when none)

]
Response
[
  {
    "specificationId": "df380d59-2906-4417-bec3-4ac4567b1960",
    "name": "Organic Strawberry Yogurt 150g",
    "templateType": "Food",
    "templateId": "196100ac-4eec-4fb6-a7f7-86c8b584771d",
    "tradeItemId": "ca25da54-cf50-4957-b1f6-2a6f444fe8a3",
    "ownerCompanyId": "10e96248-c873-4e93-b748-bc36e39510eb",
    "ownerUserId": "283eeac5-beea-465a-80a5-763009480d0f",
    "supplierCompanyId": "60e634ac-9cf5-4a73-a6b6-1e5d15116468",
    "languageCode": "en-US",
    "reasonForThisVersion": "string",
    "folderId": "5b6379a4-2a6c-4085-b184-45838a3b8e7e",
    "status": "Draft",
    "sharedWithCompanyIds": [ … ],
    "contacts": [ … ],
    "version": { … },
    "creationDateUtc": "2019-08-24T14:15:22Z",
    "lastUpdateDateUtc": "2019-08-24T14:15:22Z",
    "signatures": { … },
    "libraryLinkedChapters": [ … ]
  }
]