Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• cart: required(object)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies the cart.

    Example:

    N4XTC8

  • carrier: (object)

    The carrier with which the order will be transported to the delivery address

    • id: required(integer)
    • name: required(string)

      Name of the carrier

  • recipient: (object)

    The person receiving the order

    • first_name: required(string)
    • name: required(string)
    • email: required(string)
    • phone: (string)
  • billing_address: (object)

    Billing Address for the order

    • addressee: required(string)
    • town: required(string)
    • number: (string)
    • country_code: required(string)

      ISO Country code of country this address is located in.

    • zip_code: required(string)
    • street: (string)
    • addition: (string)

      An optional additional information, usually displayed right below the address.

  • delivery_address: (object)

    Delivery Address for the order

    • addressee: required(string)
    • town: required(string)
    • number: (string)
    • country_code: required(string)

      ISO Country code of country this address is located in.

    • zip_code: required(string)
    • street: (string)
    • addition: (string)

      An optional additional information, usually displayed right below the address.

  • due_at: (datetime)

    The datetime when this cart is due

  • custom_offer_text: (string)

    A custom text that will be part of the offer document

  • custom_references: (object)

    Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other field of the cart
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Examples:

{
"cart": {
"id": 9981,
"reference": "BWT2HD",
"updated_at": "2017-08-11T12:07:23.865+02:00",
"created_at": "2017-08-11T12:07:23.865+02:00",
"due_at": "2017-11-09T17:00:00.000+01:00",
"custom_offer_text": "Special Offer",
"custom_references": {
  "PO": 7891234,
  "Besteller": "Torsten Schmidt",
  "Druckerei": "Crispy",
  "Kostenstelle": 12345677,
  "Interne Bestell Nr": "BestellNr123"
},
"carrier": {
  "id": 43,
  "name": "Paket DHL"
},
"recipient": {
  "first_name": "Bran",
  "name": "Stark",
  "email": "bran.stark@crispymtn.com",
  "phone": null
},
"billing_address": {
  "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
  "street": "Emmerich-Josef-Str.",
  "number": "1a",
  "addition": "Hinterhaus",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"delivery_address": {
  "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
  "street": "Emmerich-Josef-Str.",
  "number": "1a",
  "addition": "Hinterhaus",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
}
}
}

{
"cart": {
"id": 9981,
"reference": "BWT2HD",
"updated_at": "2017-08-11T12:07:23.865+02:00",
"created_at": "2017-08-11T12:07:23.865+02:00",
"due_at": null,
"custom_references": null,
"custom_offer_text": null,
"carrier": null,
"recipient": null,
"billing_address": null,
"delivery_address": null
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

If the update operation was successful

HTTP status code 422

If the update operation failed due to validation errors

Body

Media type: application/json

Type: object

• errors: required(object)

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

Is returned if the operation to remove all data associated with this cart_id was successful

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

This is returned in case a POST request to this endpoint will succeed.

Body

Media type: application/json

Type: object

• errors: required(array - maxItems: 0)

Example:

{
"errors": []
}

HTTP status code 422

This is returned in case a POST request to this endpoint cannot be successfully performed on the current cart. The response lists all errors, that need to be fixed, before a POST request will succeed.

Body

Media type: application/json

Type: any

Example:

{
"errors": [
{
  "products": "muss ausgefüllt werden"
},
{
  "delivery_address": "muss ausgefüllt werden"
},
{
  "billing_address": "muss ausgefüllt werden"
},
{
  "carrier": "muss ausgefüllt werden"
},
{
  "recipient": "muss ausgefüllt werden"
},
{
  "address": "muss ausgefüllt werden"
}
]
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 301

This redirect is returned if the checkout succeeded.

Headers

• Location: required(string)

  Contains the URL of the successfully checked out order

HTTP status code 422

This is returned in case any validation errors occur during performing the checkout.

Body

Media type: application/json

Type: object

• errors: required(array of )

Example:

{
"errors": [
{
  "products": "muss ausgefüllt werden"
},
{
  "delivery_address": "muss ausgefüllt werden"
},
{
  "billing_address": "muss ausgefüllt werden"
},
{
  "carrier": "muss ausgefüllt werden"
},
{
  "recipient": "muss ausgefüllt werden"
},
{
  "address": "muss ausgefüllt werden"
}
]
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• recipient: required(object)

  Identifies the customer of the cart (or order), which is usually the organization that buys the order.

  • id: required(integer)
  • name: required(string)
  • tax_identifier: (string)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies the cart.

    Example:

    N4XTC8

Example:

{
"customer": {
"id": 206,
"name": "Crispy GmbH & Co. KG",
"tax_identifier": null,
"reference": "NEE6UC"
}
}

HTTP status code 404

This is returned if there's currently no customer information stored with the current cart.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

This is returned if the customer information was successfully created for the current cart.

Body

Media type: application/json

Type: object

• recipient: required(object)

  Identifies the customer of the cart (or order), which is usually the organization that buys the order.

  • id: required(integer)
  • name: required(string)
  • tax_identifier: (string)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies the cart.

    Example:

    N4XTC8

Example:

{
"customer": {
"id": 206,
"name": "Crispy GmbH & Co. KG",
"tax_identifier": null,
"reference": "NEE6UC"
}
}

HTTP status code 422

This is returned if the recipient information cannot be created with the given data.

Body

Media type: application/json

Type: object

• errors: required(object)

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if the current cart's customer was successfully deleted.

HTTP status code 404

This is returned if there's currently no customer information stored with the current cart.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• recipient: required(object)

  Identifies the recipient of the cart (or order), which is usually person that buys the order.

  • first_name: required(string)
  • name: required(string)
  • email: required(string)
  • phone: (string)

Example:

{
"recipient": {
"first_name": "Bran",
"name": "Stark",
"email": "bran.stark@crispymtn.com",
"phone": null
}
}

HTTP status code 404

This is returned if there's currently no recipient information stored with the current cart.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

This is returned if the recipient information was successfully created for the current cart.

Body

Media type: application/json

Type: object

• recipient: required(object)

  Identifies the recipient of the cart (or order), which is usually person that buys the order.

  • first_name: required(string)
  • name: required(string)
  • email: required(string)
  • phone: (string)

Example:

{
"recipient": {
"first_name": "Bran",
"name": "Stark",
"email": "bran.stark@crispymtn.com",
"phone": null
}
}

HTTP status code 422

This is returned if the recipient information cannot be created with the given data.

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"name": [
  "muss ausgefüllt werden"
],
"email": [
  "ist nicht gültig"
],
"phone": [
  "hat ein ungültiges Format (Beispiel: +4961316171000)"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if the current cart's recipient was successfully deleted.

HTTP status code 404

This is returned if there's currently no recipient information stored with the current cart.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• carrier: required(object)

  The carrier which will transport the order to it's delivery address.

  • id: required(integer)
  • name: required(string)

    Name of the carrier

Example:

{
"carrier": {
"id": 43,
"name": "Paket DHL"
}
}

HTTP status code 404

This is returned if there's currently no carrier definition stored with the current cart.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

This is returned if the carrier definition was successfully created for the current cart.

Body

Media type: application/json

Type: object

• carrier: required(object)

  The carrier which will transport the order to it's delivery address.

  • id: required(integer)
  • name: required(string)

    Name of the carrier

Example:

{
"carrier": {
"id": 43,
"name": "Paket DHL"
}
}

HTTP status code 422

This is returned if the carrier definition cannot be created with the given data.

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"carrier": [
  "No carrier found with given id"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if the current cart's carrier definition was successfully deleted.

HTTP status code 404

This is returned if there's currently no carrier definition stored with the current cart.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Product

Example:

[
{
"product": {
  "id": 17628,
  "reference": "BX2WAV",
  "name": "Aufkleber",
  "updated_at": "2017-09-08T14:24:12.677+02:00",
  "created_at": "2017-09-08T14:23:47.195+02:00",
  "circulation_sum": 5100,
  "net_total": {
    "cent_amount": 19562,
    "currency": "EUR"
  },
  "custom_references": {
    "PO": 7891234
  },
  "components": [
    {
      "component": {
        "id": 24178,
        "name": "Aufkleber / Etikett",
        "number_of_pages": 2,
        "closed_dimensions": [
          140,
          140
        ],
        "updated_at": "2017-09-08T14:23:47.204+02:00",
        "created_at": "2017-09-08T14:23:47.204+02:00",
        "paper_name": null,
        "grain": null,
        "grammage": null
      }
    }
  ],
  "variants": [
    {
      "variant": {
        "id": 38426,
        "name": "Deutsch",
        "circulation": 100
      }
    },
    {
      "variant": {
        "id": 38429,
        "name": "Englisch",
        "circulation": 5000
      }
    }
  ]
}
},
{
"product": {
  "id": 17629,
  "reference": "GQFBCS",
  "name": "Best Stickers ever",
  "updated_at": "2017-09-08T17:40:36.125+02:00",
  "created_at": "2017-09-08T17:40:36.125+02:00",
  "circulation_sum": 1000,
  "net_total": {
    "cent_amount": 19562,
    "currency": "EUR"
  },
  "custom_references": null,
  "components": [
    {
      "component": {
        "id": 24179,
        "name": "Aufkleber / Etikett",
        "number_of_pages": 2,
        "closed_dimensions": [
          140,
          140
        ],
        "updated_at": "2017-09-08T17:40:36.135+02:00",
        "created_at": "2017-09-08T17:40:36.135+02:00",
        "paper_name": null,
        "grain": null,
        "grammage": null
      }
    }
  ],
  "variants": [
    {
      "variant": {
        "id": 38433,
        "name": "Standard",
        "circulation": 1000
      }
    }
  ]
}
}
]

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

Body

Media type: application/json

Type: object

• product: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • circulation_sum: required(integer - minimum: 1)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies an object.

    Example:

    N4XTC8

  • custom_references: (object)

    Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
  • components: required(array of inbox.Component)

    Items: Component

    • component: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • number_of_pages: required(integer - minimum: 1)
      • closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
      • front_colors: required(array of string)

        Lists the colors of the front of the component

      • back_colors: required(array of string)

        Lists the colors of the back of the component

      • paper_name: (string - maxLength: 200)
      • grain: (one of short, long)
      • grammage: (integer - minimum: 1)
      • created_at: required(datetime)

        The exact time the respective object was created.

      • updated_at: required(datetime)

        The exact time the respective object was last updated.

      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "component": {
    "id": 21692,
    "name": "Etikett",
    "number_of_pages": 2,
    "closed_dimensions": [
      140,
      140
    ],
    "paper_name": "Arctic White",
    "grain": "short",
    "grammage": 200,
    "front_colors": [
      "CMYK/Cyan",
      "CMYK/Magenta",
      "CMYK/Yellow",
      "CMYK/Black"
    ],
    "back_colors": [],
    "front_colors": ["CMYK/Black", "Pantone/83", "custom/superdark"],
    "updated_at": "2017-08-11T12:27:11.038+02:00",
    "created_at": "2017-08-11T12:24:12.950+02:00"
    }
    }
    

  • variants: required(array of inbox.Variant)

    Items: Variant

    • variant: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • circulation: required(integer - minimum: 1)
      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "variant": {
    "id": 38426,
    "name": "Deutsch",
    "circulation": 100
    }
    }

  • net_total: required(object)

    A Money object represents a single monetary value, that is it always constitutes the amount of money together with it's currency.

    • cent_amount: required(integer)

      Money amount in cents, that is the monetary unit that equals 1/100 of the basic monetary unit of the currency

    • currency: required(string)

      ISO 4217 code for the currency of the money value

  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"product": {
"id": 17628,
"reference": "BX2WAV",
"name": "Aufkleber",
"updated_at": "2017-09-08T14:24:12.677+02:00",
"created_at": "2017-09-08T14:23:47.195+02:00",
"circulation_sum": 5100,
"net_total": {
  "cent_amount": 19562,
  "currency": "EUR"
},
"custom_references": {
  "PO": 7891234
},
"components": [
  {
    "component": {
      "id": 24178,
      "name": "Aufkleber / Etikett",
      "number_of_pages": 2,
      "closed_dimensions": [
        140,
        140
      ],
      "updated_at": "2017-09-08T14:23:47.204+02:00",
      "created_at": "2017-09-08T14:23:47.204+02:00",
      "paper_name": null,
      "grain": null,
      "grammage": null
    }
  }
],
"variants": [
  {
    "variant": {
      "id": 38426,
      "name": "Deutsch",
      "circulation": 100
    }
  },
  {
    "variant": {
      "id": 38429,
      "name": "Englisch",
      "circulation": 5000
    }
  }
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• product: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • circulation_sum: required(integer - minimum: 1)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies an object.

    Example:

    N4XTC8

  • custom_references: (object)

    Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
  • components: required(array of inbox.Component)

    Items: Component

    • component: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • number_of_pages: required(integer - minimum: 1)
      • closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
      • front_colors: required(array of string)

        Lists the colors of the front of the component

      • back_colors: required(array of string)

        Lists the colors of the back of the component

      • paper_name: (string - maxLength: 200)
      • grain: (one of short, long)
      • grammage: (integer - minimum: 1)
      • created_at: required(datetime)

        The exact time the respective object was created.

      • updated_at: required(datetime)

        The exact time the respective object was last updated.

      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "component": {
    "id": 21692,
    "name": "Etikett",
    "number_of_pages": 2,
    "closed_dimensions": [
      140,
      140
    ],
    "paper_name": "Arctic White",
    "grain": "short",
    "grammage": 200,
    "front_colors": [
      "CMYK/Cyan",
      "CMYK/Magenta",
      "CMYK/Yellow",
      "CMYK/Black"
    ],
    "back_colors": [],
    "front_colors": ["CMYK/Black", "Pantone/83", "custom/superdark"],
    "updated_at": "2017-08-11T12:27:11.038+02:00",
    "created_at": "2017-08-11T12:24:12.950+02:00"
    }
    }
    

  • variants: required(array of inbox.Variant)

    Items: Variant

    • variant: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • circulation: required(integer - minimum: 1)
      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "variant": {
    "id": 38426,
    "name": "Deutsch",
    "circulation": 100
    }
    }

  • net_total: required(object)

    A Money object represents a single monetary value, that is it always constitutes the amount of money together with it's currency.

    • cent_amount: required(integer)

      Money amount in cents, that is the monetary unit that equals 1/100 of the basic monetary unit of the currency

    • currency: required(string)

      ISO 4217 code for the currency of the money value

  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"product": {
"id": 17628,
"reference": "BX2WAV",
"name": "Aufkleber",
"updated_at": "2017-09-08T14:24:12.677+02:00",
"created_at": "2017-09-08T14:23:47.195+02:00",
"circulation_sum": 5100,
"net_total": {
  "cent_amount": 19562,
  "currency": "EUR"
},
"custom_references": {
  "PO": 7891234
},
"components": [
  {
    "component": {
      "id": 24178,
      "name": "Aufkleber / Etikett",
      "number_of_pages": 2,
      "closed_dimensions": [
        140,
        140
      ],
      "updated_at": "2017-09-08T14:23:47.204+02:00",
      "created_at": "2017-09-08T14:23:47.204+02:00",
      "paper_name": null,
      "grain": null,
      "grammage": null
    }
  }
],
"variants": [
  {
    "variant": {
      "id": 38426,
      "name": "Deutsch",
      "circulation": 100
    }
  },
  {
    "variant": {
      "id": 38429,
      "name": "Englisch",
      "circulation": 5000
    }
  }
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

If the update operation was successful

HTTP status code 422

If the update operation failed due to validation errors

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"name": [
  "ist zu kurz (weniger als 1 Zeichen)"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

If the delete operation was successful

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Variant

Example:

[
{
"variant": {
  "id": 38426,
  "name": "Deutsch",
  "circulation": 100
}
},
{
"variant": {
  "id": 38429,
  "name": "Englisch",
  "circulation": 5000
}
}
]

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

This is returned if creating the variant succeeded.

Body

Media type: application/json

Type: object

• variant: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • circulation: required(integer - minimum: 1)
  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"variant": {
"id": 38426,
"name": "Deutsch",
"circulation": 100
}
}

HTTP status code 422

This is returned if the variant could not be created due to validation errors.

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"name": [
  "ist bereits vergeben"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• variant: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • circulation: required(integer - minimum: 1)
  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"variant": {
"id": 38426,
"name": "Deutsch",
"circulation": 100
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if the update operation was successful

HTTP status code 422

This is returned if the update operation did not succeed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"name": [
  "ist bereits vergeben"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if deleting the variant succeeded.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: PrintDataFile

Example:

[
{
"print_data_file": {
  "id": 871,
  "product_id": 17626,
  "component_id": null,
  "kind": "original",
  "state": "newly_uploaded",
  "uri": "https://example.com/keyline_print_data_file",
  "filesize": 12345,
  "first_page": 3,
  "last_page": 10,
  "created_at": "2017-09-07T10:35:23.079+02:00",
  "updated_at": "2017-09-07T10:35:23.079+02:00"
}
}
]

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

Body

Media type: application/json

Type: object

• print_data_file: required(object)
  • component_id: (integer)

    The component_id may be null, if the print data file is associated with a product instead of a component

  • product_id: required(integer)
  • uri: required(string)

    The full URI of this print data file, including the protocol

  • filesize: required(integer)

    The size of this print data file in bytes

  • last_page: (integer)

    The last page inside the print data file's PDF

  • first_page: (integer)

    The first page inside the print data file's PDF

  • kind: required(one of original, processed, imposed)
  • state: required(one of newly_uploaded, processing, processed)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"print_data_file": {
"id": 871,
"product_id": 17626,
"component_id": null,
"kind": "original",
"state": "newly_uploaded",
"uri": "https://example.com/keyline_print_data_file",
"filesize": 12345,
"first_page": 3,
"last_page": 10,
"created_at": "2017-09-07T10:35:23.079+02:00",
"updated_at": "2017-09-07T10:35:23.079+02:00"
}
}

HTTP status code 422

This is returned if creating a new print data file failed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"uri": [
  "muss ausgefüllt werden"
],
"kind": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• print_data_file: required(object)
  • component_id: (integer)

    The component_id may be null, if the print data file is associated with a product instead of a component

  • product_id: required(integer)
  • uri: required(string)

    The full URI of this print data file, including the protocol

  • filesize: required(integer)

    The size of this print data file in bytes

  • last_page: (integer)

    The last page inside the print data file's PDF

  • first_page: (integer)

    The first page inside the print data file's PDF

  • kind: required(one of original, processed, imposed)
  • state: required(one of newly_uploaded, processing, processed)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"print_data_file": {
"id": 871,
"product_id": 17626,
"component_id": null,
"kind": "original",
"state": "newly_uploaded",
"uri": "https://example.com/keyline_print_data_file",
"filesize": 12345,
"first_page": 3,
"last_page": 10,
"created_at": "2017-09-07T10:35:23.079+02:00",
"updated_at": "2017-09-07T10:35:23.079+02:00"
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if updating the given print data file information succeeded

HTTP status code 422

This is returned if updating a new print data file failed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"uri": [
  "muss ausgefüllt werden"
],
"kind": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if deleting the print data file information succeeded

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Component

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• component: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • number_of_pages: required(integer - minimum: 1)
  • closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
  • front_colors: required(array of string)

    Lists the colors of the front of the component

  • back_colors: required(array of string)

    Lists the colors of the back of the component

  • paper_name: (string - maxLength: 200)
  • grain: (one of short, long)
  • grammage: (integer - minimum: 1)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"component": {
"id": 21692,
"name": "Etikett",
"number_of_pages": 2,
"closed_dimensions": [
  140,
  140
],
"paper_name": "Arctic White",
"grain": "short",
"grammage": 200,
"front_colors": [
  "CMYK/Cyan",
  "CMYK/Magenta",
  "CMYK/Yellow",
  "CMYK/Black"
],
"back_colors": [],
"front_colors": ["CMYK/Black", "Pantone/83", "custom/superdark"],
"updated_at": "2017-08-11T12:27:11.038+02:00",
"created_at": "2017-08-11T12:24:12.950+02:00"
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

If the update operation was successful

HTTP status code 422

If the update operation failed for validation reasons

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"name": [
  "ist zu kurz (weniger als 1 Zeichen)"
],
"grain": [
  "ist kein gültiger Wert"
],
"grammage": [
  "muss ganzzahlig sein"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: PrintDataFile

Example:

[
{
"print_data_file": {
  "id": 872,
  "product_id": 17626,
  "component_id": 21692,
  "kind": "original",
  "state": "newly_uploaded",
  "uri": "https://example.com/keyline_print_data_file",
  "filesize": 12345,
  "first_page": null,
  "last_page": null,
  "created_at": "2017-09-07T10:35:23.079+02:00",
  "updated_at": "2017-09-07T10:35:23.079+02:00"
}
}
]

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

Body

Media type: application/json

Type: object

• print_data_file: required(object)
  • component_id: (integer)

    The component_id may be null, if the print data file is associated with a product instead of a component

  • product_id: required(integer)
  • uri: required(string)

    The full URI of this print data file, including the protocol

  • filesize: required(integer)

    The size of this print data file in bytes

  • last_page: (integer)

    The last page inside the print data file's PDF

  • first_page: (integer)

    The first page inside the print data file's PDF

  • kind: required(one of original, processed, imposed)
  • state: required(one of newly_uploaded, processing, processed)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"print_data_file": {
"id": 872,
"product_id": 17626,
"component_id": 21692,
"kind": "original",
"state": "newly_uploaded",
"uri": "https://example.com/keyline_print_data_file",
"filesize": 12345,
"first_page": null,
"last_page": null,
"created_at": "2017-09-07T10:35:23.079+02:00",
"updated_at": "2017-09-07T10:35:23.079+02:00"
}
}

HTTP status code 422

This is returned if creating a new print data file failed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"uri": [
  "muss ausgefüllt werden"
],
"kind": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• print_data_file: required(object)
  • component_id: (integer)

    The component_id may be null, if the print data file is associated with a product instead of a component

  • product_id: required(integer)
  • uri: required(string)

    The full URI of this print data file, including the protocol

  • filesize: required(integer)

    The size of this print data file in bytes

  • last_page: (integer)

    The last page inside the print data file's PDF

  • first_page: (integer)

    The first page inside the print data file's PDF

  • kind: required(one of original, processed, imposed)
  • state: required(one of newly_uploaded, processing, processed)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"print_data_file": {
"id": 872,
"product_id": 17626,
"component_id": 21692,
"kind": "original",
"state": "newly_uploaded",
"uri": "https://example.com/keyline_print_data_file",
"filesize": 12345,
"first_page": null,
"last_page": null,
"created_at": "2017-09-07T10:35:23.079+02:00",
"updated_at": "2017-09-07T10:35:23.079+02:00"
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if updating the given print data file information succeeded

HTTP status code 422

This is returned if updating a new print data file failed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"uri": [
  "muss ausgefüllt werden"
],
"kind": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if deleting the print data file information succeeded

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• billing_address: required(object)

  An Address object represents a postal Address

  • addressee: required(string)
  • town: required(string)
  • number: (string)
  • country_code: required(string)

    ISO Country code of country this address is located in.

  • zip_code: required(string)
  • street: (string)
  • addition: (string)

    An optional additional information, usually displayed right below the address.

Example:

{
"billing_address": {
"addition": "Hinterhaus",
"addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
"country_code": "DE",
"number": "1a",
"street": "Emmerich-Josef-Str.",
"town": "Mainz",
"zip_code": "55116"
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

Body

Media type: application/json

Type: object

• billing_address: required(object)

  An Address object represents a postal Address

  • addressee: required(string)
  • town: required(string)
  • number: (string)
  • country_code: required(string)

    ISO Country code of country this address is located in.

  • zip_code: required(string)
  • street: (string)
  • addition: (string)

    An optional additional information, usually displayed right below the address.

Example:

{
"billing_address": {
"addition": "Hinterhaus",
"addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
"country_code": "DE",
"number": "1a",
"street": "Emmerich-Josef-Str.",
"town": "Mainz",
"zip_code": "55116"
}
}

HTTP status code 422

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"addressee": [
  "ist zu kurz (weniger als 1 Zeichen)"
],
"town": [
  "ist zu kurz (weniger als 1 Zeichen)"
],
"country_code": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

Is returned if the billing address was successfully deleted from the cart with the given cart_id

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• delivery_address: required(object)

  An Address object represents a postal Address

  • addressee: required(string)
  • town: required(string)
  • number: (string)
  • country_code: required(string)

    ISO Country code of country this address is located in.

  • zip_code: required(string)
  • street: (string)
  • addition: (string)

    An optional additional information, usually displayed right below the address.

  • delivery_contact_phone: (string)

    Phone number of delivery recipient.

  • delivery_contact_email: (string)

    Email address of delivery recipient.

Example:

{
"delivery_address": {
"addition": "Hinterhaus",
"addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
"country_code": "DE",
"number": "1a",
"street": "Emmerich-Josef-Str.",
"town": "Mainz",
"zip_code": "55116"
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

If the delivery address was successfully set for the cart with the given cart_id

Body

Media type: application/json

Type: object

• delivery_address: required(object)

  An Address object represents a postal Address

  • addressee: required(string)
  • town: required(string)
  • number: (string)
  • country_code: required(string)

    ISO Country code of country this address is located in.

  • zip_code: required(string)
  • street: (string)
  • addition: (string)

    An optional additional information, usually displayed right below the address.

  • delivery_contact_phone: (string)

    Phone number of delivery recipient.

  • delivery_contact_email: (string)

    Email address of delivery recipient.

Example:

{
"delivery_address": {
"addition": "Hinterhaus",
"addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
"country_code": "DE",
"number": "1a",
"street": "Emmerich-Josef-Str.",
"town": "Mainz",
"zip_code": "55116"
}
}

HTTP status code 422

If setting of the delivery address was not successful

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"addressee": [
  "ist zu kurz (weniger als 1 Zeichen)"
],
"town": [
  "ist zu kurz (weniger als 1 Zeichen)"
],
"country_code": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

Is returned if the delivery address was successfully deleted from the cart with the given cart_id

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• order: required(object)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies an object.

    Example:

    N4XTC8

  • state: required(one of draft, confirmed, completed, archived)
  • billing_address: required(object)

    Billing Address for the order

    • addressee: required(string)
    • town: required(string)
    • number: (string)
    • country_code: required(string)

      ISO Country code of country this address is located in.

    • zip_code: required(string)
    • street: (string)
    • addition: (string)

      An optional additional information, usually displayed right below the address.

  • delivery_address: required(object)

    Delivery Address for the order

    • addressee: required(string)
    • town: required(string)
    • number: (string)
    • country_code: required(string)

      ISO Country code of country this address is located in.

    • zip_code: required(string)
    • street: (string)
    • addition: (string)

      An optional additional information, usually displayed right below the address.

  • due_at: (datetime)
  • custom_offer_text: required(string)

    A custom text that will be part of the offer document

  • custom_references: required(object)

    Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the order
  • carrier: required(object)

    The carrier which will transport the order to it's delivery address.

    • id: required(integer)
    • name: required(string)

      Name of the carrier

  • recipient: required(object)

    Identifies the recipient of the cart (or order), which is usually person that buys the order.

    • first_name: required(string)
    • name: required(string)
    • email: required(string)
    • phone: (string)
  • products: required(array of inbox.Product)

    Items: Product

    • product: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • circulation_sum: required(integer - minimum: 1)
      • reference: required(string - pattern: ^[0-9A-Z]{6}$)

        A 6-character, alphanumeric string, that uniquely identifies an object.

        Example:

        N4XTC8

      • custom_references: (object)

        Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
      • components: required(array of inbox.Component)

        Items: Component

        • component: required(object)
          • name: required(string - minLength: 1 - maxLength: 200)
          • number_of_pages: required(integer - minimum: 1)
          • closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
          • front_colors: required(array of string)

            Lists the colors of the front of the component

          • back_colors: required(array of string)

            Lists the colors of the back of the component

          • paper_name: (string - maxLength: 200)
          • grain: (one of short, long)
          • grammage: (integer - minimum: 1)
          • created_at: required(datetime)

            The exact time the respective object was created.

          • updated_at: required(datetime)

            The exact time the respective object was last updated.

          • id: required(integer - minimum: 1)

            Unique identifier for every object. Is used when referencing resources in URLs.

        Example:

        {
        "component": {
        "id": 21692,
        "name": "Etikett",
        "number_of_pages": 2,
        "closed_dimensions": [
          140,
          140
        ],
        "paper_name": "Arctic White",
        "grain": "short",
        "grammage": 200,
        "front_colors": [
          "CMYK/Cyan",
          "CMYK/Magenta",
          "CMYK/Yellow",
          "CMYK/Black"
        ],
        "back_colors": [],
        "front_colors": ["CMYK/Black", "Pantone/83", "custom/superdark"],
        "updated_at": "2017-08-11T12:27:11.038+02:00",
        "created_at": "2017-08-11T12:24:12.950+02:00"
        }
        }
        

      • variants: required(array of inbox.Variant)

        Items: Variant

        • variant: required(object)
          • name: required(string - minLength: 1 - maxLength: 200)
          • circulation: required(integer - minimum: 1)
          • id: required(integer - minimum: 1)

            Unique identifier for every object. Is used when referencing resources in URLs.

        Example:

        {
        "variant": {
        "id": 38426,
        "name": "Deutsch",
        "circulation": 100
        }
        }

      • net_total: required(object)

        A Money object represents a single monetary value, that is it always constitutes the amount of money together with it's currency.

        • cent_amount: required(integer)

          Money amount in cents, that is the monetary unit that equals 1/100 of the basic monetary unit of the currency

        • currency: required(string)

          ISO 4217 code for the currency of the money value

      • created_at: required(datetime)

        The exact time the respective object was created.

      • updated_at: required(datetime)

        The exact time the respective object was last updated.

      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "product": {
    "id": 17628,
    "reference": "BX2WAV",
    "name": "Aufkleber",
    "updated_at": "2017-09-08T14:24:12.677+02:00",
    "created_at": "2017-09-08T14:23:47.195+02:00",
    "circulation_sum": 5100,
    "net_total": {
      "cent_amount": 19562,
      "currency": "EUR"
    },
    "custom_references": {
      "PO": 7891234
    },
    "components": [
      {
        "component": {
          "id": 24178,
          "name": "Aufkleber / Etikett",
          "number_of_pages": 2,
          "closed_dimensions": [
            140,
            140
          ],
          "updated_at": "2017-09-08T14:23:47.204+02:00",
          "created_at": "2017-09-08T14:23:47.204+02:00",
          "paper_name": null,
          "grain": null,
          "grammage": null
        }
      }
    ],
    "variants": [
      {
        "variant": {
          "id": 38426,
          "name": "Deutsch",
          "circulation": 100
        }
      },
      {
        "variant": {
          "id": 38429,
          "name": "Englisch",
          "circulation": 5000
        }
      }
    ]
    }
    }

  • print_data_files: required(array of inbox.PrintDataFile)

    Items: PrintDataFile

    • print_data_file: required(object)
      • component_id: (integer)

        The component_id may be null, if the print data file is associated with a product instead of a component

      • product_id: required(integer)
      • uri: required(string)

        The full URI of this print data file, including the protocol

      • filesize: required(integer)

        The size of this print data file in bytes

      • last_page: (integer)

        The last page inside the print data file's PDF

      • first_page: (integer)

        The first page inside the print data file's PDF

      • kind: required(one of original, processed, imposed)
      • state: required(one of newly_uploaded, processing, processed)
      • created_at: required(datetime)

        The exact time the respective object was created.

      • updated_at: required(datetime)

        The exact time the respective object was last updated.

      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"order": {
"id": 14014,
"due_at": "2017-11-09T17:00:00.000+01:00",
"custom_offer_text": "Special Offer",
"reference": "S28H7Q",
"state": "draft",
"updated_at": "2017-11-03T16:46:10.317+01:00",
"created_at": "2017-11-03T15:24:05.173+01:00",
"custom_references": {
  "PO": 7891234,
  "Besteller": "Torsten Schmidt",
  "Druckerei": "Crispy",
  "Kostenstelle": 12345677,
  "Interne Bestell Nr": "BestellNr123"
},
"carrier": {
  "id": 43,
  "name": "Paket DHL"
},
"delivery_address": {
  "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
  "street": "Emmerich-Josef-Str.",
  "number": "1a",
  "addition": "Hinterhaus",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"recipient": {
  "first_name": "Bran",
  "name": "Starko",
  "email": "bs@stark.com",
  "phone": "+441123123"
},
"billing_address": {
  "addressee": "Keyline\r\nc/o Crispy Mountain GmbH",
  "street": "Emmerich-Josef-Str.",
  "number": "1a",
  "addition": "Hinterhaus",
  "zip_code": "55116",
  "town": "Mainz",
  "country_code": "DE"
},
"products": [
  {
    "product": {
      "id": 21219,
      "reference": "GVESNT",
      "name": "Aufkleber",
      "updated_at": "2017-11-03T16:46:03.899+01:00",
      "created_at": "2017-11-03T16:46:03.899+01:00",
      "circulation_sum": 1000,
      "net_total": {
        "cent_amount": 14128,
        "currency": "EUR"
      },
      "custom_references": {
        "PO": 7891234
      },
      "components": [
        {
          "component": {
            "id": 28722,
            "name": "Aufkleber / Etikett",
            "number_of_pages": 2,
            "closed_dimensions": [
              140,
              140
            ],
            "updated_at": "2017-11-03T16:46:03.914+01:00",
            "created_at": "2017-11-03T16:46:03.914+01:00",
            "paper_name": "Arctic White",
            "grain": "short",
            "grammage": 200
          }
        }
      ],
      "variants": [
        {
          "variant": {
            "id": 44163,
            "name": "Standard",
            "circulation": 1000
          }
        }
      ]
    }
  }
],
"print_data_files": [
  {
    "print_data_file": {
      "id": 880,
      "product_id": 21219,
      "component_id": null,
      "kind": "original",
      "state": "newly_uploaded",
      "uri": "somenewurl",
      "filesize": 123467,
      "first_page": null,
      "last_page": null,
      "created_at": "2017-09-08T14:20:57.183+02:00",
      "updated_at": "2017-09-08T14:20:57.183+02:00"
    }
  }
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

The cancel operation was successful

HTTP status code 422

The order cannot be canceled anymore.

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Product

Example:

[
{
"product": {
  "id": 17628,
  "reference": "BX2WAV",
  "name": "Aufkleber",
  "updated_at": "2017-09-08T14:24:12.677+02:00",
  "created_at": "2017-09-08T14:23:47.195+02:00",
  "circulation_sum": 5100,
  "net_total": {
    "cent_amount": 19562,
    "currency": "EUR"
  },
  "custom_references": {
    "PO": 7891234
  },
  "components": [
    {
      "component": {
        "id": 24178,
        "name": "Aufkleber / Etikett",
        "number_of_pages": 2,
        "closed_dimensions": [
          140,
          140
        ],
        "updated_at": "2017-09-08T14:23:47.204+02:00",
        "created_at": "2017-09-08T14:23:47.204+02:00",
        "paper_name": null,
        "grain": null,
        "grammage": null
      }
    }
  ],
  "variants": [
    {
      "variant": {
        "id": 38426,
        "name": "Deutsch",
        "circulation": 100
      }
    },
    {
      "variant": {
        "id": 38429,
        "name": "Englisch",
        "circulation": 5000
      }
    }
  ]
}
},
{
"product": {
  "id": 17629,
  "reference": "GQFBCS",
  "name": "Best Stickers ever",
  "updated_at": "2017-09-08T17:40:36.125+02:00",
  "created_at": "2017-09-08T17:40:36.125+02:00",
  "circulation_sum": 1000,
  "net_total": {
    "cent_amount": 19562,
    "currency": "EUR"
  },
  "custom_references": null,
  "components": [
    {
      "component": {
        "id": 24179,
        "name": "Aufkleber / Etikett",
        "number_of_pages": 2,
        "closed_dimensions": [
          140,
          140
        ],
        "updated_at": "2017-09-08T17:40:36.135+02:00",
        "created_at": "2017-09-08T17:40:36.135+02:00",
        "paper_name": null,
        "grain": null,
        "grammage": null
      }
    }
  ],
  "variants": [
    {
      "variant": {
        "id": 38433,
        "name": "Standard",
        "circulation": 1000
      }
    }
  ]
}
}
]

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• product: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • circulation_sum: required(integer - minimum: 1)
  • reference: required(string - pattern: ^[0-9A-Z]{6}$)

    A 6-character, alphanumeric string, that uniquely identifies an object.

    Example:

    N4XTC8

  • custom_references: (object)

    Contains up to 5 arbitrary key-value entries, for data that doesn't fit into any other category of the product
  • components: required(array of inbox.Component)

    Items: Component

    • component: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • number_of_pages: required(integer - minimum: 1)
      • closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
      • front_colors: required(array of string)

        Lists the colors of the front of the component

      • back_colors: required(array of string)

        Lists the colors of the back of the component

      • paper_name: (string - maxLength: 200)
      • grain: (one of short, long)
      • grammage: (integer - minimum: 1)
      • created_at: required(datetime)

        The exact time the respective object was created.

      • updated_at: required(datetime)

        The exact time the respective object was last updated.

      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "component": {
    "id": 21692,
    "name": "Etikett",
    "number_of_pages": 2,
    "closed_dimensions": [
      140,
      140
    ],
    "paper_name": "Arctic White",
    "grain": "short",
    "grammage": 200,
    "front_colors": [
      "CMYK/Cyan",
      "CMYK/Magenta",
      "CMYK/Yellow",
      "CMYK/Black"
    ],
    "back_colors": [],
    "front_colors": ["CMYK/Black", "Pantone/83", "custom/superdark"],
    "updated_at": "2017-08-11T12:27:11.038+02:00",
    "created_at": "2017-08-11T12:24:12.950+02:00"
    }
    }
    

  • variants: required(array of inbox.Variant)

    Items: Variant

    • variant: required(object)
      • name: required(string - minLength: 1 - maxLength: 200)
      • circulation: required(integer - minimum: 1)
      • id: required(integer - minimum: 1)

        Unique identifier for every object. Is used when referencing resources in URLs.

    Example:

    {
    "variant": {
    "id": 38426,
    "name": "Deutsch",
    "circulation": 100
    }
    }

  • net_total: required(object)

    A Money object represents a single monetary value, that is it always constitutes the amount of money together with it's currency.

    • cent_amount: required(integer)

      Money amount in cents, that is the monetary unit that equals 1/100 of the basic monetary unit of the currency

    • currency: required(string)

      ISO 4217 code for the currency of the money value

  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"product": {
"id": 17628,
"reference": "BX2WAV",
"name": "Aufkleber",
"updated_at": "2017-09-08T14:24:12.677+02:00",
"created_at": "2017-09-08T14:23:47.195+02:00",
"circulation_sum": 5100,
"net_total": {
  "cent_amount": 19562,
  "currency": "EUR"
},
"custom_references": {
  "PO": 7891234
},
"components": [
  {
    "component": {
      "id": 24178,
      "name": "Aufkleber / Etikett",
      "number_of_pages": 2,
      "closed_dimensions": [
        140,
        140
      ],
      "updated_at": "2017-09-08T14:23:47.204+02:00",
      "created_at": "2017-09-08T14:23:47.204+02:00",
      "paper_name": null,
      "grain": null,
      "grammage": null
    }
  }
],
"variants": [
  {
    "variant": {
      "id": 38426,
      "name": "Deutsch",
      "circulation": 100
    }
  },
  {
    "variant": {
      "id": 38429,
      "name": "Englisch",
      "circulation": 5000
    }
  }
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: PrintDataFile

Example:

[
{
"print_data_file": {
  "id": 871,
  "product_id": 17626,
  "component_id": null,
  "kind": "original",
  "state": "newly_uploaded",
  "uri": "https://example.com/keyline_print_data_file",
  "filesize": 12345,
  "first_page": 3,
  "last_page": 10,
  "created_at": "2017-09-07T10:35:23.079+02:00",
  "updated_at": "2017-09-07T10:35:23.079+02:00"
}
}
]

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 201

Body

Media type: application/json

Type: object

• print_data_file: required(object)
  • component_id: (integer)

    The component_id may be null, if the print data file is associated with a product instead of a component

  • product_id: required(integer)
  • uri: required(string)

    The full URI of this print data file, including the protocol

  • filesize: required(integer)

    The size of this print data file in bytes

  • last_page: (integer)

    The last page inside the print data file's PDF

  • first_page: (integer)

    The first page inside the print data file's PDF

  • kind: required(one of original, processed, imposed)
  • state: required(one of newly_uploaded, processing, processed)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"print_data_file": {
"id": 871,
"product_id": 17626,
"component_id": null,
"kind": "original",
"state": "newly_uploaded",
"uri": "https://example.com/keyline_print_data_file",
"filesize": 12345,
"first_page": 3,
"last_page": 10,
"created_at": "2017-09-07T10:35:23.079+02:00",
"updated_at": "2017-09-07T10:35:23.079+02:00"
}
}

HTTP status code 422

This is returned if creating a new print data file failed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"uri": [
  "muss ausgefüllt werden"
],
"kind": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• print_data_file: required(object)
  • component_id: (integer)

    The component_id may be null, if the print data file is associated with a product instead of a component

  • product_id: required(integer)
  • uri: required(string)

    The full URI of this print data file, including the protocol

  • filesize: required(integer)

    The size of this print data file in bytes

  • last_page: (integer)

    The last page inside the print data file's PDF

  • first_page: (integer)

    The first page inside the print data file's PDF

  • kind: required(one of original, processed, imposed)
  • state: required(one of newly_uploaded, processing, processed)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.

Example:

{
"print_data_file": {
"id": 871,
"product_id": 17626,
"component_id": null,
"kind": "original",
"state": "newly_uploaded",
"uri": "https://example.com/keyline_print_data_file",
"filesize": 12345,
"first_page": 3,
"last_page": 10,
"created_at": "2017-09-07T10:35:23.079+02:00",
"updated_at": "2017-09-07T10:35:23.079+02:00"
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if updating the given print data file information succeeded

HTTP status code 422

This is returned if updating a new print data file failed

Body

Media type: application/json

Type: object

• errors: required(object)

Example:

{
"errors": {
"uri": [
  "muss ausgefüllt werden"
],
"kind": [
  "ist kein gültiger Wert"
]
}
}

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 204

This is returned if deleting the print data file information succeeded

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: array of object

Items: Component

Secured by BearerToken

Headers

• Authorization: required(string - minLength: 71 - maxLength: 71 - pattern: ^Bearer [0-9a-fA-F]{64}$)

  Contains the key for using the API, which prefixed with the string 'Bearer'. # Token administration You can add or revoke access tokens in Keyline in the Settings > API section.

  Example:

  Bearer f338bc59b1ee082ee08600f85022cf7d661426ee342b22c73c18d3875f2e9885

HTTP status code 401

Header missing or No token provided

HTTP status code 403

Bad token.

HTTP status code 200

Body

Media type: application/json

Type: object

• component: required(object)
  • name: required(string - minLength: 1 - maxLength: 200)
  • number_of_pages: required(integer - minimum: 1)
  • closed_dimensions: required(array of integer - minItems: 2 - maxItems: 2)
  • front_colors: required(array of string)

    Lists the colors of the front of the component

  • back_colors: required(array of string)

    Lists the colors of the back of the component

  • paper_name: (string - maxLength: 200)
  • grain: (one of short, long)
  • grammage: (integer - minimum: 1)
  • created_at: required(datetime)

    The exact time the respective object was created.

  • updated_at: required(datetime)

    The exact time the respective object was last updated.

  • id: required(integer - minimum: 1)

    Unique identifier for every object. Is used when referencing resources in URLs.