Skip to main content

Get Transformation Events

Method: GET
/data-provider/events/transformation

As a Data Provider of iFoodDS, you can use the Get Transformation Event API to query transformation event data from the iFoodDS Trace Exchange platform.

info

This endpoint is being refined and thus subject to change. These docs will update when changes are made.

Request​

Type: application/json

Retrieving transformation events via the API is done through paging. The request requires a series of query parameters which define the page that must be returned. These parameters must be supplied in the url when the get is executed in order to return the result set for the page being queried.

Query Parameters​

Optional​

  • page (number): The page index of the events to return. The first page is index 0.
  • size (number): The number of results to return per page. Default value is 20.
  • submitStartDateTime (datetime): Filters results to include only events submitted after the specified date and time.
  • submitEndDateTime (datetime): Filters results to include only events submitted before the specified date and time.
  • eventStartDateTime (datetime): Filters results to include only events with an event date and time after the specified date and time.
  • eventEndDateTime (datetime): Filters results to include only events with an event date and time before the specified date and time.
  • workOrderNumber (string): The exact work order number on the event.
  • transformationLocationCode (string): The exact transformation code on the event.
  • foodUsedWoLineNumber (string): The exact food used work order line number on the event.
  • foodProducedWoLineNumber (string): The exact food produced work order line number on the event.
  • foodUsedItemCode (string): The exact food used item code on the event.
  • foodProducedItemCode (string): The exact food produced item code on the event.

Data Constraints​

Please note the following data constraints:

  • datetimes must use the format: yyyy-MM-ddTHH:mm:ss

Response​

Return result for the transformation event data queried.

{
    "content": [
        {
            "id": "<event id>",
            "dataProviderVendorId": "<data provider vendor ID>",
            "dataProviderVendorName": "<data provider vendor name>",
            "eventDateTime": "<event date>",
            "workOrderNumber": "<work order number>",
            "foodProduced": [
                {
                    "acceptableSpeciesName": "<acceptable species name>",
                    "alternateItemCode": "<alternate item code>",
                    "brandName": "<brand name>",
                    "caseGtin": "case <GTIN (Global Trade Item Number)>",
                    "lotCode": "<lot code>",
                    "productId": "<product id>",
                    "quantity": "<quantity>",
                    "quantityUom": "<uom> (Units of Measure)",
                    "ftlCategory": "<FTL (Food Traceability List) category>",
                    "isFtlItem": <is ftl item>,
                    "gtin": "<GTIN (Global Trade Item Number)>",
                    "innerPackUpc": "<inner pack UPC>",
                    "itemDescription": "<item description>",
                    "packSize": "<pack size>",
                    "packStyle": "<pack style>",
                    "productCommodity": "<product commodity",
                    "productVariety": "<product variety>",
                    "scientificName": "<scientific name>",
                    "woLineNumber": "<work order line number>",
                    "iotDevicePalletProduced": "<iot device pallet produced>",
                    "ssccPalletProduced": "<sscc pallet produced>",
                    "lpnPalletProduced": "<lpn pallet produced>"
                }
            ],
            "foodUsed": [
                {
                    "acceptableSpeciesName": "<acceptable species name>",
                    "alternateItemCode": "<alternate item code>",
                    "brandName": "<brand name>",
                    "caseGtin": "case <GTIN (Global Trade Item Number)>",
                    "lotCode": "<lot code>",
                    "productId": "<product id>",
                    "quantity": "<quantity>",
                    "quantityUom": "<uom> (Units of Measure)",
                    "ftlCategory": "<FTL (Food Traceability List) category>",
                    "isFtlItem": <is ftl item>,
                    "gtin": "<GTIN (Global Trade Item Number)>",
                    "innerPackUpc": "<inner pack UPC>",
                    "itemDescription": "<item description>",
                    "packSize": "<pack size>",
                    "packStyle": "<pack style>",
                    "productCommodity": "<product commodity",
                    "productVariety": "<product variety>",
                    "scientificName": "<scientific name>",
                    "woLineNumber": "<work order line number>",
                    "iotDevicePalletUsed": "<iot device pallet used>",
                    "ssccPalletUsed": "<sscc pallet used>",
                    "lpnPalletUsed": "<lpn pallet used>"
                }
            ],
            "location" : {
                "id": "<id>",
                "gln": "<GLN (global location number)>",
                "city": "<city>",
                "duns": "<DUNS number>",
                "state": "<state>",
                "market": <market>,
                "region": "<region>",
                "country": "<country>",
                "geoFence": "<geo fence>",
                "postalCode": "<postal code>",
                "phoneNumber": "<phone number>",
                "businessUnit": "<business unit>",
                "locationName": "<location name>,
                "locationType": "<location type>",
                "glnAssignedBy": "<GLN assigned by>",
                "gpsCoordinates": "<GPS coordinates>",
                "streetAddress1": "<street address 1>",
                "streetAddress2": "<street address 2>",
                "isCoveredByGdst": <is covered by gdst>,
                "parentLocationId": "<parent location id>",
                "isPrimaryLocation": <is primary location>,
                "alternateLocationId": "<alternate location id>"
            }
        }
    ],
    "pageable": {
        "pageNumber": <page number>,
        "pageSize": <page size>,
        "sort": {
            "unsorted": <is unsorted>,
            "sorted": <is sorted>,
            "empty": <is page empty>
        },
        "offset": <offset size>,
        "unpaged": <is unpaged>,
        "paged": <is paged>
    },
    "totalPages": <total pages>,
    "totalElements": <total elements>,
    "last": <is last page>,
    "numberOfElements": <number of elements>,
    "size": <page size>,
    "number": <page number>,
    "sort": {
        "unsorted": <is unsorted>,
        "sorted": <is sorted>,
        "empty": <is empty>
    },
    "first": <is first page>,
    "empty": <is page empty>
}

Content​

  • id (uuid): The id of the transformation event
  • dataProviderVendorId (string): The ID you, the data provider, have for the vendor.
  • dataProviderVendorName (string): The name you, the data provider, have for the vendor.
  • eventDateTime (datetime): Date and time of the event
  • workOrderNumber (string): Work order number
  • foodProduced (array): Array of food products produced from transformation
    • acceptableSpeciesName (string): Acceptable species name
    • alternateItemCode (string): Alternate item code
    • brandName (string): Brand name
    • caseGtin (string): GTIN of the case
    • lotCode (string): Lot code
    • productId (string): Product ID
    • quantity (number): Quantity produced
    • quantityUom (string): Unit of measure for the quantity
    • ftlCategory (string)*: Indicates the product's FTL category, i.e. “soft cheese”, “shell eggs”, “nut butter”, “cucumbers”, “herbs”, “leafy greens”, “melons”, “peppers”, “sprouts”, “tomatoes”, “tropical tree fruits”, “fresh-cut fruits”, “fresh-cut vegetables”, “finfish”, “smoked finfish”, “crustaceans”, “molluscan shellfish”, “ready-to-eat deli salads”, or “multiple-ftl-ingredients” *Required if on the FTL 
    • isFtlItem (boolean): Indicates if the item is on the Food Traceability List
    • gtin (string): Case-level Global Trade Identification Number (GTIN-14). GS1 GTIN Executive Summary
    • innerPackUpc (string): Point of sale barcode, may be GTIN-8, GTIN-12, GTIN-13, or GTIN-14. GS1 GTIN Executive Summary
    • itemDescription (string): Description of the item
    • packSize (string): Size of the pack
    • packStyle (string): Style of the pack
    • productCommodity (string): Commodity of the product
    • productVariety (string): Variety of the product
    • scientificName (string): Scientific name
    • woLineNumber (string): Work order line number
    • iotDevicePalletProduced (string): The IoT Device associated to the pallet
    • ssccPalletProduced (string): The SSCC associated to the pallet
    • lpnPalletProduced (string): The LPN associated to the pallet
  • foodUsed (array): Array of food used in transformation
    • acceptableSpeciesName (string): Acceptable species name
    • alternateItemCode (string): Alternate item code
    • brandName (string): Brand name
    • caseGtin (string): GTIN of the case
    • lotCode (string): Lot code
    • productId (string): Product ID
    • quantity (number): Quantity produced
    • quantityUom (string): Unit of measure for the quantity
    • ftlCategory (string)*: Indicates the product's FTL category, i.e. “soft cheese”, “shell eggs”, “nut butter”, “cucumbers”, “herbs”, “leafy greens”, “melons”, “peppers”, “sprouts”, “tomatoes”, “tropical tree fruits”, “fresh-cut fruits”, “fresh-cut vegetables”, “finfish”, “smoked finfish”, “crustaceans”, “molluscan shellfish”, “ready-to-eat deli salads”, or “multiple-ftl-ingredients” *Required if on the FTL 
    • isFtlItem (boolean): Indicates if the item is on the Food Traceability List
    • gtin (string): Case-level Global Trade Identification Number (GTIN-14) GS1 GTIN Executive Summary
    • innerPackUpc (string): Point of sale barcode, may be GTIN-8, GTIN-12, GTIN-13, or GTIN-14. GS1 GTIN Executive Summary
    • itemDescription (string): Description of the item
    • packSize (string): Size of the pack
    • packStyle (string): Style of the pack
    • productCommodity (string): Commodity of the product
    • productVariety (string): Variety of the product
    • scientificName (string): Scientific name
    • woLineNumber (string): Work order line number
    • iotDevicePalletUsed (string): The IoT Device associated to the pallet
    • ssccPalletUsed (string): The SSCC associated to the pallet
    • lpnPalletUsed (string): The LPN associated to the pallet
  • location (object): Location the transformation took place
    • id (string): Location identifier
    • location name (string): The name of the location
    • location type (string): The type of location (e.g. "Internal", "Supplier", or "Customer")
    • alternateLocationCode (string): Alternate location code
    • streetAddress1 (string): Primary street address
    • streetAddress2 (string): Secondary street address
    • city (string): City of the location
    • state (string): State of the location
    • postalCode (string): Postal code
    • country (string): Country of the location
    • region (string): Region identifier
    • duns (string): DUNS number
    • geoFence (string): Geo-fence coordinates
    • gln (string): GS1 Global Location Number, a 13-digit string. GS1 GTIN Executive Summary
    • glnAssignedBy (string): Entity that assigned the GLN
    • gpsCoordinates (string): GPS coordinates
    • isCoveredByGdst (boolean): Indicates if the location is covered by GDST
    • isPrimaryLocation (boolean): Indicates if this is the primary location
    • market (string): Market identifier
    • parentLocationId (string): Parent location ID
    • phoneNumber (string): Phone number
    • businessUnit (string): Business unit identifier

Pageable​

  • pageable (object)
    • pageNumber (number): The current page number in the page series. Index 0 is first page
    • pageSize (number): The number of events contained in the page
    • offset (number): If there is an offset specified on there return results this will be populates. Default is 0
    • unpaged (boolean): If the record set is unpaged then true else false
    • paged (boolean): If the record set is paged then true else false
    • sort (object)
      • unsorted (boolean): If the record set is unsorted then true else false
      • sorted (boolean): If the record set is sorted then true else false
      • empty (boolean): If the record set is empty then true else false
  • totalPages (number): The total amount of pages that contain all events in the query
  • totalElements (number): The total amount of events in the query
  • last (boolean): If the page is the last in the series then true else false
  • numberOfElements (number): The total amount of events in the table
  • size (number): The number of events contained in the page
  • number (number): The current page number in the page series
  • sort (object)
    • unsorted (boolean): If the record set is unsorted then true else false
    • sorted (boolean): If the record set is sorted then true else false
    • empty (boolean): If the record set is empty then true else false
  • first (boolean): If the page is the first in the series then true else false
  • empty (boolean): If the page is empty then true else false