📘

Enterprise Feature

The ADI Orders API allows external systems and integrators to order bulk large amounts of ADIs (Thngs) required for serialising their goods. This is the usually the best approach to such a task, as opposed to creating each Thng individually. Each ADI order includes metadata and template information describing how each generated Thng will look like.


API Status
/adis/orders/
/adis/orders/:orderId
/adis/orders/:orderId/events
/adis/orders/:orderId/events/:orderEventId


ADIOrderDocument Data Model

Object representing an order of new ADIs, containing data about what they should look like.

You must specify either your own list of ids, or specify idGeneration so that the Platform can generate them instead.

.id (string, read-only)
    The ID of this resource.

.status (ADIOrderStatusDocument)
    Object describing the status of an ADI order. Returned only 
    when a single order is read by ID.

.result (string, one of 'SUCCEEDED', 'FAILED', 'SUCCEEDED_WITH_FAILURES')
    The result of the order once it has been completed.

.metadata (ADIOrderMetadataDocument, required)
    Metadata describing data to include in the created Thngs and 
    their redirections.

.purchaseOrder (string, required)
    ID of the associated purchase order.

.ids (array of string)
    Array of string IDs to be used for each generated ADI.

.customFields (CustomFieldsDocument)
    Object of case-sensititve key-value pairs of custom fields 
    associated with the resource.

.identifiers (IdentifiersDocument)
    Various identifiers (EPC, GTIN, etc.) as a JSON object with 
    one or more key-value pairs.

.tags (array of string)
    Array of string tags associated with this resource.

.idGeneration (ADIOrderIDGenerationDocument)
    Metadata of the set of IDs for generation.

.fileMetadata (ADIOrderFileMetadataDocument)
    Contains configuration required for file generation.

.results (ADIOrderResultsDocument)
    Object containing links to generated files.
{
  "description": "Object describing the order of ADIs to generate.",
  "type": "object",
  "required": ["metadata", "purchaseOrder"],
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of this resource.",
      "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
      "readOnly": true
    },
    "status": {
      "type": "object",
      "description": "Object describing the status of an ADI order. Returned only when a single order is read by ID.",
      "properties": {
        "state": {
          "type": "string",
          "description": "The state of the order.",
          "enum": ["pending", "in_progress", "completed"]
        },
        "requested": {
          "type": "integer",
          "description": "Number of requested identifiers."
        },
        "adis": {
          "type": "object",
          "description": "Creation progress and errors",
          "properties": {
            "created": {
              "type": "integer",
              "description": "Number of actions created."
            },
            "pending": {
              "type": "integer",
              "description": "Number of actions waiting for creation."
            },
            "errorsCount": {
              "type": "integer",
              "description": "Number of errors occurred."
            },
            "errors": {
              "type": "object",
              "description": "The list of errors. Key - the identifier value, the value - ADIOrderErrorDetailsDocument."
            }
          }
        }
      }
    },
    "result": {
      "type": "string",
      "description": "The result of the order once it has been completed.",
      "enum": ["SUCCEEDED", "FAILED", "SUCCEEDED_WITH_FAILURES"]
    },
    "metadata": {
      "type": "object",
      "description": "Metadata describing data to include in the created Thngs and their redirections.",
      "required": ["identifierKey"],
      "properties": {
        "targetAccount": {
          "type": "string",
          "example": "UfwwwypHPeKwYNbCXN1N5wcp",
          "description": "The ID of the account for which the ADIs were created."
        },
        "identifierKey": {
          "type": "string",
          "example": "gs1:21",
          "description": "The key which will be used in the `identifiers` object on the `Thng` to store the ID. For example, `gs1:21`."
        },
        "product": {
          "type": "string",
          "description": "Identifier string for the product to which the created ADI (Thng) will be associated. Can be either a product ID  (e.g: 'U4tqeXsDe6sN9NawR3ywFgYn') or colon separated identfier (e.g: 'gs1:01:12345678901234').",
          "example": "gs1:01:12345678901234"
        },
        "identifiers": {
          "type": "object",
          "description": "Key-value pairs of custom additional identifiers to include on the Thngs.",
          "example": { "internalOrderId": "123456" }
        },
        "customFields": {
          "type": "object",
          "description": "Key-value pairs of custom fields to include on the Thngs.",
          "example": { "color": "red" }
        },
        "tags": {
          "description": "Array of string tags to be added to include on the Thng.",
          "type": "array",
          "items": { "type": "string" },
          "example": ["shipped", "received"]
        },
        "shortDomain": {
          "type": "string",
          "example": "tn.gg",
          "description": "Short domain use in creating Thng redirections."
        },
        "defaultRedirectUrl": {
          "type": "string",
          "example": "https://evrythng.com?thng={evrythngId}",
          "description": "Default URL to redirect to. Placeholders can be used: {evrythngId} for the Thng ID or {shortId} for the short ID."
        },
        "project": {
          "type": "string",
          "description": "If specified, the Thngs created will be scoped to the project with this ID.",
          "example": "U5gBSMUHxpwHEsawaFdrnbkf",
          "minLength": 24,
          "maxLength": 24
        }
      }
    },
    "purchaseOrder": {
      "type": "string",
      "description": "ID of the associated purchase order.",
      "example": 7328468
    },
    "ids": {
      "type": "array",
      "description": "Array of string IDs to be used for each generated ADI.",
      "items": { "type": "string" },
      "uniqueItems": true,
      "example": ["827bd8a2", "897c9a7d", "90ab78a6"]
    },
    "customFields": {
      "type": "object",
      "description": "Object of case-sensititve key-value pairs of custom fields associated with the resource."
    },
    "identifiers": {
      "type": "object",
      "description": "Various identifiers (EPC, GTIN, etc.) as a JSON object with one or more key-value pairs."
    },
    "tags": {
      "type": "array",
      "description": "Array of string tags associated with this resource.",
      "items": {
        "type": "string",
        "maxLength": 60
      }
    },
    "idGeneration": {
      "type": "object",
      "description": "Metadata of the set of IDs for generation.",
      "required": ["length", "quantity"],
      "properties": {
        "prefix": {
          "type": "string",
          "example": "xz1",
          "description": "The prefix of every ID to be generated."
        },
        "suffix": {
          "type": "string",
          "example": "xz2",
          "description": "The suffix of every ID to be generated."
        },
        "characterSet": {
          "type": "string",
          "description": "The character set to be used for ID generation. Default value is 'AN-47'.",
          "example": "AN-47",
          "enum": ["GS1-64w", "AN-47", "UAN-28", "GS1-36w"]
        },
        "length": {
          "type": "number",
          "description": "The length of ID part which is going to be generated. Does not include 'prefix' and 'suffix' if were set. Allowed values are in range 8..20",
          "example": 8
        },
        "quantity": {
          "type": "number",
          "description": "The quantity of IDs to be generated. Maximal allowed value is 20000.",
          "example": 10000
        }
      }
    },
    "fileMetadata": {
      "type": "object",
      "description": "Contains configuration required for file generation.",
      "properties": {
        "csv": {
          "type": "object",
          "description": "Contains configuration parameters for txt file generation.",
          "properties": {
            "columns": {
              "type": "array",
              "description": "Set of characteristics of the ADI to be written in one row of the csv file.",
              "items": {
                "type": "string",
                "enum": ["digitalLink", "shortUrl", "identifier", "product"]
              },
              "example": ["product", "identifier", "shortUrl", "digitalLink"]
            },
            "digitalLinkDomain": {
              "type": "string",
              "example": "https://pxgkp.tn.gg",
              "description": "This url will be used for constructing digital link of ADI in a file if \\"columns\\" array contains \\"digitalLink\\"."
            }
          }
        },
        "txt": {
          "type": "object",
          "description": "Contains configuration parameters for txt file generation.",
          "properties": {
            "value": {
              "type": "string",
              "description": "Characteristic of the ADI. The value of this field will refer to ADI in the generated file.",
              "enum": ["digitalLink", "shortUrl", "identifier", "product"],
              "example": "digitalLink"
            },
            "digitalLinkDomain": {
              "type": "string",
              "example": "https://pxgkp.tn.gg",
              "description": "This url will be used for constructing digital link of the ADI in a file if \\"value\\" equals to the digitalLink."
            },
            "perLine": {
              "type": "number",
              "description": "Number of identifiers per line in the generated file.",
              "example": 3
            },
            "separator": {
              "type": "string",
              "description": "Character or sequence of characters to be used for separation of identifiers located in one line.",
              "example": "|"
            },
            "newLine": {
              "type": "string",
              "description": "Character or sequence of characters to be used as the end of the line.",
              "example": "\\\\r\\\
"
            }
          }
        }
      }
    },
    "results": {
      "type": "object",
      "description": "Object containing links to generated files.",
      "properties": {
        "identifiers": {
          "type": "object",
          "description": "Links to files with identifiers.",
          "properties": {
            "csv": {
              "type": "string",
              "description": "Link to csv file.",
              "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2d77b9636382476ed152b848eef3b44dbc75961827a027cafb8dab935e5bd312"
            },
            "txt": {
              "type": "string",
              "description": "Link to txt file.",
              "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d176238e2f99a925f6903e1abea25c81a9a719b8cd952cc71c407b5f111463f0"
            },
            "json": {
              "type": "string",
              "description": "Link to json file.",
              "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
            }
          }
        },
        "errors": {
          "type": "object",
          "description": "Link to file with errors happened during ADI generation.",
          "properties": {
            "json": {
              "type": "string",
              "description": "Link to the json file with errors.",
              "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
            }
          }
        }
      }
    }
  }
}
{
  "ids": [
    "serial1",
    "serial2"
  ],
  "purchaseOrder": "234567890",
  "metadata": {
    "identifierKey": "gs1:21",
    "customFields": {
      "factory": "0400321"
    },
    "product": "gs1:01:9780345418913",
    "tags": [
      "factory:0400321"
    ],
    "shortDomain": "tn.gg",
    "defaultRedirectUrl": "https://evrythng.com?id={shortId}",
    "project": "UH4t4AnhVXsat5wwagk9bpgh"
  },
  "identifiers": {
    "internalId": "X7JF"
  },
  "tags": [
    "X7JF"
  ],
  "fileMetadata": {    
       "csv":{
            "digitalLinkDomain":"https://pxgkp.tn.gg",
            "columns":["product","identifier","shortUrl","digitalLink"]
       },
       "txt":{
            "value":"digitalLink",
            "digitalLinkDomain":"https://pxgkp.tn.gg",
            "perLine":3,
            "separator":"|",
            "newLine":"\r\n"
       }
    },
  "results": {
        "identifiers": {
            "csv": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjENz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDbY56ddgCZtfm5hfUyA7zdUBSkQ9CbfMibIlj6GZD%2BBwIgNQFliwIMeVPuX2u9vR6N5Yqkp6PXzeEC24z1hNmDidYqkAQIRRABGgw5MDcyNjQ2MTk3MTMiDEhe7cBNLQrcCV7BISrtAxm1Gpl2ItkTUl4ZjYFv4JftXTQrrz92M62plVhOzy9ssF5biBKIchXx4i4AtVnOOFQtda%2Bgr4Eh5tyOlhlY8X9LJ%2BCYnK2v7OHNZkqW7mP4sg4a1WUU9sM7YsWQynP5ztTvnCNbb%2FkywZXbAwJvDM95xYYfca23a%2FOkw36EVRqFd27TNlCO%2B4QRhIJA0pMVqLol%2B6PNknSGZgkxdXkhd3O%2BWBIVxtpn2TsIbyGVpsiHq48papT45j96GUQbLMJwVddnv6HVcPZ7x9NsqmoUKTfuN57mk7x3lCGW8d5df7N4Vd6qwb5t8krf9bb663HDZ6Q%2FpocKeYJIZn0eMFLJ0%2Bzxz0537V7DqSN%2FDoKWKDzPSJ0TNf73ITilwjy1rdpuqXN8Afg68RwVwbidgRtIUhSW9SOaznXE085FIctT2kG9t3CTHQ7%2FbjlqFpYmNshTjveGgHSpsBzwE4x5FTfJ29JfzeQVbILvvW%2BIBAeyEeq%2BY2PbQzs5j4UwAh5qYGP%2Bd2odDU0CY8zhnsqeNZOXwqNDL2Ldk3jjm1%2FoVQL1%2Bsw2hs%2BTwlrQ17e7j7pxmaLBcYky209ppKSkL0pHst%2Fswsb9l6%2F2W8QghfjLXR5s17y4cqiG1uR%2Fs8ORpc%2BhZg9QHhJDF0pHKMYGUdXTHWswuszT9gU67wFuE4KcnPRyaWHWkR3mPMSjibO%2BiqAmxgDxtavZL1HDqE258qt97xrZ4oyW%2Fs8f%2B%2FybNha%2B67bbD0VqAGo0Lhuq8R13%2FWu7pCChZNFAQFWPkyQASJQTbFbUv%2BUd0PYrmgp8UCzr3Fvv2I9%2BNmk9ntWlV49RZDU7%2BAFELP4PHkkLCMDX4wPn6j0gQxX4TxLgvMw8yo6kMPrLyFjlqbXTPkTVSHrEp9cSJwH66uldyECqnk%2FvoT3EEZrzn1oXQo%2B8uyD5u5NjqVR6B39f%2FEDhty62zFHWmWw9ezEV3MQQ6qsPjQt2jRvDJ1Q17x%2FVSPdBYw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200601T132648Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1799&X-Amz-Credential=ASIA5GPJPOTAT4Z5FAVB%2F20200601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=bc5893194443a958257caf0638c9895c2f700628a1f887b1b05e190ab4b46a18",
            "json": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjENz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDbY56ddgCZtfm5hfUyA7zdUBSkQ9CbfMibIlj6GZD%2BBwIgNQFliwIMeVPuX2u9vR6N5Yqkp6PXzeEC24z1hNmDidYqkAQIRRABGgw5MDcyNjQ2MTk3MTMiDEhe7cBNLQrcCV7BISrtAxm1Gpl2ItkTUl4ZjYFv4JftXTQrrz92M62plVhOzy9ssF5biBKIchXx4i4AtVnOOFQtda%2Bgr4Eh5tyOlhlY8X9LJ%2BCYnK2v7OHNZkqW7mP4sg4a1WUU9sM7YsWQynP5ztTvnCNbb%2FkywZXbAwJvDM95xYYfca23a%2FOkw36EVRqFd27TNlCO%2B4QRhIJA0pMVqLol%2B6PNknSGZgkxdXkhd3O%2BWBIVxtpn2TsIbyGVpsiHq48papT45j96GUQbLMJwVddnv6HVcPZ7x9NsqmoUKTfuN57mk7x3lCGW8d5df7N4Vd6qwb5t8krf9bb663HDZ6Q%2FpocKeYJIZn0eMFLJ0%2Bzxz0537V7DqSN%2FDoKWKDzPSJ0TNf73ITilwjy1rdpuqXN8Afg68RwVwbidgRtIUhSW9SOaznXE085FIctT2kG9t3CTHQ7%2FbjlqFpYmNshTjveGgHSpsBzwE4x5FTfJ29JfzeQVbILvvW%2BIBAeyEeq%2BY2PbQzs5j4UwAh5qYGP%2Bd2odDU0CY8zhnsqeNZOXwqNDL2Ldk3jjm1%2FoVQL1%2Bsw2hs%2BTwlrQ17e7j7pxmaLBcYky209ppKSkL0pHst%2Fswsb9l6%2F2W8QghfjLXR5s17y4cqiG1uR%2Fs8ORpc%2BhZg9QHhJDF0pHKMYGUdXTHWswuszT9gU67wFuE4KcnPRyaWHWkR3mPMSjibO%2BiqAmxgDxtavZL1HDqE258qt97xrZ4oyW%2Fs8f%2B%2FybNha%2B67bbD0VqAGo0Lhuq8R13%2FWu7pCChZNFAQFWPkyQASJQTbFbUv%2BUd0PYrmgp8UCzr3Fvv2I9%2BNmk9ntWlV49RZDU7%2BAFELP4PHkkLCMDX4wPn6j0gQxX4TxLgvMw8yo6kMPrLyFjlqbXTPkTVSHrEp9cSJwH66uldyECqnk%2FvoT3EEZrzn1oXQo%2B8uyD5u5NjqVR6B39f%2FEDhty62zFHWmWw9ezEV3MQQ6qsPjQt2jRvDJ1Q17x%2FVSPdBYw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200601T132648Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1799&X-Amz-Credential=ASIA5GPJPOTAT4Z5FAVB%2F20200601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=221055e04ab81346c516cc8350df1fecdf327de73c237a81e28973507c625f50",
            "txt": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjENz%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaCXVzLWVhc3QtMSJHMEUCIQDbY56ddgCZtfm5hfUyA7zdUBSkQ9CbfMibIlj6GZD%2BBwIgNQFliwIMeVPuX2u9vR6N5Yqkp6PXzeEC24z1hNmDidYqkAQIRRABGgw5MDcyNjQ2MTk3MTMiDEhe7cBNLQrcCV7BISrtAxm1Gpl2ItkTUl4ZjYFv4JftXTQrrz92M62plVhOzy9ssF5biBKIchXx4i4AtVnOOFQtda%2Bgr4Eh5tyOlhlY8X9LJ%2BCYnK2v7OHNZkqW7mP4sg4a1WUU9sM7YsWQynP5ztTvnCNbb%2FkywZXbAwJvDM95xYYfca23a%2FOkw36EVRqFd27TNlCO%2B4QRhIJA0pMVqLol%2B6PNknSGZgkxdXkhd3O%2BWBIVxtpn2TsIbyGVpsiHq48papT45j96GUQbLMJwVddnv6HVcPZ7x9NsqmoUKTfuN57mk7x3lCGW8d5df7N4Vd6qwb5t8krf9bb663HDZ6Q%2FpocKeYJIZn0eMFLJ0%2Bzxz0537V7DqSN%2FDoKWKDzPSJ0TNf73ITilwjy1rdpuqXN8Afg68RwVwbidgRtIUhSW9SOaznXE085FIctT2kG9t3CTHQ7%2FbjlqFpYmNshTjveGgHSpsBzwE4x5FTfJ29JfzeQVbILvvW%2BIBAeyEeq%2BY2PbQzs5j4UwAh5qYGP%2Bd2odDU0CY8zhnsqeNZOXwqNDL2Ldk3jjm1%2FoVQL1%2Bsw2hs%2BTwlrQ17e7j7pxmaLBcYky209ppKSkL0pHst%2Fswsb9l6%2F2W8QghfjLXR5s17y4cqiG1uR%2Fs8ORpc%2BhZg9QHhJDF0pHKMYGUdXTHWswuszT9gU67wFuE4KcnPRyaWHWkR3mPMSjibO%2BiqAmxgDxtavZL1HDqE258qt97xrZ4oyW%2Fs8f%2B%2FybNha%2B67bbD0VqAGo0Lhuq8R13%2FWu7pCChZNFAQFWPkyQASJQTbFbUv%2BUd0PYrmgp8UCzr3Fvv2I9%2BNmk9ntWlV49RZDU7%2BAFELP4PHkkLCMDX4wPn6j0gQxX4TxLgvMw8yo6kMPrLyFjlqbXTPkTVSHrEp9cSJwH66uldyECqnk%2FvoT3EEZrzn1oXQo%2B8uyD5u5NjqVR6B39f%2FEDhty62zFHWmWw9ezEV3MQQ6qsPjQt2jRvDJ1Q17x%2FVSPdBYw%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200601T132648Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1799&X-Amz-Credential=ASIA5GPJPOTAT4Z5FAVB%2F20200601%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=800ce17411f6a624b1bf086638b1cf631da9e45350a6c7b24eba6d91e5879267"
        }
    }  
}

See also: ADIOrderMetadataDocument, ADIOrderStatusDocument, ADIOrderIDGenerationDocument, ADIOrderFileMetadataDocument, ADIOrderResultsDocument


ADIOrderMetadataDocument Data Model

Object describing the data used as input for the order, such as what the output Thngs should look like.

.targetAccount (string)
    The ID of the account for which the ADIs were created.

.identifierKey (string, required)
    The key which will be used in the `identifiers` object on
    the `Thng` to store the ID. For example, `gs1:21`.

.product (string)
    Identifier string for the product to which the created ADI
    (Thng) will be associated. Can be either a product ID  (e.g:
    'U4tqeXsDe6sN9NawR3ywFgYn') or colon separated identfier
    (e.g: 'gs1:01:12345678901234').

.identifiers (object)
    Key-value pairs of custom additional identifiers to include
    on the Thngs.

.customFields (object)
    Key-value pairs of custom fields to include on the Thngs.

.tags (array of string)
    Array of string tags to be added to include on the Thng.

.shortDomain (string)
    Short domain use in creating Thng redirections.

.defaultRedirectUrl (string)
    Default URL to redirect to. Placeholders can be used:
    {evrythngId} for the Thng ID or {shortId} for the short ID.

.project (string)
    If specified, the Thngs created will be scoped to the
    project with this ID.
{
  "type": "object",
  "description": "Metadata describing data to include in the created Thngs and their redirections.",
  "required": ["identifierKey"],
  "properties": {
    "targetAccount": {
      "type": "string",
      "example": "UfwwwypHPeKwYNbCXN1N5wcp",
      "description": "The ID of the account for which the ADIs were created."
    },
    "identifierKey": {
      "type": "string",
      "example": "gs1:21",
      "description": "The key which will be used in the `identifiers` object on the `Thng` to store the ID. For example, `gs1:21`."
    },
    "product": {
      "type": "string",
      "description": "Identifier string for the product to which the created ADI (Thng) will be associated. Can be either a product ID  (e.g: 'U4tqeXsDe6sN9NawR3ywFgYn') or colon separated identfier (e.g: 'gs1:01:12345678901234').",
      "example": "gs1:01:12345678901234"
    },
    "identifiers": {
      "type": "object",
      "description": "Key-value pairs of custom additional identifiers to include on the Thngs.",
      "example": { "internalOrderId": "123456" }
    },
    "customFields": {
      "type": "object",
      "description": "Key-value pairs of custom fields to include on the Thngs.",
      "example": { "color": "red" }
    },
    "tags": {
      "description": "Array of string tags to be added to include on the Thng.",
      "type": "array",
      "items": { "type": "string" },
      "example": ["shipped", "received"]
    },
    "shortDomain": {
      "type": "string",
      "example": "tn.gg",
      "description": "Short domain use in creating Thng redirections."
    },
    "defaultRedirectUrl": {
      "type": "string",
      "example": "https://evrythng.com?thng={evrythngId}",
      "description": "Default URL to redirect to. Placeholders can be used: {evrythngId} for the Thng ID or {shortId} for the short ID."
    },
    "project": {
      "type": "string",
      "description": "If specified, the Thngs created will be scoped to the project with this ID.",
      "example": "U5gBSMUHxpwHEsawaFdrnbkf",
      "minLength": 24,
      "maxLength": 24
    }
  }
}
{
  "identifierKey": "gs1:21",
  "customFields": {
    "factory": "0400321"
  },
  "product": "gs1:01:9780345418913",
  "tags": [
    "factory:0400321"
  ],
  "shortDomain": "tn.gg",
  "defaultRedirectUrl": "https://evrythng.com?id={shortId}",
  "project": "UH4t4AnhVXsat5wwagk9bpgh"
}

ADIOrderIDGenerationDocument Data Model

Metadata of the set of IDs for generation.

.prefix (string)
    The prefix of every ID to be generated.

.suffix (string)
    The suffix of every ID to be generated.

.characterSet (string, one of 'GS1-64w', 'AN-47', 'UAN-28', 'GS1-36w')
    The character set to be used for ID generation. Default
    value is 'AN-47'.

.length (number, required)
    The length of ID part which is going to be generated. Does
    not include 'prefix' and 'suffix' if were set. Allowed
    values are in range 8..20

.quantity (number, required)
    The quantity of IDs to be generated. Maximal allowed value
    is 20000.
{
  "type": "object",
  "description": "Metadata of the set of IDs for generation.",
  "required": ["length", "quantity"],
  "properties": {
    "prefix": {
      "type": "string",
      "example": "xz1",
      "description": "The prefix of every ID to be generated."
    },
    "suffix": {
      "type": "string",
      "example": "xz2",
      "description": "The suffix of every ID to be generated."
    },
    "characterSet": {
      "type": "string",
      "description": "The character set to be used for ID generation. Default value is 'AN-47'.",
      "example": "AN-47",
      "enum": ["GS1-64w", "AN-47", "UAN-28", "GS1-36w"]
    },
    "length": {
      "type": "number",
      "description": "The length of ID part which is going to be generated. Does not include 'prefix' and 'suffix' if were set. Allowed values are in range 8..20",
      "example": 8
    },
    "quantity": {
      "type": "number",
      "description": "The quantity of IDs to be generated. Maximal allowed value is 20000.",
      "example": 10000
    }
  }
}
{
  "prefix": "evt",
  "suffix": "1119",
  "characterSet": "AN-47",
  "length": 10,
  "quantity": 10000
}

The values available for characterSet define which characters will be used in the IDs generated. These are:

  • AN-47 (Unambiguous alphanumeric without vowels) - 23456789BCDFGHJKLMNPQRSTVWXZbcdfghjkmnpqrstvwxz
  • GS1-64w - (Web-safe GS1 Serial AI encodable character set) -0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz
  • UAN-28 - (Unambiguous AlphaNumeric) 23456789BCDFGHJKLMNPQRSTVWXZ
  • GS1-36w - (Web-safe GS1 Serial AI encodable character set) 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ
  • N - (Numeric) 0123456789 - note that the unique range for numeric is limited so use with caution!

ADIOrderStatusDocument Data Model

.state (string, one of 'pending', 'in_progress', 'completed')
    The state of the order.

.requested (integer)
    Number of requested identifiers.

.adis (ADIOrderProgressDocument)
    Creation progress and errors
{
  "type": "object",
  "description": "Object describing the status of an ADI order",
  "properties": {
    "state": {
      "type": "string",
      "description": "The state of the order.",
      "enum": ["pending", "in_progress", "completed"]
    },
    "requested": {
      "type": "integer",
      "description": "Number of requested identifiers."
    },
    "adis": {
      "type": "object",
      "description": "Creation progress and errors",
      "properties": {
        "created": {
          "type": "integer",
          "description": "Number of actions created."
        },
        "pending": {
          "type": "integer",
          "description": "Number of actions waiting for creation."
        },
        "errorsCount": {
          "type": "integer",
          "description": "Number of errors occurred."
        },
        "errors": {
          "type": "object",
          "description": "The errors details. Key - the identifier, the value - the details of the issue."
        }
      }
    }
  }
}

See also: ADIOrderProgressDocument


ADIOrderProgressDocument Data Model

.created (integer)
    Number of actions created.

.pending (integer)
    Number of actions waiting for creation.

.errorsCount (integer)
    Number of errors occurred.

.errors (ADIOrderErrorsDocument)
    The list of errors. Key - the identifier value, the value -
    ADIOrderErrorDetailsDocument.
{
  "type": "object",
  "description": "Creation progress and errors",
  "properties": {
    "created": {
      "type": "integer",
      "description": "Number of actions created."
    },
    "pending": {
      "type": "integer",
      "description": "Number of actions waiting for creation."
    },
    "errorsCount": {
      "type": "integer",
      "description": "Number of errors occurred."
    },
    "errors": {
      "type": "object",
      "description": "The list of errors. Key - the identifier value, the value - ADIOrderErrorDetailsDocument."
    }
  }
}

See also: ADIOrderErrorDetailsDocument


ADIOrderErrorDetailsDocument Data Model

.code (number)
    The code of the error.

.error (string)
    The error message.
{
  "type": "object",
  "description": "Details of the error of the particular identifier processing.",
  "properties": {
    "code": {
      "type": "number",
      "description": "The code of the error.",
      "example": 80300010
    },
    "error": {
      "type": "string",
      "description": "The error message.",
      "example": "An identity with that Identifier and ADI order already exists for that same account"
    }
  }
}

Error codes:

  • 80000010 - The identifier has invalid format.
  • 80000020 - ADI Order not found.
  • 80000030 - ADI Order event not found.
  • 80000040 - Product not found.
  • 80000050 - Array of identifiers contains more ids than allowed.
  • 80000060 - Provided list of identifiers contains duplicates.
  • 80000070 - Action type doesn't exist.
  • 80000080 - Identifiers doesn't belong to the specified adi-order.
  • 80000090 - Account is not allowed to make request in specified target account.
  • 80000100 - Short domain not specified together with default redirect URL.
  • 80000110 - Provided filter is not valid.
  • 80000120 - Invalid query parameter.
  • 80000130 - ADI Order is in progress.
  • 80000140 - Product is not unique.
  • 80000150 - ADI Order request body is not valid
  • 80000160 - Requested IDs quantity is not allowed
  • 80000170 - Project is not found
  • 80000180 - The list of identifiers contains forbidden characters
  • 80009998 - Request body is missing.
  • 80009999 - Internal unknown error.
  • 80100010 - Thng already exists.
  • 80100020 - Redirection for shortDomain and shortId already exists and points to the different resource.
  • 80100030 - Product with the identifier is not found.
  • 80100040 - Product with the identifier is not unique.
  • 80109999 - Internal unknown error.
  • 80200010 - Thng with the identifier is not found
  • 80300010 - An identity with that Identifier and ADI order already exists for that same account.

ADIOrderFileMetadataDocument Data Model

Contains configuration required for file generation.

.csv (ADIOrderFileCsvMetadataDocument)
    Contains configuration parameters for txt file generation.

.txt (ADIOrderFileTxtMetadataDocument)
    Contains configuration parameters for txt file generation.
{
  "type": "object",
  "description": "Contains configuration required for file generation.",
  "properties": {
    "csv": {
      "type": "object",
      "description": "Contains configuration parameters for txt file generation.",
      "properties": {
        "columns": {
          "type": "array",
          "description": "Set of characteristics of the ADI to be written in one row of the csv file.",
          "items": {
            "type": "string",
            "enum": ["digitalLink", "shortUrl", "identifier", "product"]
          },
          "example": ["product", "identifier", "shortUrl", "digitalLink"]
        },
        "digitalLinkDomain": {
          "type": "string",
          "example": "https://pxgkp.tn.gg",
          "description": "This url will be used for constructing digital link of ADI in a file if \"columns\" array contains \"digitalLink\"."
        }
      }
    },
    "txt": {
      "type": "object",
      "description": "Contains configuration parameters for txt file generation.",
      "properties": {
        "value": {
          "type": "string",
          "description": "Characteristic of the ADI. The value of this field will refer to ADI in the generated file.",
          "enum": ["digitalLink", "shortUrl", "identifier", "product"],
          "example": "digitalLink"
        },
        "digitalLinkDomain": {
          "type": "string",
          "example": "https://pxgkp.tn.gg",
          "description": "This url will be used for constructing digital link of the ADI in a file if \"value\" equals to the digitalLink."
        },
        "perLine": {
          "type": "number",
          "description": "Number of identifiers per line in the generated file.",
          "example": 3
        },
        "separator": {
          "type": "string",
          "description": "Character or sequence of characters to be used for separation of identifiers located in one line.",
          "example": "|"
        },
        "newLine": {
          "type": "string",
          "description": "Character or sequence of characters to be used as the end of the line.",
          "example": "\\r\\n"
        }
      }
    }
  }
}

See also: ADIOrderFileCsvMetadataDocument, ADIOrderFileTxtMetadataDocument


ADIOrderFileCsvMetadataDocument Data Model

Contains configuration parameters for txt file generation.

.columns (array of string)
    Set of characteristics of the ADI to be written in one row 
    of the csv file.

.digitalLinkDomain (string)
    This url will be used for constructing digital link of ADI 
    in a file if "columns" array contains "digitalLink".
{
  "type": "object",
  "description": "Contains configuration parameters for txt file generation.",
  "properties": {
    "columns": {
      "type": "array",
      "description": "Set of characteristics of the ADI to be written in one row of the csv file.",
      "items": {
        "type": "string",
        "enum": ["digitalLink", "shortUrl", "identifier", "product"]
      },
      "example": ["product", "identifier", "shortUrl", "digitalLink"]
    },
    "digitalLinkDomain": {
      "type": "string",
      "example": "https://pxgkp.tn.gg",
      "description": "This url will be used for constructing digital link of ADI in a file if \"columns\" array contains \"digitalLink\"."
    }
  }
}

ADIOrderFileTxtMetadataDocument Data Model

Contains configuration parameters for txt file generation.

.value (string, one of 'digitalLink', 'shortUrl', 'identifier', 'product')
    Characteristic of the ADI. The value of this field will 
    refer to ADI in the generated file.

.digitalLinkDomain (string)
    This url will be used for constructing digital link of the 
    ADI in a file if "value" equals to the digitalLink.

.perLine (number)
    Number of identifiers per line in the generated file.

.separator (string)
    Character or sequence of characters to be used for 
    separation of identifiers located in one line.

.newLine (string)
    Character or sequence of characters to be used as the end of 
    the line.
{
  "type": "object",
  "description": "Contains configuration parameters for txt file generation.",
  "properties": {
    "value": {
      "type": "string",
      "description": "Characteristic of the ADI. The value of this field will refer to ADI in the generated file.",
      "enum": ["digitalLink", "shortUrl", "identifier", "product"],
      "example": "digitalLink"
    },
    "digitalLinkDomain": {
      "type": "string",
      "example": "https://pxgkp.tn.gg",
      "description": "This url will be used for constructing digital link of the ADI in a file if \"value\" equals to the digitalLink."
    },
    "perLine": {
      "type": "number",
      "description": "Number of identifiers per line in the generated file.",
      "example": 3
    },
    "separator": {
      "type": "string",
      "description": "Character or sequence of characters to be used for separation of identifiers located in one line.",
      "example": "|"
    },
    "newLine": {
      "type": "string",
      "description": "Character or sequence of characters to be used as the end of the line.",
      "example": "\\r\\n"
    }
  }
}

ADIOrderResultsDocument Data Model

Object containing links to generated files.

.identifiers (ADIOrderFileIdentifiersDocument)
    Links to files with identifiers.

.errors (ADIOrderFileErrorsDocument)
    Link to file with errors happened during ADI generation.
{
  "type": "object",
  "description": "Object containing links to generated files.",
  "properties": {
    "identifiers": {
      "type": "object",
      "description": "Links to files with identifiers.",
      "properties": {
        "csv": {
          "type": "string",
          "description": "Link to csv file.",
          "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2d77b9636382476ed152b848eef3b44dbc75961827a027cafb8dab935e5bd312"
        },
        "txt": {
          "type": "string",
          "description": "Link to txt file.",
          "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d176238e2f99a925f6903e1abea25c81a9a719b8cd952cc71c407b5f111463f0"
        },
        "json": {
          "type": "string",
          "description": "Link to json file.",
          "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
        }
      }
    },
    "errors": {
      "type": "object",
      "description": "Link to file with errors happened during ADI generation.",
      "properties": {
        "json": {
          "type": "string",
          "description": "Link to the json file with errors.",
          "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
        }
      }
    }
  }
}

See also: ADIOrderFileIdentifiersDocument, ADIOrderFileErrorsDocument


ADIOrderFileIdentifiersDocument Data Model

Links to files with identifiers.

.csv (string)
    Link to csv file.

.txt (string)
    Link to txt file.

.json (string)
    Link to json file.
{
  "type": "object",
  "description": "Links to files with identifiers.",
  "properties": {
    "csv": {
      "type": "string",
      "description": "Link to csv file.",
      "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2d77b9636382476ed152b848eef3b44dbc75961827a027cafb8dab935e5bd312"
    },
    "txt": {
      "type": "string",
      "description": "Link to txt file.",
      "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d176238e2f99a925f6903e1abea25c81a9a719b8cd952cc71c407b5f111463f0"
    },
    "json": {
      "type": "string",
      "description": "Link to json file.",
      "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
    }
  }
}

ADIOrderFileErrorsDocument Data Model

Link to file with errors happened during ADI generation.

.json (string)
    Link to the json file with errors.
{
  "type": "object",
  "description": "Link to file with errors happened during ADI generation.",
  "properties": {
    "json": {
      "type": "string",
      "description": "Link to the json file with errors.",
      "example": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
    }
  }
}
{
  "json": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
}

Create an ADI Order

POST /adis/orders
Content-Type: application/json
Authorization: $OPERATOR_API_KEY

ADIOrderDocument
curl -i -H Content-Type:application/json \
  -H Authorization:$OPERATOR_API_KEY \
  -X POST https://api.evrythng.com/adis/orders \
  -d '{
  "ids": [
    "serial1",
    "serial2"
  ],
  "purchaseOrder": "234567890",
  "metadata": {
    "identifierKey": "gs1:21",
    "customFields": {
      "factory": "0400321"
    },
    "product": "gs1:01:9780345418913",
    "tags": [
      "factory:0400321"
    ],
    "shortDomain": "tn.gg",
    "defaultRedirectUrl": "https://evrythng.com?id={shortId}",
    "project": "UH4t4AnhVXsat5wwagk9bpgh"
  },
  "identifiers": {
    "internalId": "X7JF"
  },
  "tags": [
    "X7JF"
  ],
  "fileMetadata": {    
       "csv":{
            "digitalLinkDomain":"https://pxgkp.tn.gg",
            "columns":["product","identifier","shortUrl","digitalLink"]
       },
       "txt":{
            "value":"digitalLink",
            "digitalLinkDomain":"https://pxgkp.tn.gg",
            "perLine":3,
            "separator":"|",
            "newLine":"\r\n"
       }
    }
}'
const payload = {
  ids: [
    'serial1',
    'serial2'
  ],
  purchaseOrder: '234567890',
  metadata: {
    identifierKey: 'gs1:21',
    customFields: {
      factory: '0400321'
    },
    product: 'gs1:01:9780345418913',
    tags: [
      'factory:0400321'
    ],
    shortDomain: 'tn.gg',
    defaultRedirectUrl: 'https://evrythng.com?id={shortId}',
    project: 'UH4t4AnhVXsat5wwagk9bpgh'
  },
  identifiers: {
    internalId: 'X7JF'
  },
  tags: [
    'X7JF'
  ]
};

operator.adiOrder().create(payload)
    .then(console.log);
HTTP/1.1 201 Created
Content-Type: application/json

{
  "id": "U7Ep5GytqG8YhMRawYrDXPgt",
  "status": {
    "state": "pending",
    "requested": 2,
    "adis": {
      "created": 0,
      "pending": 0,
      "errorsCount": 0
    }
  },
  "metadata": {
    "identifierKey": "gs1:21",
    "customFields": {
      "factory": "0400321"
    },
    "tags": [
      "factory:0400321"
    ],
    "shortDomain": "tn.gg",
    "defaultRedirectUrl": "https://evrythng.com?id={shortId}",
    "project": "UH4t4AnhVXsat5wwagk9bpgh"
  },
  "purchaseOrder": "234567890",
  "identifiers": {
    "internalId": "X7JF"
  },
  "tags": [
    "X7JF"
  ],
  "fileMetadata": {
    "csv": {
      "digitalLinkDomain": "https://pxgkp.tn.gg",
      "columns": [
        "product",
        "identifier",
        "shortUrl",
        "digitalLink"
      ]
    },
    "txt": {
      "digitalLinkDomain": "https://pxgkp.tn.gg",
      "value": "digitalLink",
      "perLine": 3,
      "separator": "|",
      "newLine": "\r\n"
    }
  }
}

Read all ADI Orders

Retrieve a list of ADI Orders.

GET /adis/orders
Authorization: $OPERATOR_API_KEY
curl -i -H Authorization:$OPERATOR_API_KEY \
  -X GET https://api.evrythng.com/adis/orders
operator.adiOrder().read()
  .then(console.log);
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "id": "UNTrNKg2BMsNt7wRwYymrGhm",
    "purchaseOrder": "234567890",
    "metadata": {
      "identifierKey": "gs1:21",
      "customFields": {
        "factory": "0400321"
      },
      "product": "gs1:01:9780345418913",
      "tags": [
        "factory:0400321"
      ],
      "shortDomain": "tn.gg",
      "defaultRedirectUrl": "https://evrythng.com?id={shortId}",
      "project": "UH4t4AnhVXsat5wwagk9bpgh"
    },
    "identifiers": {
      "internalId": "X7JF"
    },
    "tags": [
      "X7JF"
    ],
    "fileMetadata": {
      "csv": {
        "digitalLinkDomain": "https://pxgkp.tn.gg",
        "columns": [
          "product",
          "identifier",
          "shortUrl",
          "digitalLink"
        ]
      },
      "txt": {
        "digitalLinkDomain": "https://pxgkp.tn.gg",
        "value": "digitalLink",
        "perLine": 3,
        "separator": "|",
        "newLine": "\r\n"
      }
    }
  }
]

Read an ADI Order

Read a single ADI Order by its id.

GET /adis/orders/:orderId
Authorization: $OPERATOR_API_KEY
curl -i -H Authorization: $OPERATOR_API_KEY \
  -X GET https://api.evrythng.com/adis/orders/:orderId
const orderId = 'UNTrNKg2BMsNt7wRwYymrGhm';

evrythng.adiOrder(orderId).read()
    .then(console.log);
HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "UNTrNKg2BMsNt7wRwYymrGhm",
  "status": {
    "state": "completed",
    "requested": 2,
    "created": 2,
    "pending": 0,
    "errorsCount": 0
  },
  "purchaseOrder": "234567890",
  "metadata": {
    "identifierKey": "gs1:21",
    "customFields": {
      "factory": "0400321"
    },
    "product": "gs1:01:9780345418913",
    "tags": [
      "factory:0400321"
    ],
    "shortDomain": "tn.gg",
    "defaultRedirectUrl": "https://evrythng.com?id={shortId}"
  },
  "identifiers": {
    "internalId": "X7JF"
  },
  "tags": [
    "X7JF"
  ],
  "fileMetadata": {
    "csv": {
      "digitalLinkDomain": "https://pxpra.tn.gg",
      "columns": [
        "product",
        "identifier",
        "shortUrl",
        "digitalLink"
      ]
    },
    "txt": {
      "digitalLinkDomain": "https://pxpra.tn.gg",
      "value": "digitalLink",
      "perLine": 3,
      "separator": "|",
      "newLine": "\\\\r\\\
"
    }
  },
  "results": {
    "identifiers": {
      "csv": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.csv?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=2d77b9636382476ed152b848eef3b44dbc75961827a027cafb8dab935e5bd312",
      "txt": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.txt?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=d176238e2f99a925f6903e1abea25c81a9a719b8cd952cc71c407b5f111463f0",
      "json": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/identifiers-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
    },
    "errors": {
      "json": "https://prod-us-east-1-thng-store-files-api.s3.amazonaws.com/U6nACFrWCc94QQaaRpCYFQem/errors-Us6P2gr8hx8tteYxX8Qt5kYm.json?X-Amz-Security-Token=IQoJb3JpZ2luX2VjEHkaCXVzLWVhc3QtMSJGMEQCIFhu9OK1R3lMU6eNE7fwqRsLJDAfeUghAfBybboZkUZhAiBWfnTp91%2FmMXZZCCMJ57nJbEZbAHk5de6nRqlH%2F9RdfiqZBAjS%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAEaDDkwNzI2NDYxOTcxMyIMVLWrFSSGgRmq5gMrKu0DHcsnuXEC6gzOdvNJNgqAI9xkbF5fkvQIfuDTegRkl99E0SWb6IwT216ALmpz9%2FEF8TQggkE0MsUprIckZMr7YN256iRskeAR3zEcPddaCeN4RVjfpUj3Q%2FPMQfmpcIxPUrSF78eKb2jQUJPqvSQ7FKo92wkZWOOX2dodVhMpnqB%2F7rMON69O3utaST4i5pUlV%2Fvhihhe%2BYE%2BPy317w0jFQqmZ7CHN82PKPAUw3UeI2zhSmxsGuO2hOoCXQzjLrwUYt7sfNU64k9Lr%2Byr4kPBvo3Pa8IjflLs%2BVV2SJ5oCsft%2Fh7r%2FWeiemQM6%2BlHwzrDoUfCpl2wDSy6koisHnoCmqD5ZvQdhapUDRV7dTHDsv%2ByW4m8oiHBxyFIioqE9X6U%2Fx0DLXZyk8WNQn5eSNDOYX6zxTQ0c8qWzfQsIHXiAe%2FY1JU7eNcohBvR%2B571YYmtUHPZUpvfAlQ0Og15dRiqof5MC1a2kJMCNERXvosl3Ws4Ib5IkWwEotlp90ru5AlQAVG8c8o8EMf9qEnvO69wgqTfDV4hw6geTBlmMUr2HuXXq1H7XhOqtABBO49ceH4p2Pre5gndtiMp6F9jBVYK0Qghw%2B7utGxMTQJU2B3YjUN9XxR6cw5NuR6ayi%2Fd3f5hCQvBl7eCLHIZGyNcojDh%2B732BTrwAVlmogLkf%2FUgNWFa3zH2rrQfgFmlvnzD3rGfnXhyWk8zTd4Eysk67nvCwH7AV0ecWKhC%2F0Nso5QfFLRmWx%2FcX6weDgFGZf%2BvCFjy%2B8h4cUGABmzx1%2B2LSl9zBClm7YVCx8KgpPaOJdQ%2B5ffZgA4gth2QA3fm3UFT5Io95Xf9B%2Fv8wvxNKl2i68iC9j59Vnn1XeUA8jUFx%2F%2Fncks%2BhZjFmNhPd2rios9zHoGtTcj0CxmZUHkvwqiJsl6cDsgUqCdcE8wFLBBs4HVmwbXHQHZzCrhEBvZSKgK5KrKz5vsVSGPzLvS9YtjNZJZtGu%2FfowklMQ%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20200528T102654Z&X-Amz-SignedHeaders=content-type%3Bhost%3Bx-amz-acl&X-Amz-Expires=1800&X-Amz-Credential=ASIA5GPJPOTARQZW24UV%2F20200528%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=b97e216056c7bab6e2a24ebc15f1e496cdff632e56fa6b19a837bc49be084167"
    }
  }
}

Retrieve ADI Order IDs as Text, CSV and JSON files

Once the ID files have been generated, the file links will be returned within results.identifiers when you read the Order.

Please note that there will be a delay between the order status changing to Complete and the files being available.

To retrieve the IDs, select the link for the format you require and send a GET request with the following additional headers:

x-amz-acl: private
Content-Type: text/csv
x-amz-acl: private
Content-Type: text/plain
x-amz-acl: private
Content-Type: application/json

Your file links expire after 30 minutes. To get new links, retrieve the ADI Order again.

Retrieve ADI Order errors as JSON file

If there were errors, you can download a JSON file containing these errors from the file location referenced in results.errors.json. Send a GET request with the following additional headers:

x-amz-acl: private
Content-Type: application/json

ADI Order Events

Once an ADI Order has completed, it is also possible to create events represented by actions on the Thngs created through the order, such as encodings or other supply-chain related real-world events. This can be used to record in one request the action on all the items in the order.

If the ADI Order was created with the metadata.project property specified, any events created for this order will result in actions scoped to the same project.

ADIOrderEventDocument Data Model

Object containing action details and IDs of ADIs to create actions for.

.id (string)
    id of adi order event

.status (ADIOrderEventStatusDocument)
    Object describing the status of an ADI order event

.result (string, one of 'succeeded', 'failed', 'succeeded_with_failures')
    adi order event processing result

.metadata (ActionDocument, required)
    An object representing a Platform action.

.ids (array of string, required)
    array of ADIs' ids to create actions for

.customFields (object)
    Object of case-sensititve key-value pairs of custom fields 
    associated with the resource.

.identifiers (object)
    Various identifiers (EPC, ISBN, etc.) as a JSON object with 
    one or more key-value pairs.

.tags (array of string)
    Array of string tags associated with this resource.
{
  "description": "Object containing action details and IDs of ADIs to create actions for.",
  "type": "object",
  "required": ["metadata", "ids"],
  "properties": {
    "id": {
      "type": "string",
      "description": "id of adi order event",
      "example": "U7x9gTmMRFEaSHxMC5g8bqSd"
    },
    "status": {
      "type": "object",
      "description": "Object describing the status of an ADI order event",
      "properties": {
        "state": {
          "type": "string",
          "description": "The state of the order event.",
          "enum": ["pending", "in_progress", "completed"]
        },
        "requested": {
          "type": "integer",
          "description": "Number of actions requested for identifiers of adi order."
        },
        "events": {
          "type": "object",
          "description": "Creation progress and errors",
          "properties": {
            "created": {
              "type": "integer",
              "description": "Number of actions created."
            },
            "pending": {
              "type": "integer",
              "description": "Number of actions waiting for creation."
            },
            "errorsCount": {
              "type": "integer",
              "description": "Number of errors occurred."
            },
            "errors": {
              "type": "object",
              "description": "The errors details. Key - the identifier, the value - the details of the issue."
            }
          }
        }
      }
    },
    "result": {
      "type": "string",
      "description": "adi order event processing result",
      "enum": ["succeeded", "failed", "succeeded_with_failures"]
    },
    "metadata": {
      "additionalProperties": false,
      "type": "object",
      "description": "An object representing a Platform action.",
      "required": ["type"],
      "properties": {
        "type": {
          "type": "string",
          "description": "The action type."
        },
        "id": {
          "type": "string",
          "description": "The ID of this resource.",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
          "readOnly": true
        },
        "user": {
          "type": "string",
          "description": "The EVRYTHNG ID of the user who has performed this action.",
          "readOnly": true,
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        },
        "createdAt": {
          "type": "integer",
          "description": "Timestamp when the resource was created.",
          "readOnly": true,
          "minimum": 0
        },
        "createdByProject": {
          "type": "string",
          "description": "The EVRYTHNG ID of the project who has performed this action.",
          "readOnly": true,
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        },
        "createdByApp": {
          "type": "string",
          "description": "The EVRYTHNG ID of the application who has performed this action.",
          "readOnly": true,
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        },
        "thng": {
          "type": "string",
          "description": "The EVRYTHNG ID of the Thng this action was carried out on.",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        },
        "product": {
          "type": "string",
          "description": "The EVRYTHNG product ID associated with the Thng this action was carried out on.",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        },
        "collection": {
          "type": "string",
          "description": "The EVRYTHNG ID of the collection this action was carried out on. Custom action types only.",
          "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
        },
        "timestamp": {
          "type": "integer",
          "description": "The timestamp when the action took place. Filled automatically if unspecified.",
          "readOnly": true,
          "minimum": 0
        },
        "identifiers": {
          "type": "object",
          "description": "Various identifiers (EPC, GTIN, etc.) as a JSON object with one or more key-value pairs."
        },
        "location": {
          "additionalProperties": false,
          "type": "object",
          "description": "An object representing a location. Either 'position' or 'place' us required.",
          "properties": {
            "position": {
              "type": "object",
              "description": "A GeoJSON Point object. The coordinate order is longitude, then latitude.",
              "required": ["type", "coordinates"],
              "properties": {
                "type": {
                  "type": "string",
                  "description": "The type of the point.",
                  "enum": ["Point"]
                },
                "coordinates": {
                  "type": "array",
                  "description": "The point coordinates",
                  "items": {
                    "type": "number",
                    "minimum": -180,
                    "maximum": 180
                  }
                }
              }
            },
            "createdAt": {
              "type": "integer",
              "description": "Timestamp when the resource was created.",
              "readOnly": true,
              "minimum": 0
            },
            "timestamp": {
              "type": "integer",
              "description": "The time the location update occurred, or filled automatically by the Platform if omitted.",
              "readOnly": true
            },
            "longitude": {
              "type": "number",
              "description": "The longitude."
            },
            "latitude": {
              "type": "number",
              "description": "The latitude."
            },
            "place": {
              "type": "string",
              "description": "The place ID.",
              "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$"
            },
            "scopes": {
              "additionalProperties": false,
              "type": "object",
              "description": "Project and user scopes arrays.",
              "required": ["users", "projects"],
              "properties": {
                "users": {
                  "type": "array",
                  "description": "An array of Application User IDs this resource is scoped to.",
                  "items": { "type": "string" }
                },
                "projects": {
                  "type": "array",
                  "description": "An array of project IDs this resource is scoped to.",
                  "items": {
                    "type": "string",
                    "description": "The ID of this resource.",
                    "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
                    "readOnly": true
                  }
                }
              }
            }
          },
          "x-filterable-fields": ["timestamp"]
        },
        "locationSource": {
          "type": "string",
          "description": "The method used to find the location where the action took place, and requires `location` to also be set. If a GPS was used (with user permission granted), `sensor` is specified. Otherwise an estimate is made based on the apparent location, which may not be the device itself.",
          "enum": ["sensor", "geoIp", "unknown", "place"]
        },
        "context": {
          "additionalProperties": false,
          "type": "object",
          "description": "Object containing contextual data about the action creator.",
          "properties": {
            "ipAddress": {
              "type": "string",
              "description": "The geolocation IP address of the action.",
              "readOnly": true
            },
            "city": {
              "type": "string",
              "description": "The geolocation city of the action, based on the IP address.",
              "readOnly": true
            },
            "region": {
              "type": "string",
              "description": "The wider region of the action.",
              "readOnly": true
            },
            "countryCode": {
              "type": "string",
              "description": "The country of the action.",
              "readOnly": true
            },
            "userAgentName": {
              "type": "string",
              "description": "The user agent name of the action creator's browser or other client.",
              "readOnly": true
            },
            "userAgent": {
              "type": "string",
              "description": "The user agent of the action creator's browser or other client.",
              "readOnly": true
            },
            "operatingSystemName": {
              "type": "string",
              "description": "Name of the action creator's client operating system.",
              "readOnly": true
            },
            "timeZone": {
              "type": "string",
              "description": "The timezone string, such as Europe/Paris",
              "readOnly": true
            }
          }
        },
        "customFields": {
          "type": "object",
          "description": "Object of case-sensititve key-value pairs of custom fields associated with the resource."
        },
        "scopes": {
          "additionalProperties": false,
          "type": "object",
          "description": "Project and user scopes arrays.",
          "required": ["users", "projects"],
          "properties": {
            "users": {
              "type": "array",
              "description": "An array of Application User IDs this resource is scoped to.",
              "items": { "type": "string" }
            },
            "projects": {
              "type": "array",
              "description": "An array of project IDs this resource is scoped to.",
              "items": {
                "type": "string",
                "description": "The ID of this resource.",
                "pattern": "^[abcdefghkmnpqrstwxyABCDEFGHKMNPQRSTUVWXY0123456789]{24}$",
                "readOnly": true
              }
            }
          }
        },
        "tags": {
          "type": "array",
          "description": "Array of string tags associated with this resource.",
          "items": {
            "type": "string",
            "maxLength": 60
          }
        },
        "reactions": {
          "type": "array",
          "description": "An array of Redirector reactions that occured from this action.",
          "items": {
            "additionalProperties": false,
            "type": "object",
            "description": "A single reaction from Redirector.",
            "properties": {
              "type": {
                "type": "string",
                "description": "The reaction type.",
                "enum": ["redirection"],
                "readOnly": true
              },
              "redirectUrl": {
                "type": "string",
                "description": "The redirection URL.",
                "readOnly": true
              },
              "redirectionContext": {
                "type": "object",
                "description": "Object of redirection context values.",
                "readOnly": true
              }
            }
          }
        }
      },
      "x-filterable-fields": ["timestamp", "identifiers.<key>", "tags", "type", "user", "context.city", "context.countryCode", "thng", "product", "collection"]
    },
    "ids": {
      "type": "array",
      "items": { "type": "string" },
      "description": "array of ADIs' ids to create actions for",
      "example": ["ad76as8d7ga", "ad87ad6fg8a7f"]
    },
    "customFields": {
      "type": "object",
      "description": "Object of case-sensititve key-value pairs of custom fields associated with the resource."
    },
    "identifiers": {
      "type": "object",
      "description": "Various identifiers (EPC, ISBN, etc.) as a JSON object with one or more key-value pairs."
    },
    "tags": {
      "type": "array",
      "description": "Array of string tags associated with this resource.",
      "items": { "type": "string" }
    }
  }
}
{
  "metadata": {
    "type": "encodings",
    "tags": ["example"]
  },
  "ids": [
    "serial1",
    "serial2"
  ],
  "customFields": {
    "internalId": "X7JF"
  },
  "tags": ["X7JF"]
}

See also: ActionDocument, ADIOrderEventStatusDocument


Create an ADI Order Event

Creates an event for actions on the ADIs (Thngs) in the specified ADI Order. This request should include the IDs to use when creating the actions.

POST /adis/orders/:orderId/events
Content-Type: application/json
Authorization: $OPERATOR_API_KEY

ADIOrderEventDocument
curl -i -H Content-Type:application/json \
  -H Authorization:$OPERATOR_API_KEY \
  -X POST https://api.evrythng.com/adis/orders/:orderId/events \
  -d '{
  "metadata": {
    "type": "encodings",
    "tags": ["example"]
  },
  "ids": [
    "serial1",
    "serial2"
  ],
  "customFields": {
    "internalId": "X7JF"
  },
  "tags": ["X7JF"]
}'
const orderId = 'UNc6n2Bk6GPhh6waRm2mNppb';
const payload = {
  metadata: {
    type: 'encodings',
    tags: ['example']
  },
  ids: [
    'serial1',
    'serial2'
  ],
  customFields: {
    internalId: 'X7JF'
  },
  tags: ['X7JF']
};

operator.adiOrder(orderId).event()
  .create(payload)
  .then(console.log);
HTTP/1.1 201 Created
Content-Type: application/json

{
  "metadata": {
    "type": "encodings",
    "tags": ["example"]
  },
  "ids": [
    "serial1",
    "serial2"
  ],
  "customFields": {
    "internalId": "X7JF"
  },
  "tags": ["X7JF"]
}

Read all ADI Order events

Retrieves all ADI Order events belonging to the specified ADI Order.

GET /adis/orders/:adiOrderId/events
Authorization: $OPERATOR_API_KEY
curl -i -H Authorization:$OPERATOR_API_KEY \
  -X GET https://api.evrythng.com/adis/orders/:adiOrderId/events \
const orderId = 'UNc6n2Bk6GPhh6waRm2mNppb';

operator.adiOrder(orderId).event()
  .read()
  .then(console.log);
HTTP/1.1 200 OK
Content-Type: application/json

[
  {
    "metadata": null,
    "type": "encodings",
    "tags": [
      "example"
    ],
    "ids": [
      "serial1",
      "serial2"
    ],
    "customFields": {
      "internalId": "X7JF"
    }
  }
]

Read an ADI Order event

Retrieve a single ADI order event by its ID.

GET /adis/orders/:adiOrderId/events/{orderEventId}
Authorization: $API_KEY
curl -i \
  -H Authorization:$OPERATOR_API_KEY \
  -X GET https://api.evrythng.com/adis/orders/:adiOrderId/events/{orderEventId} \
const orderId = 'UNc6n2Bk6GPhh6waRm2mNppb';
const eventId = 'UrF2qWHREAQGMHVD2kKKbtqc';

operator.adiOrder(orderId)
  .event(eventId)
  .read()
  .then(console.log);
HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "UNTrNKg2BMsNt7wRwYymrGhm",
  "status": {
    "state": "pending",
    "requested": 2,
    "events": {
      "created": 0,
      "pending": 1,
      "errorsCount": 0
    }
  },
  "metadata": {
    "type": "encodings",
    "tags": [
      "example"
    ]
  },
  "customFields": {
    "internalId": "X7JF"
  },
  "tags": [
    "X7JF"
  ]
}

Add the withErrors=true query parameter to see errors within the status property.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "id": "UNTrNKg2BMsNt7wRwYymrGhm",
  "status": {
    "state": "pending",
    "requested": 2,
    "events": {
      "created": 0,
      "pending": 1,
      "errorsCount": 1,
      "errors": {
        "ABSDFAFQQRQ": "Failed to create an action"
      }
    }
  },
  "metadata": {
    "type": "encodings",
    "tags": [
      "example"
    ]
  },
  "ids": [
    "serial1",
    "serial2"
  ],
  "customFields": {
    "internalId": "X7JF"
  },
  "tags": [
    "X7JF"
  ]
}