Shirtigo Cockpit API API Reference

API for the Shirtigo Cockpit application. The API supports API-Key as well as OAuth2 authentication. The API-key / access token has to be presented in the Authentication header such as Authentication: Bearer [key]. Additionally, it is recommended to set the Accept: application/json header. API Clients for several languages are available on github: https://github.com/shirtigo

API Endpoint
https://cockpit.shirtigo.de/api
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0

Authentication

cockpit_oauth

description

This API supports OAuth2 with the authorization-code flow. A detailed tutorial on this topic can be found here. Note that the endpoint is /oauth/, not /api/oauth/ as indicated here in the documentation.

authorizationUrl
/oauth/authorize
tokenUrl
/oauth/token
flow
accessCode

cockpit_apikey

name
Authorization
description

This API supports access via an API key. A key can be obtained from the integrations dashboard. The key must be presented in the 'Authorization' header, e.g. 'Authorization: Bearer [key]'.

in
header

oauth

This section contains endpoints related to the OAuth2 implementation.

oauth

Request access token

POST /oauth/token

This endpoint constitutes the second step of the OAuth2 authorization flow, obtaining an access token from the access code. This is done on the client side and does not require any user interaction.

grant_type

Grant type

type
string authorization_code
in
formData
code

Code received in callback from /oauth/authorize

type
string
in
formData
client_id

Client ID (from registration)

type
string
in
formData
client_secret

Client Secret (from registration)

type
string
in
formData
200 OK

Success, token issued.

400 Bad Request
OAuthServerException

Error.

401 Unauthorized
OAuthServerException

Error, invalid client (client ID or secret are wrong).

Response Example (200 OK) 
{
  "token_type": "Bearer",
  "expires_in": 31536000,
  "refresh_token": "tYI1iHjH7lGBLlBi+VD6uYYCn3pZo8Do/BSmcgzwTOuZ+f7v/z...",
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjVjZj..."
}
Response Example (400 Bad Request) 
{
  "hint": "string",
  "error": "string",
  "message": "string"
}
Response Example (401 Unauthorized) 
{
  "hint": "string",
  "error": "string",
  "message": "string"
}
oauth

Obtain authorization from user

GET /oauth/authorize

As part of the OAuth2 authorization-code flow, users have to be directed to this endpoint, with the query parameters filled in. If applicable, the user will then be prompted to log into their account and confirm that their data may be used by a third party client. For security reasons, the redirect URL has to be registered beforehand, the client ID and client secrets are also issued during registration.

response_type

Response type

type
string code
in
query
redirect_url

Redirect URL. Must match registered redirect URL.

type
string
in
query
client_id

Client ID (from registration)

type
string
in
query
client_secret

Client Secret (from registration)

type
string
in
query
200 OK

Success, body contains prompt for confirmation.

302 Found

Success, authorization has been previously granted, redirect to callback.

401 Unauthorized

Error, invalid client (client ID and/or secret is invalid).

user

Endpoints in this section control data of the currently logged in user profile.

user

Get all payments

GET /payments

Retrieve all payments issued by the currently authenticated user. The result will be paginated, meta information is included in the response.

page

Page number

type
integer 1
in
query
items

Items per page

type
integer 12
in
query
search

Search query

type
integer
in
query
sort_col

Property to order by

type
string
in
query
sort_dir

Order direction

type
string asc, desc asc
in
query
period

Days to show (default: all)

type
integer
in
query
action

Action to filter for (default: none)

type
integer
in
query
200 OK

Success

Response Example (200 OK) 
{
  "meta": {
    "pagination": {
      "count": 10,
      "total_pages": 4,
      "links": {
        "previous": "string",
        "next": "string"
      },
      "current_page": 2,
      "total": 32,
      "per_page": 10
    }
  },
  "data": [
    {
      "id": "d1364568-4b15-4706-89f1-2452efe1261d",
      "vat_rate": 19,
      "order": {
        "delivery": {
          "firstname": "Max",
          "street": "Musterstraße 12",
          "title": "Dr.",
          "country": "DE",
          "city": "Köln",
          "lastname": "Mustermann",
          "company": "Shirtigo GmbH",
          "postcode": "12345"
        },
        "packins": {
          "data": [
            {
              "id": "integer",
              "net_total_price": 75,
              "amount": 1,
              "name": "Greeting card",
              "type": "hangtag"
            }
          ]
        },
        "bill": {
          "firstname": "Max",
          "street": "Musterstraße 12",
          "title": "Dr.",
          "country": "DE",
          "city": "Köln",
          "lastname": "Mustermann",
          "company": "Shirtigo GmbH",
          "postcode": "12345"
        },
        "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
        "vat_rate": 19,
        "reference": "ABCDXY1",
        "created_at": "2017-01-01 12:34:56",
        "total_items": 5,
        "fulfillment": {},
        "products": {
          "data": [
            {
              "id": "integer",
              "size": "XL",
              "net_total_price": 1375,
              "campaign_name": "Example Project",
              "campaign_product_id": "123",
              "amount": 1,
              "color": "Black",
              "name": "Base product XY",
              "images": [
                {
                  "color": "Red",
                  "urls": {
                    "small": "http://www.example.com/my-orders/small.png",
                    "large": "http://www.example.com/my-orders/large.png"
                  },
                  "area": "front"
                }
              ],
              "campaign_reference": "F7S33M2"
            }
          ]
        },
        "sender": {
          "firstname": "Max",
          "street": "Musterstraße 12",
          "title": "Dr.",
          "country": "DE",
          "city": "Köln",
          "lastname": "Mustermann",
          "company": "Shirtigo GmbH",
          "postcode": "12345"
        },
        "status": "Bestellung offen",
        "shipping": {
          "created_at": "2017-01-01 12:34:56",
          "is_shipped": false,
          "updated_at": "2017-01-01 12:34:56",
          "tracking_code": "string",
          "tracking_url": "string"
        }
      }
    }
  ]
}
user

Update user advanced

POST /user/advanced

Update advanced user settings.

default_order_packaging_reference: string

Update user advanced

Update advanced user settings.

receives_mail_order_shipped: boolean

Update user advanced

Update advanced user settings.

default_first_packin_reference: string

Update user advanced

Update advanced user settings.

default_hangtag_reference: string

Update user advanced

Update advanced user settings.

delivery_receipt_note: string

Update user advanced

Update advanced user settings.

customs_email: string

Update user advanced

Update advanced user settings.

default_imprint_reference: string

Update user advanced

Update advanced user settings.

locale: string

Update user advanced

Update advanced user settings.

default_second_packin_reference: string

Update user advanced

Update advanced user settings.

use_tracking_world: boolean

Update user advanced

Update advanced user settings.

receives_mail_order_placed: boolean

Update user advanced

Update advanced user settings.

use_tracking_eu: boolean

Update user advanced

Update advanced user settings.

use_tracking_de: boolean

Update user advanced

Update advanced user settings.

use_custom_product_name: boolean

Update user advanced

Update advanced user settings.

accounting_email: string

Update user advanced

Update advanced user settings.

add_delivery_receipt: boolean

Update user advanced

Update advanced user settings.

default_label_reference: string

Update user advanced

Update advanced user settings.

default_product_packaging_reference: string

Update user advanced

Update advanced user settings.

Request Example
{
  "default_order_packaging_reference": "string",
  "receives_mail_order_shipped": "boolean",
  "default_first_packin_reference": "string",
  "default_hangtag_reference": "string",
  "delivery_receipt_note": "string",
  "customs_email": "string",
  "default_imprint_reference": "string",
  "locale": "string",
  "default_second_packin_reference": "string",
  "use_tracking_world": "boolean",
  "receives_mail_order_placed": "boolean",
  "use_tracking_eu": "boolean",
  "use_tracking_de": "boolean",
  "use_custom_product_name": "boolean",
  "accounting_email": "string",
  "add_delivery_receipt": "boolean",
  "default_label_reference": "string",
  "default_product_packaging_reference": "string"
}
204 No Content

User information updated.

422 Unprocessable Entity

Validation of inputs failed.
cockpit_apikey
cockpit_oauth write-user
user

Delete a Logo assigned to your account or integration

DELETE /user/delivery-receipt-logo/{integration_id}

The endpoint returns an empty array with exit code 200.

integration_id

Unique integration identifier

type
string
in
path
200 OK

Success, delivery receipt logo was deleted
cockpit_apikey
cockpit_oauth write-user
user

Get user information

GET /user

Retrieve information about the currently authenticated user.

200 OK
User

Success

Response Example (200 OK) 
{
  "user_group": {
    "id": 1,
    "updated_at": "2017-01-01 12:34:56",
    "created_at": "2017-01-01 12:34:56",
    "quantity": 1000,
    "cockpit_discount": 20,
    "type": "premium"
  },
  "display_name": "Max Mustermann",
  "delivery_receipt_logo": "https://example.com/custom_logo.png",
  "default_first_packin_reference": "ABC123",
  "updated_at": "2017-01-01 12:34:56",
  "integration_count": 2,
  "sender_title": "string",
  "is_billing_valid": true,
  "default_hangtag_reference": "ABC123",
  "city": "Köln",
  "phone": "004930123456",
  "sender_type": "string",
  "email": "mustermann@example.com",
  "sender_company_name": "string",
  "sticker_logo": "https://example.com/custom_logo.png",
  "default_delivery_receipt_logo_reference": "ABC123",
  "postcode": "12345",
  "default_second_packin_reference": "ABC123",
  "street": "Musterstraße 12",
  "firstname": "Max",
  "add_delivery_receipt": true,
  "sender_city": "string",
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "integrations": [
    {
      "default_first_packin_reference": "ABC123",
      "is_auto_pull_orders": "true",
      "default_sticker_reference": "ABC123",
      "delivery_receipt_logo": "https://example.com/custom_logo.png",
      "reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
      "default_second_packin_reference": "ABC123",
      "sticker_logo": "https://example.com/custom_logo.png",
      "image_type": "png",
      "app": "shopify",
      "image_quality": "high",
      "default_label_reference": "ABC123",
      "default_product_packaging_reference": "ABC123",
      "default_order_packaging_reference": "ABC123",
      "default_hangtag_reference": "ABC123",
      "name": "my-cool-shirtstore.myshopify.com",
      "default_imprint_reference": "ABC123",
      "is_pull_orders": "true",
      "id": 111,
      "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
      "use_custom_product_name": "true",
      "default_delivery_receipt_logo_reference": "ABC123",
      "add_delivery_receipt": true,
      "expires_in": "2018-01-01 12:34:56"
    }
  ],
  "sender_country": "string",
  "country": "Deutschland",
  "company_name": "Shirtigo GmbH",
  "has_orders": true,
  "title": "Dr.",
  "is_business": "true",
  "use_custom_product_name": "true",
  "sender_postcode": "string",
  "sender_firstname": "string",
  "lastname": "Mustermann",
  "sender_lastname": "string",
  "sender_state": "string",
  "sender_street": "string"
}
cockpit_apikey
cockpit_oauth read-user
user

Update user information

POST /user

Update (some) fields of the currently authenticated user profile.

firstname: string

Update user information

Update (some) fields of the currently authenticated user profile.

street: string

Update user information

Update (some) fields of the currently authenticated user profile.

phone: string

Update user information

Update (some) fields of the currently authenticated user profile.

is_business: boolean

Update user information

Update (some) fields of the currently authenticated user profile.

lastname: string

Update user information

Update (some) fields of the currently authenticated user profile.

city: string

Update user information

Update (some) fields of the currently authenticated user profile.

postcode: string

Update user information

Update (some) fields of the currently authenticated user profile.

company_name: string

Update user information

Update (some) fields of the currently authenticated user profile.

country: string

Update user information

Update (some) fields of the currently authenticated user profile.

Request Example
{
  "firstname": "string",
  "street": "string",
  "phone": "string",
  "is_business": "boolean",
  "lastname": "string",
  "city": "string",
  "postcode": "string",
  "company_name": "string",
  "country": "string"
}
204 No Content

User information updated.

422 Unprocessable Entity

Validation of inputs failed.
cockpit_apikey
cockpit_oauth write-user
user

Get balance for current user

POST user/balance

Return a Money object for the users current balance

200 OK
Money

Success

Response Example (200 OK)
cockpit_oauth
user

Update sender address

POST /user/sender-address

Update sender address fields of currently authenticated user.

sender_firstname: string (up to 20 chars)

Update sender address

Update sender address fields of currently authenticated user.

sender_company_name: string (up to 30 chars)

Update sender address

Update sender address fields of currently authenticated user.

sender_postcode: string (3 to 9 chars)

Update sender address

Update sender address fields of currently authenticated user.

sender_city: string (up to 30 chars)

Update sender address

Update sender address fields of currently authenticated user.

sender_country: string

Update sender address

Update sender address fields of currently authenticated user.

sender_lastname: string (up to 20 chars)

Update sender address

Update sender address fields of currently authenticated user.

sender_street: string (up to 35 chars)

Update sender address

Update sender address fields of currently authenticated user.

Request Example
{
  "sender_firstname": "string",
  "sender_company_name": "string",
  "sender_postcode": "string",
  "sender_city": "string",
  "sender_country": "string",
  "sender_lastname": "string",
  "sender_street": "string"
}
204 No Content

User information updated.

422 Unprocessable Entity

Validation of inputs failed.
cockpit_apikey
cockpit_oauth write-user
user

Upload a logo to be used on the delivery receipt for your customers

POST /user/delivery-receipt-logo

Upload a logo to your user account which is printed on the delivery receipt for your customers to increase the branding of your fulfillment

The file needs to be a png with 900px x 385px (width x height).

The endpoint returns an empty array with exit code 200.

file

Design file

type
file
in
formData
200 OK

Success, delivery receipt logo was uploaded

422 Unprocessable Entity

Error, image file does not meet requirements
cockpit_apikey
cockpit_oauth write-user
user

Delete a sticker assigned to your account or integration

DELETE /user/sticker/{integration_id}

The endpoint returns an empty array with exit code 200.

integration_id

Unique integration identifier

type
string
in
path
200 OK

Success, sticker was deleted
cockpit_apikey
cockpit_oauth write-user
user

Upload a sticker to be used on the delivery receipt for your customers

POST /user/sticker

Upload a sticker to your user account which is printed on packaging for your customers to increase the branding of your fulfillment

The file needs to be a png with 560px x 560px (width x height).

The endpoint returns an empty array with exit code 200.

file

Design file

type
file
in
formData
200 OK

Success, sticker was uploaded

422 Unprocessable Entity

Error, image file does not meet requirements
cockpit_apikey
cockpit_oauth write-user

design

Endpoints in this section manipulate (create, view, modify) designs by the currently logged in user.

design

Get all designs

GET /designs

Retrieve a paginated list of available designs of the currently authenticated user.

200 OK

Success

Response Example (200 OK) 
{
  "data": [
    {
      "height": 3000,
      "is_dark": true,
      "complementary_color": "",
      "preview": "https://example.com/product_prev.png",
      "name": "My cool design",
      "is_processed": true,
      "updated_at": "2017-01-01 12:34:56",
      "colors": 5,
      "palette": [
        "A20061",
        "FFBC42",
        "1C838A",
        "021618",
        "A3AAAB"
      ],
      "original_file": "https://example.com/product.png",
      "filename": "ABCDE",
      "created_at": "2017-01-01 12:34:56",
      "filetype": "png",
      "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
      "width": 5000
    }
  ]
}
cockpit_apikey
cockpit_oauth read-design
design

Create design from file

POST /designs/file

Create a new design from the submitted file.

The file must be at least 1000px in width or height and must be formatted either as PNG- or JPEG raster image.

The endpoint returns the created design.

file

Design file

type
file
in
formData
200 OK
Design

Success, all file has been processed

422 Unprocessable Entity

Error, image file does not meet requirements

Response Example (200 OK) 
{
  "height": 3000,
  "is_dark": true,
  "complementary_color": "",
  "preview": "https://example.com/product_prev.png",
  "name": "My cool design",
  "is_processed": true,
  "updated_at": "2017-01-01 12:34:56",
  "colors": 5,
  "palette": [
    "A20061",
    "FFBC42",
    "1C838A",
    "021618",
    "A3AAAB"
  ],
  "original_file": "https://example.com/product.png",
  "filename": "ABCDE",
  "created_at": "2017-01-01 12:34:56",
  "filetype": "png",
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 5000
}
cockpit_apikey
cockpit_oauth write-design
design

Create design from base64-encoded data

POST /designs/base64

Create a new design from the base64-encoded data

The endpoint returns the created design.

original_filename: string

Original file name (optional)

data: string

Base64-encoded data

Request Example
{
  "original_filename": "string",
  "data": "string"
}
200 OK
Design

Success, URL has been processed

422 Unprocessable Entity

Error, URL / image file does not meet requirements

Response Example (200 OK) 
{
  "height": 3000,
  "is_dark": true,
  "complementary_color": "",
  "preview": "https://example.com/product_prev.png",
  "name": "My cool design",
  "is_processed": true,
  "updated_at": "2017-01-01 12:34:56",
  "colors": 5,
  "palette": [
    "A20061",
    "FFBC42",
    "1C838A",
    "021618",
    "A3AAAB"
  ],
  "original_file": "https://example.com/product.png",
  "filename": "ABCDE",
  "created_at": "2017-01-01 12:34:56",
  "filetype": "png",
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 5000
}
cockpit_apikey
cockpit_oauth write-design
design

Delete design

DELETE /designs/{design-reference}

Only designs by the currently authenticated user may be deleted.

design-reference

Unique design identifier

type
string
in
path
204 No Content

Success, design deleted

404 Not Found

Design not found
cockpit_apikey
cockpit_oauth write-design
design

Get design

GET /designs/{design-reference}

Retrieve information about a single design. Only searches designs that are available to the currently authenticated user.

design-reference

Unique design identifier

type
string
in
path
200 OK
Design

Success

404 Not Found

Design not found

Response Example (200 OK) 
{
  "height": 3000,
  "is_dark": true,
  "complementary_color": "",
  "preview": "https://example.com/product_prev.png",
  "name": "My cool design",
  "is_processed": true,
  "updated_at": "2017-01-01 12:34:56",
  "colors": 5,
  "palette": [
    "A20061",
    "FFBC42",
    "1C838A",
    "021618",
    "A3AAAB"
  ],
  "original_file": "https://example.com/product.png",
  "filename": "ABCDE",
  "created_at": "2017-01-01 12:34:56",
  "filetype": "png",
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 5000
}
cockpit_apikey
cockpit_oauth read-design
design

Update design

PUT /designs/{design-reference}

Update a single design based on the parameters given in the form body.

name: string

Update design

Update a single design based on the parameters given in the form body.

design-reference

Unique design identifier

type
string
in
path
Request Example
{
  "name": "string"
}
200 OK
Design

Success

404 Not Found

Design not found

Response Example (200 OK) 
{
  "height": 3000,
  "is_dark": true,
  "complementary_color": "",
  "preview": "https://example.com/product_prev.png",
  "name": "My cool design",
  "is_processed": true,
  "updated_at": "2017-01-01 12:34:56",
  "colors": 5,
  "palette": [
    "A20061",
    "FFBC42",
    "1C838A",
    "021618",
    "A3AAAB"
  ],
  "original_file": "https://example.com/product.png",
  "filename": "ABCDE",
  "created_at": "2017-01-01 12:34:56",
  "filetype": "png",
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 5000
}
cockpit_apikey
cockpit_oauth write-design
design

Create design from URL

POST /designs/url

Create a new design from the submitted URL.

The endpoint returns the created design.

url: string

Design file URL

Request Example
{
  "url": "string"
}
200 OK
Design

Success, URL has been processed

422 Unprocessable Entity

Error, URL / image file does not meet requirements

Response Example (200 OK) 
{
  "height": 3000,
  "is_dark": true,
  "complementary_color": "",
  "preview": "https://example.com/product_prev.png",
  "name": "My cool design",
  "is_processed": true,
  "updated_at": "2017-01-01 12:34:56",
  "colors": 5,
  "palette": [
    "A20061",
    "FFBC42",
    "1C838A",
    "021618",
    "A3AAAB"
  ],
  "original_file": "https://example.com/product.png",
  "filename": "ABCDE",
  "created_at": "2017-01-01 12:34:56",
  "filetype": "png",
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 5000
}
cockpit_apikey
cockpit_oauth write-design

product

Endpoints in this section retrieve products available to the currently logged in user.

product

Delete product

DELETE /products/{product-id}
product-id

Numerical product identifier

type
integer
in
path
204 No Content

Success, product deleted

404 Not Found

Product not found
cockpit_apikey
cockpit_oauth write-project
product

Get product

GET /products/{product-id}

Retrieve information on a single product.

product-id

Numerical product identifier

type
integer
in
path
200 OK
CampaignProduct

Success

404 Not Found

Product not found

Response Example (200 OK) 
{
  "is_available": true,
  "custom_name": "My cool product",
  "has_express": false,
  "base_product": {
    "original_name": "T-Shirt",
    "processing_areas": {
      "data": [
        {
          "position_id": 1,
          "position_name": "front",
          "template_height": 1000,
          "height": 2000,
          "printable_area_margin_from_top": 0,
          "width": 2000,
          "width_in_mm": 100,
          "template": "string",
          "height_in_mm": 100,
          "template_width": 1000
        }
      ]
    },
    "shipping_category": 1,
    "category_id": 5,
    "is_active": "boolean",
    "short_description": "string",
    "colors": {
      "data": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ]
    },
    "id": 1,
    "name": "Base product XY",
    "sales_price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    },
    "manufacturer": {
      "id": 123,
      "name": "Musterfirma"
    },
    "sizechart_image": "string",
    "category": "Unisex-Shirts",
    "images": {
      "data": [
        {
          "url": "https://www.example.com/image.jpg",
          "sort_position": 1
        }
      ]
    },
    "description": "string",
    "price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    }
  },
  "project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "name": "Base Product Name XY",
  "active_integration_syncs": [
    {
      "integration_id": 111,
      "integration_name": "shopify",
      "updated_at": "2017-01-01 12:34:56",
      "is_successful": true,
      "error": "Invalid or missing auth.",
      "in_queue": true,
      "integration_product_id": "9286211826",
      "is_syncing": true
    }
  ],
  "is_rendered": true,
  "sort_position": "1",
  "colors": [
    {
      "id": 123,
      "color": "Black",
      "is_colored": true,
      "color_hex": "#000000",
      "sizes": [
        {
          "id": 67,
          "size": "XL",
          "is_available": true,
          "sort_position": 1,
          "is_onlocalstock": true
        }
      ]
    }
  ],
  "id": 123,
  "integration_sync_log": [
    null
  ]
}
cockpit_apikey
cockpit_oauth read-project
product

Update product

PUT /products/{product-id}

Update names, descriptions, prices and add/delete a product of the authenticated user.

custom_name: string

Product name

colors: integer[]

List of color ids

description: string

Short description

price: integer

Gross product price in Euro-cents

sort_position: integer

Set a sort position for this product within its project

delete_unmentioned_colors: bool

Set to true if colors which are stored but do not appear in the request should be deleted. Default: false

product-id

Numerical product identifier

type
integer
in
path
Request Example
{
  "custom_name": "My cool product",
  "colors": [
    "integer"
  ],
  "description": "string",
  "price": 400,
  "sort_position": "1",
  "delete_unmentioned_colors": "bool"
}
200 OK
CampaignProduct

Success

404 Not Found

Product not found

Response Example (200 OK) 
{
  "is_available": true,
  "custom_name": "My cool product",
  "has_express": false,
  "base_product": {
    "original_name": "T-Shirt",
    "processing_areas": {
      "data": [
        {
          "position_id": 1,
          "position_name": "front",
          "template_height": 1000,
          "height": 2000,
          "printable_area_margin_from_top": 0,
          "width": 2000,
          "width_in_mm": 100,
          "template": "string",
          "height_in_mm": 100,
          "template_width": 1000
        }
      ]
    },
    "shipping_category": 1,
    "category_id": 5,
    "is_active": "boolean",
    "short_description": "string",
    "colors": {
      "data": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ]
    },
    "id": 1,
    "name": "Base product XY",
    "sales_price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    },
    "manufacturer": {
      "id": 123,
      "name": "Musterfirma"
    },
    "sizechart_image": "string",
    "category": "Unisex-Shirts",
    "images": {
      "data": [
        {
          "url": "https://www.example.com/image.jpg",
          "sort_position": 1
        }
      ]
    },
    "description": "string",
    "price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    }
  },
  "project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "name": "Base Product Name XY",
  "active_integration_syncs": [
    {
      "integration_id": 111,
      "integration_name": "shopify",
      "updated_at": "2017-01-01 12:34:56",
      "is_successful": true,
      "error": "Invalid or missing auth.",
      "in_queue": true,
      "integration_product_id": "9286211826",
      "is_syncing": true
    }
  ],
  "is_rendered": true,
  "sort_position": "1",
  "colors": [
    {
      "id": 123,
      "color": "Black",
      "is_colored": true,
      "color_hex": "#000000",
      "sizes": [
        {
          "id": 67,
          "size": "XL",
          "is_available": true,
          "sort_position": 1,
          "is_onlocalstock": true
        }
      ]
    }
  ],
  "id": 123,
  "integration_sync_log": [
    null
  ]
}
cockpit_apikey
cockpit_oauth write-project
product

Get all products

GET /products
finished

Only return products where rendering is finished.

type
integer
in
query
200 OK

Success

Response Example (200 OK) 
{
  "data": [
    {
      "is_available": true,
      "custom_name": "My cool product",
      "has_express": false,
      "base_product": {
        "original_name": "T-Shirt",
        "processing_areas": {
          "data": [
            {
              "position_id": 1,
              "position_name": "front",
              "template_height": 1000,
              "height": 2000,
              "printable_area_margin_from_top": 0,
              "width": 2000,
              "width_in_mm": 100,
              "template": "string",
              "height_in_mm": 100,
              "template_width": 1000
            }
          ]
        },
        "shipping_category": 1,
        "category_id": 5,
        "is_active": "boolean",
        "short_description": "string",
        "colors": {
          "data": [
            {
              "id": 123,
              "color": "Black",
              "is_colored": true,
              "color_hex": "#000000",
              "sizes": [
                {
                  "id": 67,
                  "size": "XL",
                  "is_available": true,
                  "sort_position": 1,
                  "is_onlocalstock": true
                }
              ]
            }
          ]
        },
        "id": 1,
        "name": "Base product XY",
        "sales_price": {
          "data": [
            {
              "type": "generic"
            }
          ]
        },
        "manufacturer": {
          "id": 123,
          "name": "Musterfirma"
        },
        "sizechart_image": "string",
        "category": "Unisex-Shirts",
        "images": {
          "data": [
            {
              "url": "https://www.example.com/image.jpg",
              "sort_position": 1
            }
          ]
        },
        "description": "string",
        "price": {
          "data": [
            {
              "type": "generic"
            }
          ]
        }
      },
      "project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
      "name": "Base Product Name XY",
      "active_integration_syncs": [
        {
          "integration_id": 111,
          "integration_name": "shopify",
          "updated_at": "2017-01-01 12:34:56",
          "is_successful": true,
          "error": "Invalid or missing auth.",
          "in_queue": true,
          "integration_product_id": "9286211826",
          "is_syncing": true
        }
      ],
      "is_rendered": true,
      "sort_position": "1",
      "colors": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ],
      "id": 123
    }
  ]
}
cockpit_apikey
cockpit_oauth read-project
product

Create a CampaignProduct

POST /products

Add a product to a project from the catalog of available base products.

project_id: string

Identifier of existing product

base_product_id: integer

Identifier of desired base product

custom_name: string

Set a custom name for this product, will be filled with a generated placeholder of the form '{project_name} - {product_name}' if not set

price: integer

Price in Euro-cents

sort_position: integer

Set a sort position for this product within its project

colors: integer[]

List of colors ids

Request Example
{
  "project_id": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "base_product_id": 25,
  "custom_name": "My fancy product name",
  "price": "1999",
  "sort_position": "1",
  "colors": [
    "212,239"
  ]
}
200 OK

Success

404 Not Found

Project or base product not found

422 Unprocessable Entity

Requirements not fulfilled

Response Example (200 OK) 
{
  "data": [
    {
      "is_available": true,
      "custom_name": "My cool product",
      "has_express": false,
      "base_product": {
        "original_name": "T-Shirt",
        "processing_areas": {
          "data": [
            {
              "position_id": 1,
              "position_name": "front",
              "template_height": 1000,
              "height": 2000,
              "printable_area_margin_from_top": 0,
              "width": 2000,
              "width_in_mm": 100,
              "template": "string",
              "height_in_mm": 100,
              "template_width": 1000
            }
          ]
        },
        "shipping_category": 1,
        "category_id": 5,
        "is_active": "boolean",
        "short_description": "string",
        "colors": {
          "data": [
            {
              "id": 123,
              "color": "Black",
              "is_colored": true,
              "color_hex": "#000000",
              "sizes": [
                {
                  "id": 67,
                  "size": "XL",
                  "is_available": true,
                  "sort_position": 1,
                  "is_onlocalstock": true
                }
              ]
            }
          ]
        },
        "id": 1,
        "name": "Base product XY",
        "sales_price": {
          "data": [
            {
              "type": "generic"
            }
          ]
        },
        "manufacturer": {
          "id": 123,
          "name": "Musterfirma"
        },
        "sizechart_image": "string",
        "category": "Unisex-Shirts",
        "images": {
          "data": [
            {
              "url": "https://www.example.com/image.jpg",
              "sort_position": 1
            }
          ]
        },
        "description": "string",
        "price": {
          "data": [
            {
              "type": "generic"
            }
          ]
        }
      },
      "project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
      "name": "Base Product Name XY",
      "active_integration_syncs": [
        {
          "integration_id": 111,
          "integration_name": "shopify",
          "updated_at": "2017-01-01 12:34:56",
          "is_successful": true,
          "error": "Invalid or missing auth.",
          "in_queue": true,
          "integration_product_id": "9286211826",
          "is_syncing": true
        }
      ],
      "is_rendered": true,
      "sort_position": "1",
      "colors": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ],
      "id": 123
    }
  ]
}
cockpit_apikey
cockpit_oauth write-project
product

Create provisional product

POST /products/provisional/{base_product_id}

Retrieve information for a draft product

base_product_id

Identifier of desired base product

type
integer
in
path
200 OK
ProvisionalProduct

Success

Response Example (200 OK) 
{
  "name": "Base product XY",
  "description": "string",
  "base_product": {
    "original_name": "T-Shirt",
    "processing_areas": {
      "data": [
        {
          "position_id": 1,
          "position_name": "front",
          "template_height": 1000,
          "height": 2000,
          "printable_area_margin_from_top": 0,
          "width": 2000,
          "width_in_mm": 100,
          "template": "string",
          "height_in_mm": 100,
          "template_width": 1000
        }
      ]
    },
    "shipping_category": 1,
    "category_id": 5,
    "is_active": "boolean",
    "short_description": "string",
    "colors": {
      "data": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ]
    },
    "id": 1,
    "name": "Base product XY",
    "sales_price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    },
    "manufacturer": {
      "id": 123,
      "name": "Musterfirma"
    },
    "sizechart_image": "string",
    "category": "Unisex-Shirts",
    "images": {
      "data": [
        {
          "url": "https://www.example.com/image.jpg",
          "sort_position": 1
        }
      ]
    },
    "description": "string",
    "price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    }
  },
  "colors": [
    {
      "id": 123,
      "color": "Black",
      "is_colored": true,
      "color_hex": "#000000",
      "sizes": [
        {
          "id": 67,
          "size": "XL",
          "is_available": true,
          "sort_position": 1,
          "is_onlocalstock": true
        }
      ]
    }
  ]
}
cockpit_apikey
cockpit_oauth read-project
product

Synchronize integrations

POST /products/{product-id}/sync

Trigger synchronization for all requested integrations for this product. The synchronization is performed in the background. Its status can be observed by querying the active_integration_syncs field in the product response.

integrations: object[]

Integration ids

product-id

Numerical product identifier

type
integer
in
path
Request Example
{
  "integrations": [
    null
  ]
}
204 No Content

Success, all integrations processed
cockpit_apikey
cockpit_oauth write-project

base-product

Endpoints in this section retrieve base products available during product creation.

base-product

Get all base products

GET /base-products

Retrieve a list of available base products. Optionally, a category can be passed for filtering.

category

Filter by category identifier (default: any)

type
integer
in
query
200 OK

Success

Response Example (200 OK) 
{
  "data": [
    {
      "original_name": "T-Shirt",
      "processing_areas": {
        "data": [
          {
            "position_id": 1,
            "position_name": "front",
            "template_height": 1000,
            "height": 2000,
            "printable_area_margin_from_top": 0,
            "width": 2000,
            "width_in_mm": 100,
            "template": "string",
            "height_in_mm": 100,
            "template_width": 1000
          }
        ]
      },
      "shipping_category": 1,
      "category_id": 5,
      "is_active": "boolean",
      "short_description": "string",
      "colors": {
        "data": [
          {
            "id": 123,
            "color": "Black",
            "is_colored": true,
            "color_hex": "#000000",
            "sizes": [
              {
                "id": 67,
                "size": "XL",
                "is_available": true,
                "sort_position": 1,
                "is_onlocalstock": true
              }
            ]
          }
        ]
      },
      "id": 1,
      "name": "Base product XY",
      "sales_price": {
        "data": [
          {
            "type": "generic"
          }
        ]
      },
      "manufacturer": {
        "id": 123,
        "name": "Musterfirma"
      },
      "sizechart_image": "string",
      "category": "Unisex-Shirts",
      "images": {
        "data": [
          {
            "url": "https://www.example.com/image.jpg",
            "sort_position": 1
          }
        ]
      },
      "description": "string",
      "price": {
        "data": [
          {
            "type": "generic"
          }
        ]
      }
    }
  ]
}
cockpit_oauth
base-product

Get base product

GET /base-products/{base-product-id}

Retrieve information on a single base product.

base-product-id

Numerical base product identifier

type
integer
in
path
200 OK
Product

Success

404 Not Found

Product not found

Response Example (200 OK) 
{
  "original_name": "T-Shirt",
  "processing_areas": {
    "data": [
      {
        "position_id": 1,
        "position_name": "front",
        "template_height": 1000,
        "height": 2000,
        "printable_area_margin_from_top": 0,
        "width": 2000,
        "width_in_mm": 100,
        "template": "string",
        "height_in_mm": 100,
        "template_width": 1000
      }
    ]
  },
  "shipping_category": 1,
  "category_id": 5,
  "is_active": "boolean",
  "short_description": "string",
  "colors": {
    "data": [
      {
        "id": 123,
        "color": "Black",
        "is_colored": true,
        "color_hex": "#000000",
        "sizes": [
          {
            "id": 67,
            "size": "XL",
            "is_available": true,
            "sort_position": 1,
            "is_onlocalstock": true
          }
        ]
      }
    ]
  },
  "id": 1,
  "name": "Base product XY",
  "sales_price": {
    "data": [
      {
        "type": "generic"
      }
    ]
  },
  "manufacturer": {
    "id": 123,
    "name": "Musterfirma"
  },
  "sizechart_image": "string",
  "category": "Unisex-Shirts",
  "images": {
    "data": [
      {
        "url": "https://www.example.com/image.jpg",
        "sort_position": 1
      }
    ]
  },
  "description": "string",
  "price": {
    "data": [
      {
        "type": "generic"
      }
    ]
  }
}
cockpit_oauth
base-product

List available categories

GET /base-categories
200 OK

Success

Response Example (200 OK) 
{
  "data": [
    {
      "id": 10,
      "name": "Unisex-Shirts",
      "sort_position": 1
    }
  ]
}
cockpit_oauth

project

Endpoints in this section manipulate (create, view, modify) projects of the currently logged in user.

project

Delete project

DELETE /projects/{project-reference}

Delete the selected project.

project-reference

Unique project identifier

type
string
in
path
204 No Content

Success, project deleted

404 Not Found

Project not found

502 Bad Gateway

Project could not be dleted due to problems to delete product integrations
cockpit_oauth
project

Get project

GET /projects/{project-reference}

Retrieve information about a single project. Only searches projects that are available to the currently authenticated user.

project-reference

Unique project identifier

type
string
in
path
200 OK
Project

Success

404 Not Found

Project not found

Response Example (200 OK) 
{
  "processings": {
    "data": [
      {
        "method": "print",
        "height": 300,
        "offset_center": 0,
        "area": "front",
        "offset_top": 50,
        "position": "center",
        "design": {
          "height": 3000,
          "is_dark": true,
          "complementary_color": "",
          "preview": "https://example.com/product_prev.png",
          "name": "My cool design",
          "is_processed": true,
          "updated_at": "2017-01-01 12:34:56",
          "colors": 5,
          "palette": [
            "A20061",
            "FFBC42",
            "1C838A",
            "021618",
            "A3AAAB"
          ],
          "original_file": "https://example.com/product.png",
          "filename": "ABCDE",
          "created_at": "2017-01-01 12:34:56",
          "filetype": "png",
          "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
          "width": 5000
        },
        "width": 200,
        "updated_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "updated_at": "2017-01-01 12:34:56",
  "is_syncing": {
    "12": true
  },
  "status": "Finalisiert",
  "created_at": "2017-01-01 12:34:56",
  "is_published": true,
  "name": "My cool project",
  "is_queueing": {
    "12": true
  },
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "type": "ondemand",
  "products_count": 3
}
cockpit_apikey
cockpit_oauth read-project
project

Update project

PUT /projects/{project-reference}

Change information about a project

name: string

Project name

project-reference

Unique project identifier

type
string
in
path
Request Example
{
  "name": "My cool project"
}
200 OK
Project

Success

404 Not Found

Project not found

Response Example (200 OK) 
{
  "processings": {
    "data": [
      {
        "method": "print",
        "height": 300,
        "offset_center": 0,
        "area": "front",
        "offset_top": 50,
        "position": "center",
        "design": {
          "height": 3000,
          "is_dark": true,
          "complementary_color": "",
          "preview": "https://example.com/product_prev.png",
          "name": "My cool design",
          "is_processed": true,
          "updated_at": "2017-01-01 12:34:56",
          "colors": 5,
          "palette": [
            "A20061",
            "FFBC42",
            "1C838A",
            "021618",
            "A3AAAB"
          ],
          "original_file": "https://example.com/product.png",
          "filename": "ABCDE",
          "created_at": "2017-01-01 12:34:56",
          "filetype": "png",
          "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
          "width": 5000
        },
        "width": 200,
        "updated_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "updated_at": "2017-01-01 12:34:56",
  "is_syncing": {
    "12": true
  },
  "status": "Finalisiert",
  "created_at": "2017-01-01 12:34:56",
  "is_published": true,
  "name": "My cool project",
  "is_queueing": {
    "12": true
  },
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "type": "ondemand",
  "products_count": 3
}
cockpit_apikey
cockpit_oauth read-project
project

Synchronize integrations

POST /projects/{project-reference}/sync

Trigger synchronization with all integrations defined for this campaign. The synchronization is performed in the background. Its status can be observed by querying for the attribute "status". It has the following enum-values:

  • 'is_queuing',
  • 'is_syncing',
  • 'is_completed'
  • 'has_errors'
integrations: object[]

Integration ids

project-reference

Unique project identifier

type
string
in
path
Request Example
{
  "integrations": [
    null
  ]
}
204 No Content

Success, all integrations processed
cockpit_apikey
cockpit_oauth write-project
project

Get products for a project

GET /projects/{project-reference}/products

Retrieve information about the products for a single project. Only searches projects that are available to the currently authenticated user.

project-reference

Unique project identifier

type
string
in
path
200 OK
CampaignProduct

Success

404 Not Found

Project not found

Response Example (200 OK) 
[
  {
    "is_available": true,
    "custom_name": "My cool product",
    "has_express": false,
    "base_product": {
      "original_name": "T-Shirt",
      "processing_areas": {
        "data": [
          {
            "position_id": 1,
            "position_name": "front",
            "template_height": 1000,
            "height": 2000,
            "printable_area_margin_from_top": 0,
            "width": 2000,
            "width_in_mm": 100,
            "template": "string",
            "height_in_mm": 100,
            "template_width": 1000
          }
        ]
      },
      "shipping_category": 1,
      "category_id": 5,
      "is_active": "boolean",
      "short_description": "string",
      "colors": {
        "data": [
          {
            "id": 123,
            "color": "Black",
            "is_colored": true,
            "color_hex": "#000000",
            "sizes": [
              {
                "id": 67,
                "size": "XL",
                "is_available": true,
                "sort_position": 1,
                "is_onlocalstock": true
              }
            ]
          }
        ]
      },
      "id": 1,
      "name": "Base product XY",
      "sales_price": {
        "data": [
          {
            "type": "generic"
          }
        ]
      },
      "manufacturer": {
        "id": 123,
        "name": "Musterfirma"
      },
      "sizechart_image": "string",
      "category": "Unisex-Shirts",
      "images": {
        "data": [
          {
            "url": "https://www.example.com/image.jpg",
            "sort_position": 1
          }
        ]
      },
      "description": "string",
      "price": {
        "data": [
          {
            "type": "generic"
          }
        ]
      }
    },
    "project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
    "name": "Base Product Name XY",
    "active_integration_syncs": [
      {
        "integration_id": 111,
        "integration_name": "shopify",
        "updated_at": "2017-01-01 12:34:56",
        "is_successful": true,
        "error": "Invalid or missing auth.",
        "in_queue": true,
        "integration_product_id": "9286211826",
        "is_syncing": true
      }
    ],
    "is_rendered": true,
    "sort_position": "1",
    "colors": [
      {
        "id": 123,
        "color": "Black",
        "is_colored": true,
        "color_hex": "#000000",
        "sizes": [
          {
            "id": 67,
            "size": "XL",
            "is_available": true,
            "sort_position": 1,
            "is_onlocalstock": true
          }
        ]
      }
    ],
    "id": 123,
    "integration_sync_log": [
      null
    ]
  }
]
cockpit_apikey
cockpit_oauth read-project
project

Add processing

POST /projects/{project-reference}/processings

Add processing information to a single campaign.

Processing
undefined
project-reference

Unique project identifier

type
string
in
path
Request Example
{
  "method": "print",
  "offset_center": 0,
  "area": "front",
  "offset_top": 50,
  "position": "center",
  "design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 200
}
204 No Content

Success

404 Not Found

Project not found
cockpit_apikey
cockpit_oauth write-project
project

Remove processing

DELETE /projects/{project-reference}/processings/{area}/{position}

Remove processing from specified processing area.

project-reference

Unique project identifier

type
string
in
path
area

Processing site to remove

type
string
in
path
position

Processing position to remove

type
string
in
path
204 No Content

Success

422 Unprocessable Entity

Campaign or processing not found
cockpit_apikey
cockpit_oauth write-project
project

Update processing

PUT /projects/{project-reference}/processings/{area}/{position}

Update processing information on a single campaign.

Processing
undefined
project-reference

Unique project identifier

type
string
in
path
area

Processing site to remove

type
string
in
path
position

Processing position to remove

type
string
in
path
Request Example
{
  "method": "print",
  "offset_center": 0,
  "area": "front",
  "offset_top": 50,
  "position": "center",
  "design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 200
}
204 No Content

Success

404 Not Found

Project not found
cockpit_apikey
cockpit_oauth write-campaign
project

Get all projects

GET /projects

Retrieve all projects available for the currently authenticated user. The projects are automatically paginated, meta information is included in the response.

page

Current page

type
integer 1
in
query
items

Number of items per page

type
integer 12
in
query
sort_col

Column used to sort the results. You can sort by: name, reference, url, default_preview_position, created_at, updated_at

type
string created_at
in
query
sort_dir

Direction for sorting

type
string DESC
in
query
200 OK

Success

Response Example (200 OK) 
{
  "meta": {
    "pagination": {
      "count": 10,
      "total_pages": 4,
      "links": {
        "previous": "string",
        "next": "string"
      },
      "current_page": 2,
      "total": 32,
      "per_page": 10
    }
  },
  "data": [
    {
      "processings": {
        "data": [
          {
            "method": "print",
            "height": 300,
            "offset_center": 0,
            "area": "front",
            "offset_top": 50,
            "position": "center",
            "design": {
              "height": 3000,
              "is_dark": true,
              "complementary_color": "",
              "preview": "https://example.com/product_prev.png",
              "name": "My cool design",
              "is_processed": true,
              "updated_at": "2017-01-01 12:34:56",
              "colors": 5,
              "palette": [
                "A20061",
                "FFBC42",
                "1C838A",
                "021618",
                "A3AAAB"
              ],
              "original_file": "https://example.com/product.png",
              "filename": "ABCDE",
              "created_at": "2017-01-01 12:34:56",
              "filetype": "png",
              "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
              "width": 5000
            },
            "width": 200,
            "updated_at": "2017-01-01 12:34:56"
          }
        ]
      },
      "updated_at": "2017-01-01 12:34:56",
      "is_syncing": {
        "12": true
      },
      "status": "Finalisiert",
      "created_at": "2017-01-01 12:34:56",
      "is_published": true,
      "name": "My cool project",
      "is_queueing": {
        "12": true
      },
      "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
      "type": "ondemand",
      "products_count": 3
    }
  ]
}
cockpit_apikey
cockpit_oauth read-project
project

Create Project

POST /projects

Create a new project and return the inserted information. Associate the project with the currently authenticated user.

name: string

Project name

Request Example
{
  "name": "My cool project"
}
200 OK
Project

Success

Response Example (200 OK) 
{
  "processings": {
    "data": [
      {
        "method": "print",
        "height": 300,
        "offset_center": 0,
        "area": "front",
        "offset_top": 50,
        "position": "center",
        "design": {
          "height": 3000,
          "is_dark": true,
          "complementary_color": "",
          "preview": "https://example.com/product_prev.png",
          "name": "My cool design",
          "is_processed": true,
          "updated_at": "2017-01-01 12:34:56",
          "colors": 5,
          "palette": [
            "A20061",
            "FFBC42",
            "1C838A",
            "021618",
            "A3AAAB"
          ],
          "original_file": "https://example.com/product.png",
          "filename": "ABCDE",
          "created_at": "2017-01-01 12:34:56",
          "filetype": "png",
          "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
          "width": 5000
        },
        "width": 200,
        "updated_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "updated_at": "2017-01-01 12:34:56",
  "is_syncing": {
    "12": true
  },
  "status": "Finalisiert",
  "created_at": "2017-01-01 12:34:56",
  "is_published": true,
  "name": "My cool project",
  "is_queueing": {
    "12": true
  },
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "type": "ondemand",
  "products_count": 3
}
cockpit_apikey
cockpit_oauth write-project
project

Publish project

POST /projects/{project-reference}/publish

Publish project draft. To be eligible for publication, a project must have at least one product and one print attached to it.

project-reference

Unique project identifier

type
string
in
path
204 No Content

Success, project transferred

404 Not Found

Project not found

422 Unprocessable Entity

Requirements not fulfilled
cockpit_apikey
cockpit_oauth write-project

order

Endpoints in this section retrieve information about issued orders.

order

Get coupon info

GET /coupons/{coupon-code}

Retrieve information about a single order coupon.

coupon-code

Alphanumerical coupon identifier as provided to the customer

type
string
in
200 OK
Coupon

Success

404 Not Found

Coupon not found

Response Example (200 OK)
cockpit_apikey
cockpit_oauth read-order
order

Get order

GET /orders/{order-reference}

Retrieve information about a single order. Only orders visible by the currently authenticated user may be retrieved.

order-reference

Alphanumerical order identifier

type
string
in
path
200 OK
Order

Success

404 Not Found

Order not found

Response Example (200 OK) 
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": {
    "data": [
      {
        "id": "integer",
        "net_total_price": 75,
        "amount": 1,
        "name": "Greeting card",
        "type": "hangtag"
      }
    ]
  },
  "bill": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "vat_rate": 19,
  "reference": "ABCDXY1",
  "created_at": "2017-01-01 12:34:56",
  "total_items": 5,
  "fulfillment": {},
  "products": {
    "data": [
      {
        "id": "integer",
        "size": "XL",
        "net_total_price": 1375,
        "campaign_name": "Example Project",
        "campaign_product_id": "123",
        "amount": 1,
        "color": "Black",
        "name": "Base product XY",
        "images": [
          {
            "color": "Red",
            "urls": {
              "small": "http://www.example.com/my-orders/small.png",
              "large": "http://www.example.com/my-orders/large.png"
            },
            "area": "front"
          }
        ],
        "campaign_reference": "F7S33M2"
      }
    ]
  },
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "status": "Bestellung offen",
  "shipping": {
    "created_at": "2017-01-01 12:34:56",
    "is_shipped": false,
    "updated_at": "2017-01-01 12:34:56",
    "tracking_code": "string",
    "tracking_url": "string",
    "country_code": "DE",
    "type": "delivery"
  },
  "orderStatusEntries": {
    "data": [
      {
        "key": "string",
        "description": "integer",
        "updated_at": "2017-01-01 12:34:56",
        "status": "string",
        "created_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "payments": {
    "data": [
      {
        "id": "d1364568-4b15-4706-89f1-2452efe1261d"
      }
    ]
  }
}
cockpit_apikey
cockpit_oauth read-order
order

Get all orders

GET /orders

Retrieve all orders issued by the currently authenticated user. The result will be paginated, meta information is included in the response.

page

Page number

type
integer 1
in
query
filter

Filter by order status id

type
integer 1
in
query
items

Items per page

type
integer 12
in
query
search

Search query

type
integer
in
query
sort_col

Property to order by

type
string
in
query
sort_dir

Order direction

type
string asc, desc asc
in
query
period

Days to show (default: all)

type
integer
in
query
secondary_filter

Secondary filter level (e.g. filter reprint orders)

type
string
in
query
200 OK

Success

Response Example (200 OK) 
{
  "meta": {
    "pagination": {
      "count": 10,
      "total_pages": 4,
      "links": {
        "previous": "string",
        "next": "string"
      },
      "current_page": 2,
      "total": 32,
      "per_page": 10
    }
  },
  "data": [
    {
      "delivery": {
        "firstname": "Max",
        "street": "Musterstraße 12",
        "title": "Dr.",
        "country": "DE",
        "city": "Köln",
        "lastname": "Mustermann",
        "company": "Shirtigo GmbH",
        "postcode": "12345"
      },
      "packins": {
        "data": [
          {
            "id": "integer",
            "net_total_price": 75,
            "amount": 1,
            "name": "Greeting card",
            "type": "hangtag"
          }
        ]
      },
      "bill": {
        "firstname": "Max",
        "street": "Musterstraße 12",
        "title": "Dr.",
        "country": "DE",
        "city": "Köln",
        "lastname": "Mustermann",
        "company": "Shirtigo GmbH",
        "postcode": "12345"
      },
      "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
      "vat_rate": 19,
      "reference": "ABCDXY1",
      "created_at": "2017-01-01 12:34:56",
      "total_items": 5,
      "fulfillment": {},
      "products": {
        "data": [
          {
            "id": "integer",
            "size": "XL",
            "net_total_price": 1375,
            "campaign_name": "Example Project",
            "campaign_product_id": "123",
            "amount": 1,
            "color": "Black",
            "name": "Base product XY",
            "images": [
              {
                "color": "Red",
                "urls": {
                  "small": "http://www.example.com/my-orders/small.png",
                  "large": "http://www.example.com/my-orders/large.png"
                },
                "area": "front"
              }
            ],
            "campaign_reference": "F7S33M2"
          }
        ]
      },
      "sender": {
        "firstname": "Max",
        "street": "Musterstraße 12",
        "title": "Dr.",
        "country": "DE",
        "city": "Köln",
        "lastname": "Mustermann",
        "company": "Shirtigo GmbH",
        "postcode": "12345"
      },
      "status": "Bestellung offen",
      "shipping": {
        "created_at": "2017-01-01 12:34:56",
        "is_shipped": false,
        "updated_at": "2017-01-01 12:34:56",
        "tracking_code": "string",
        "tracking_url": "string",
        "country_code": "DE",
        "type": "delivery"
      },
      "orderStatusEntries": {
        "data": [
          null
        ]
      }
    }
  ]
}
cockpit_apikey
cockpit_oauth read-order
order

Create order

POST /orders

Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.

delivery: OrderAddress

Create order

Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.

packins: object[]

Selected packins (optional)

delivery_receipt_note: string

Custom note printed on delivery receipt

add_delivery_receipt: boolean

Indicates if delivery receipt is added to delivery (default = true)

products: object[]

Selected products

sender: OrderAddress

Create order

Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.

delivery_receipt_logo_reference: string

Logo printed on delivery receipt (optional)

Request Example
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": [
    {
      "first_packin_reference": "A12345",
      "second_packin_reference": "A12345",
      "sticker_reference": "A12345",
      "imprint_reference": "A12345",
      "label_reference": "A12345",
      "hangtag_reference": "A12345",
      "order_packaging_reference": "A12345",
      "product_packaging_reference": "A12345"
    }
  ],
  "delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
  "add_delivery_receipt": "true",
  "products": [
    {
      "productId": 235,
      "colorId": 326,
      "sizeId": 1,
      "amount": 1
    }
  ],
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_logo_reference": "ABC123"
}
201 Created
Order

Success, order has been created

401 Unauthorized

Unauthorized (no credentials or not eligible for ordering)

422 Unprocessable Entity

Validation failed, details in response body

Response Example (201 Created) 
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": {
    "data": [
      {
        "id": "integer",
        "net_total_price": 75,
        "amount": 1,
        "name": "Greeting card",
        "type": "hangtag"
      }
    ]
  },
  "bill": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "vat_rate": 19,
  "reference": "ABCDXY1",
  "created_at": "2017-01-01 12:34:56",
  "total_items": 5,
  "fulfillment": {},
  "products": {
    "data": [
      {
        "id": "integer",
        "size": "XL",
        "net_total_price": 1375,
        "campaign_name": "Example Project",
        "campaign_product_id": "123",
        "amount": 1,
        "color": "Black",
        "name": "Base product XY",
        "images": [
          {
            "color": "Red",
            "urls": {
              "small": "http://www.example.com/my-orders/small.png",
              "large": "http://www.example.com/my-orders/large.png"
            },
            "area": "front"
          }
        ],
        "campaign_reference": "F7S33M2"
      }
    ]
  },
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "status": "Bestellung offen",
  "shipping": {
    "created_at": "2017-01-01 12:34:56",
    "is_shipped": false,
    "updated_at": "2017-01-01 12:34:56",
    "tracking_code": "string",
    "tracking_url": "string",
    "country_code": "DE",
    "type": "delivery"
  },
  "orderStatusEntries": {
    "data": [
      {
        "key": "string",
        "description": "integer",
        "updated_at": "2017-01-01 12:34:56",
        "status": "string",
        "created_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "payments": {
    "data": [
      {
        "id": "d1364568-4b15-4706-89f1-2452efe1261d"
      }
    ]
  }
}
cockpit_apikey
cockpit_oauth write-order
order

Cancel order

POST /orders/{order-reference}/cancel

Set the order status to canceled.

order-reference

Alphanumerical order identifier

type
string
in
path
204 No Content

Success, order has been canceled.

404 Not Found

Order not found
cockpit_apikey
cockpit_oauth write-order
order

Calculate price

POST /orders/predict-price

Calculate the full price (incl. shipping and taxes) for the selected order candidate. This can be done before ordering. The parameters are the same as to the "Create Order" endpoint.

delivery: OrderAddress

Create order

Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.

packins: object[]

Selected packins (optional)

delivery_receipt_note: string

Custom note printed on delivery receipt

add_delivery_receipt: boolean

Indicates if delivery receipt is added to delivery (default = true)

products: object[]

Selected products

sender: OrderAddress

Create order

Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.

delivery_receipt_logo_reference: string

Logo printed on delivery receipt (optional)

Request Example
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": [
    {
      "first_packin_reference": "A12345",
      "second_packin_reference": "A12345",
      "sticker_reference": "A12345",
      "imprint_reference": "A12345",
      "label_reference": "A12345",
      "hangtag_reference": "A12345",
      "order_packaging_reference": "A12345",
      "product_packaging_reference": "A12345"
    }
  ],
  "delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
  "add_delivery_receipt": "true",
  "products": [
    {
      "productId": 235,
      "colorId": 326,
      "sizeId": 1,
      "amount": 1
    }
  ],
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_logo_reference": "ABC123"
}
200 OK

Success, price has been calculated

422 Unprocessable Entity

Validation failed, details in response body

Response Example (200 OK) 
{
  "included_tax_rate": 19
}
cockpit_apikey
cockpit_oauth
order

Retry payment

POST /orders/{order-reference}/repay

Set the order payment method to the current user's payment method and retry credit card capture.

order-reference

Alphanumerical order identifier

type
string
in
path
204 No Content

Success, order has been paid.

400 Bad Request

Payment failed (either duplicate payment or an error occured).
cockpit_apikey
cockpit_oauth read-order
order

Create order comment

POST /orders/{order-reference}/comments

Creates a new comment for a given order. Expects the comment text.

order-reference

Alphanumerical order identifier

type
string
in
path
204 No Content

Success, comment has been created.

404 Not Found

Order not found
cockpit_apikey
cockpit_oauth write-order
order

Create Quick-Order

POST /quickorder

Create a design, a product and place an order - in a single step.

delivery: OrderAddress

Create Quick-Order

Create a design, a product and place an order - in a single step.

packins: object[]

Selected packins (optional)

jobs: object[]

Processing jobs

delivery_receipt_note: string

Custom note printed on delivery receipt

add_delivery_receipt: boolean

Indicates if delivery receipt is added to delivery (default = true)

sender: OrderAddress

Create Quick-Order

Create a design, a product and place an order - in a single step.

delivery_receipt_logo_reference: string

Logo printed on delivery receipt (optional)

Request Example
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": [
    {
      "first_packin_reference": "A12345",
      "second_packin_reference": "A12345",
      "sticker_reference": "A12345",
      "imprint_reference": "A12345",
      "label_reference": "A12345",
      "hangtag_reference": "A12345",
      "order_packaging_reference": "A12345",
      "product_packaging_reference": "A12345"
    }
  ],
  "jobs": [
    {
      "processings": [
        {
          "method": "print",
          "offset_center": 0,
          "area": "front",
          "offset_top": 50,
          "position": "center",
          "design": {
            "url": "https://myurl/myimage.png"
          },
          "width": 200
        }
      ],
      "base_products": [
        {
          "id": 235,
          "colors": [
            {
              "id": 326,
              "sizes": [
                {
                  "id": 1,
                  "amount": "integer"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
  "add_delivery_receipt": "true",
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_logo_reference": "ABC123"
}
201 Created
Order

Success, order has been created

401 Unauthorized

Unauthorized (no credentials or not eligible for ordering)

422 Unprocessable Entity

Validation failed, details in response body

Response Example (201 Created) 
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": {
    "data": [
      {
        "id": "integer",
        "net_total_price": 75,
        "amount": 1,
        "name": "Greeting card",
        "type": "hangtag"
      }
    ]
  },
  "bill": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "vat_rate": 19,
  "reference": "ABCDXY1",
  "created_at": "2017-01-01 12:34:56",
  "total_items": 5,
  "fulfillment": {},
  "products": {
    "data": [
      {
        "id": "integer",
        "size": "XL",
        "net_total_price": 1375,
        "campaign_name": "Example Project",
        "campaign_product_id": "123",
        "amount": 1,
        "color": "Black",
        "name": "Base product XY",
        "images": [
          {
            "color": "Red",
            "urls": {
              "small": "http://www.example.com/my-orders/small.png",
              "large": "http://www.example.com/my-orders/large.png"
            },
            "area": "front"
          }
        ],
        "campaign_reference": "F7S33M2"
      }
    ]
  },
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "status": "Bestellung offen",
  "shipping": {
    "created_at": "2017-01-01 12:34:56",
    "is_shipped": false,
    "updated_at": "2017-01-01 12:34:56",
    "tracking_code": "string",
    "tracking_url": "string",
    "country_code": "DE",
    "type": "delivery"
  },
  "orderStatusEntries": {
    "data": [
      {
        "key": "string",
        "description": "integer",
        "updated_at": "2017-01-01 12:34:56",
        "status": "string",
        "created_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "payments": {
    "data": [
      {
        "id": "d1364568-4b15-4706-89f1-2452efe1261d"
      }
    ]
  }
}
cockpit_apikey
cockpit_oauth write-order

other

This section contains miscellaneous endpoints.

other

Get delivery targets

GET /delivery-countries

Retrieve a list of valid delivery target countries. The result is presented as associative array: The array keys consist of upper-case two-letter country codes, the corresponding values are the human readable country names.

200 OK

Success

Response Example (200 OK) 
{
  "data": [
    {
      "name": "Germany",
      "iso": "DE"
    }
  ]
}
cockpit_oauth
other

Get selling statistics

GET /selling-statistics

Retrieve statistics about the current user's sales. This endpoint reports the number of sales and the total net amount for four different reporting periods: Last 24 hours, last 7 days, last 30 days and total.

200 OK

Success

Response Example (200 OK) 
{
  "month_amount": 14,
  "total_amount": 36,
  "week_amount": 3,
  "today_amount": 1
}
cockpit_oauth
other

Calculate production cost

POST /calculation

Calculate the net production cost for a given product, set of print areas and color information. The VAT rate rate is preliminary, the final rate depends on the shipping target, involvement of business customers and other factors.

is_colored: boolean

Is this a color print?

printareas: integer[]

Desired print areas

product_id: integer

Desired base product

Request Example
{
  "is_colored": true,
  "printareas": [
    "integer"
  ],
  "product_id": 375
}
200 OK
MoneyWithVat

Success

404 Not Found

Product not found

Response Example (200 OK)
cockpit_oauth

Schema Definitions

OrderPackin: object

id: integer

Packin id

net_unit_price: Money

Net unit price

net_total_price: Money

Total price (net_unit_price*amount)

amount: integer

Number of items

name: string

Packin name

type: string

Packin type (hangtag or packin)

Example
{
  "id": "integer",
  "net_total_price": 75,
  "amount": 1,
  "name": "Greeting card",
  "type": "hangtag"
}

ProjectPrint: object

method: string

Processing method

height: integer

Design height in millimeters

offset_center: integer

Horizontal offset from center in millimeters

area: string

Processing site

offset_top: integer

Vertical offset from top in millimeters

position: string

Processing position

design: Design
width: integer

Design width in millimeters

updated_at: string

Timestamp of last update

Example
{
  "method": "print",
  "height": 300,
  "offset_center": 0,
  "area": "front",
  "offset_top": 50,
  "position": "center",
  "design": {
    "height": 3000,
    "is_dark": true,
    "complementary_color": "",
    "preview": "https://example.com/product_prev.png",
    "name": "My cool design",
    "is_processed": true,
    "updated_at": "2017-01-01 12:34:56",
    "colors": 5,
    "palette": [
      "A20061",
      "FFBC42",
      "1C838A",
      "021618",
      "A3AAAB"
    ],
    "original_file": "https://example.com/product.png",
    "filename": "ABCDE",
    "created_at": "2017-01-01 12:34:56",
    "filetype": "png",
    "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
    "width": 5000
  },
  "width": 200,
  "updated_at": "2017-01-01 12:34:56"
}

UserIntegration: object

default_first_packin_reference: string

Default first packin added to orders received via this intergrations (optional)

is_auto_pull_orders: boolean

Flag if automatically reimporting of orders is enabled.

default_sticker_reference: string

Default sticker applied to packaging of orders received via this intergrations (optional)

delivery_receipt_logo: string

Url to custom logo added to delivery slip for orders received via this intergrations (optional)

reference: uuid

Reference of the integration

default_second_packin_reference: string

Default second packin added to orders received via this intergrations (optional)

sticker_logo: string

Url to custom sticker logo for orders received via this intergrations (optional)

image_type: string

Type of image transfered to external shop

app: string

Name of the integration application

image_quality: string

Quality of image transfered to external shop

default_label_reference: string

Default label added to all textil products of orders received via this intergrations (optional)

default_product_packaging_reference: string

Default packaging used for all textil products of orders received via this intergrations (optional)

default_order_packaging_reference: string

Default packging used for all orders received via this intergrations (optional)

default_hangtag_reference: string

Default hangtag added to all textil products of orders received via this intergrations (optional)

name: string

The name of the integration, i.e. the shop URL

default_imprint_reference: string

Default imprinted added to all tagless textil products of orders received via this intergrations (optional)

is_pull_orders: boolean

Flag if manually reimporting of orders is enabled.

id: integer

The internal cockpit id of the used user integration

delivery_receipt_note: string

Custom note on delivery receipt

use_custom_product_name: boolean

Indicates if custom product name is used on delivery receipt

default_delivery_receipt_logo_reference: string

Default delivery receipt logo used for orders received via this intergrations (optional)

add_delivery_receipt: boolean

Indicates if delivery receipt is added to orders received via this intergrations

expires_in: string

Date of expire

Example
{
  "default_first_packin_reference": "ABC123",
  "is_auto_pull_orders": "true",
  "default_sticker_reference": "ABC123",
  "delivery_receipt_logo": "https://example.com/custom_logo.png",
  "reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
  "default_second_packin_reference": "ABC123",
  "sticker_logo": "https://example.com/custom_logo.png",
  "image_type": "png",
  "app": "shopify",
  "image_quality": "high",
  "default_label_reference": "ABC123",
  "default_product_packaging_reference": "ABC123",
  "default_order_packaging_reference": "ABC123",
  "default_hangtag_reference": "ABC123",
  "name": "my-cool-shirtstore.myshopify.com",
  "default_imprint_reference": "ABC123",
  "is_pull_orders": "true",
  "id": 111,
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "use_custom_product_name": "true",
  "default_delivery_receipt_logo_reference": "ABC123",
  "add_delivery_receipt": true,
  "expires_in": "2018-01-01 12:34:56"
}

Processing: object

Processing to apply

method: string center

Processing method

offset_center: integer

Horizontal offset from center in millimeters

area: string

Processing area

offset_top: integer

Vertical offset from top in millimeters

position: string center

Processing position

design: string

Design reference

width: string 120

Design width in millimeters

Example
{
  "method": "print",
  "offset_center": 0,
  "area": "front",
  "offset_top": 50,
  "position": "center",
  "design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 200
}

UserGroup: object

id: integer

Numerical group identifier

updated_at: string

Timestamp of last update

created_at: string

Timestamp of creation

quantity: integer

Required number of sold products

cockpit_discount: integer

Discount in percent

type: string

Group name

Example
{
  "id": 1,
  "updated_at": "2017-01-01 12:34:56",
  "created_at": "2017-01-01 12:34:56",
  "quantity": 1000,
  "cockpit_discount": 20,
  "type": "premium"
}

ProjectWithProducts:

products: Product

Products associated with this Project

Example
{
  "products": [
    {
      "original_name": "T-Shirt",
      "processing_areas": {
        "data": [
          {
            "position_id": 1,
            "position_name": "front",
            "template_height": 1000,
            "height": 2000,
            "printable_area_margin_from_top": 0,
            "width": 2000,
            "width_in_mm": 100,
            "template": "string",
            "height_in_mm": 100,
            "template_width": 1000
          }
        ]
      },
      "shipping_category": 1,
      "category_id": 5,
      "is_active": "boolean",
      "short_description": "string",
      "colors": {
        "data": [
          {
            "id": 123,
            "color": "Black",
            "is_colored": true,
            "color_hex": "#000000",
            "sizes": [
              {
                "id": 67,
                "size": "XL",
                "is_available": true,
                "sort_position": 1,
                "is_onlocalstock": true
              }
            ]
          }
        ]
      },
      "id": 1,
      "name": "Base product XY",
      "sales_price": {
        "data": [
          {
            "type": "generic"
          }
        ]
      },
      "manufacturer": {
        "id": 123,
        "name": "Musterfirma"
      },
      "sizechart_image": "string",
      "category": "Unisex-Shirts",
      "images": {
        "data": [
          {
            "url": "https://www.example.com/image.jpg",
            "sort_position": 1
          }
        ]
      }
    }
  ],
  "processings": {
    "data": [
      {
        "method": "print",
        "height": 300,
        "offset_center": 0,
        "area": "front",
        "offset_top": 50,
        "position": "center",
        "design": {
          "height": 3000,
          "is_dark": true,
          "complementary_color": "",
          "preview": "https://example.com/product_prev.png",
          "name": "My cool design",
          "is_processed": true,
          "updated_at": "2017-01-01 12:34:56",
          "colors": 5,
          "palette": [
            "A20061",
            "FFBC42",
            "1C838A",
            "021618",
            "A3AAAB"
          ],
          "original_file": "https://example.com/product.png",
          "filename": "ABCDE",
          "created_at": "2017-01-01 12:34:56",
          "filetype": "png",
          "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
          "width": 5000
        },
        "width": 200,
        "updated_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "updated_at": "2017-01-01 12:34:56",
  "is_syncing": {
    "12": true
  },
  "status": "Finalisiert",
  "created_at": "2017-01-01 12:34:56",
  "is_published": true,
  "name": "My cool project",
  "is_queueing": {
    "12": true
  },
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "type": "ondemand",
  "products_count": 3
}

OrderRelation: object

status_key: string

Number of products

vat_amount: Money

VAT amount

total_items: integer

Total number of items in the order

updated_at: string

Timestamp of last update

created_at: string

Timestamp of creation

vat_rate: integer

VAT rate in percent

net_price: Money

Total net price of this order

gross_price: Money

Total gross price of this order

status: string

Human readable order status

reference: string

Unique identifier of this order

Example
{
  "status_key": "",
  "total_items": 5,
  "updated_at": "2017-01-01 12:34:56",
  "created_at": "2017-01-01 12:34:56",
  "vat_rate": 19,
  "status": "Bestellung offen",
  "reference": "ABCDXY1"
}

CampaignProduct: object

is_available: boolean

Is the product available?

custom_name: string

User defined product name

has_express: boolean

Is the product available for express processing?

base_product: Product

Base product

project: string

Project reference

name: string

Product name

active_integration_syncs: CampaignProductIntegrationSync

List of currently active synchronizations with integrations

is_rendered: boolean

Has the product been rendered?

sort_position: integer

Set a sort position for this product within its project

colors: ProductColor

List of available colors

id: integer

Numerical identifier

integration_sync_log: CampaignProductIntegrationSync

History of synchronizations with integrations for this product

updated_at: string

Timestamp of last update

project_name: string

Project name

images: UtilProductImage

Product images

description: string

Short description in HTML format

price: Money

Net price

integration_products: CampaignIntegrationProduct

List of integration products (e.g. products in shopify) for this products

Example
{
  "is_available": true,
  "custom_name": "My cool product",
  "has_express": false,
  "base_product": {
    "original_name": "T-Shirt",
    "processing_areas": {
      "data": [
        {
          "position_id": 1,
          "position_name": "front",
          "template_height": 1000,
          "height": 2000,
          "printable_area_margin_from_top": 0,
          "width": 2000,
          "width_in_mm": 100,
          "template": "string",
          "height_in_mm": 100,
          "template_width": 1000
        }
      ]
    },
    "shipping_category": 1,
    "category_id": 5,
    "is_active": "boolean",
    "short_description": "string",
    "colors": {
      "data": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ]
    },
    "id": 1,
    "name": "Base product XY",
    "sales_price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    },
    "manufacturer": {
      "id": 123,
      "name": "Musterfirma"
    },
    "sizechart_image": "string",
    "category": "Unisex-Shirts",
    "images": {
      "data": [
        {
          "url": "https://www.example.com/image.jpg",
          "sort_position": 1
        }
      ]
    },
    "description": "string",
    "price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    }
  },
  "project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "name": "Base Product Name XY",
  "active_integration_syncs": [
    {
      "integration_id": 111,
      "integration_name": "shopify",
      "updated_at": "2017-01-01 12:34:56",
      "is_successful": true,
      "error": "Invalid or missing auth.",
      "in_queue": true,
      "integration_product_id": "9286211826",
      "is_syncing": true
    }
  ],
  "is_rendered": true,
  "sort_position": "1",
  "colors": [
    {
      "id": 123,
      "color": "Black",
      "is_colored": true,
      "color_hex": "#000000",
      "sizes": [
        {
          "id": 67,
          "size": "XL",
          "is_available": true,
          "sort_position": 1,
          "is_onlocalstock": true
        }
      ]
    }
  ],
  "id": 123,
  "integration_sync_log": [
    {}
  ]
}

ProvisionalProduct: object

name: string

Product name

description: string

Short description

price: Money

Net price

base_product: Product

Base product

colors: ProductColor

List of available colors

Example
{
  "name": "Base product XY",
  "description": "string",
  "base_product": {
    "original_name": "T-Shirt",
    "processing_areas": {
      "data": [
        {
          "position_id": 1,
          "position_name": "front",
          "template_height": 1000,
          "height": 2000,
          "printable_area_margin_from_top": 0,
          "width": 2000,
          "width_in_mm": 100,
          "template": "string",
          "height_in_mm": 100,
          "template_width": 1000
        }
      ]
    },
    "shipping_category": 1,
    "category_id": 5,
    "is_active": "boolean",
    "short_description": "string",
    "colors": {
      "data": [
        {
          "id": 123,
          "color": "Black",
          "is_colored": true,
          "color_hex": "#000000",
          "sizes": [
            {
              "id": 67,
              "size": "XL",
              "is_available": true,
              "sort_position": 1,
              "is_onlocalstock": true
            }
          ]
        }
      ]
    },
    "id": 1,
    "name": "Base product XY",
    "sales_price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    },
    "manufacturer": {
      "id": 123,
      "name": "Musterfirma"
    },
    "sizechart_image": "string",
    "category": "Unisex-Shirts",
    "images": {
      "data": [
        {
          "url": "https://www.example.com/image.jpg",
          "sort_position": 1
        }
      ]
    },
    "description": "string",
    "price": {
      "data": [
        {
          "type": "generic"
        }
      ]
    }
  },
  "colors": [
    {
      "id": 123,
      "color": "Black",
      "is_colored": true,
      "color_hex": "#000000",
      "sizes": [
        {
          "id": 67,
          "size": "XL",
          "is_available": true,
          "sort_position": 1,
          "is_onlocalstock": true
        }
      ]
    }
  ]
}

Payment: object

id: string

Unique transaction identifier

vat_rate: integer

VAT rate in percent

order: Order

Order

status: string

Payment type

created_at: string

Timestamp of creation

vat_amount: Money

VAT amount

status_title: string

Payment description

gross_amount: Money

Gross price

net_amount: Money

Net price

payment_reference: string

Payment reference

Example
{
  "id": "d1364568-4b15-4706-89f1-2452efe1261d",
  "vat_rate": 19,
  "order": {
    "delivery": {
      "firstname": "Max",
      "street": "Musterstraße 12",
      "title": "Dr.",
      "country": "DE",
      "city": "Köln",
      "lastname": "Mustermann",
      "company": "Shirtigo GmbH",
      "postcode": "12345"
    },
    "packins": {
      "data": [
        {
          "id": "integer",
          "net_total_price": 75,
          "amount": 1,
          "name": "Greeting card",
          "type": "hangtag"
        }
      ]
    },
    "bill": {
      "firstname": "Max",
      "street": "Musterstraße 12",
      "title": "Dr.",
      "country": "DE",
      "city": "Köln",
      "lastname": "Mustermann",
      "company": "Shirtigo GmbH",
      "postcode": "12345"
    },
    "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
    "vat_rate": 19,
    "reference": "ABCDXY1",
    "created_at": "2017-01-01 12:34:56",
    "total_items": 5,
    "fulfillment": {},
    "products": {
      "data": [
        {
          "id": "integer",
          "size": "XL",
          "net_total_price": 1375,
          "campaign_name": "Example Project",
          "campaign_product_id": "123",
          "amount": 1,
          "color": "Black",
          "name": "Base product XY",
          "images": [
            {
              "color": "Red",
              "urls": {
                "small": "http://www.example.com/my-orders/small.png",
                "large": "http://www.example.com/my-orders/large.png"
              },
              "area": "front"
            }
          ],
          "campaign_reference": "F7S33M2"
        }
      ]
    },
    "sender": {
      "firstname": "Max",
      "street": "Musterstraße 12",
      "title": "Dr.",
      "country": "DE",
      "city": "Köln",
      "lastname": "Mustermann",
      "company": "Shirtigo GmbH",
      "postcode": "12345"
    },
    "status": "Bestellung offen",
    "shipping": {
      "created_at": "2017-01-01 12:34:56",
      "is_shipped": false,
      "updated_at": "2017-01-01 12:34:56",
      "tracking_code": "string",
      "tracking_url": "string",
      "country_code": "DE",
      "type": "delivery"
    },
    "orderStatusEntries": {
      "data": [
        {
          "key": "string",
          "description": "integer",
          "updated_at": "2017-01-01 12:34:56",
          "status": "string",
          "created_at": "2017-01-01 12:34:56"
        }
      ]
    },
    "payments": {
      "data": [
        null
      ]
    }
  }
}

User: object

user_group: UserGroup
display_name: string

Display name, e.g. first + last name

delivery_receipt_logo: string

Url to custom logo added to delivery slip and shipping lable for orders placed via dashboard

default_first_packin_reference: string

Default first packin added to orders placed via dashboard (optional)

updated_at: string

Timestamp of last update

integration_count: number

Number of active integrations

sender_title: string
is_billing_valid: boolean

Have billing options been filled out?

default_hangtag_reference: string

Default hangtag added to all textil products of orders placed via dashboard (optional)

city: string

City, used for billing

phone: string

Phone nubmer

sender_type: string full, company, legacy
email: string

Email address

sender_company_name: string
sticker_logo: string

Url to custom sticker logo for orders placed via dashboard (optional)

default_delivery_receipt_logo_reference: string

Default delivery receipt logo used for orders placed via dashboard

postcode: string

ZIP code, used for billing

default_second_packin_reference: string

Default second packin added to orders placed via dashboard (optional)

street: string

Street and number, used for billing

firstname: string

First name(s)

add_delivery_receipt: boolean

Indicates if delivery receipt is added to orders received via this intergrations

sender_city: string
delivery_receipt_note: string

Custom note on delivery receipt

integrations: UserIntegration

List of integrations (connected applications) for this user

sender_country: string
country: string

Country, used for billing

company_name: string

Company name

has_orders: boolean

Does user have orders?

title: string

(Academical) title

is_business: boolean

Is a business customer

use_custom_product_name: boolean

Indicates if custom product name is used on delivery receipt

sender_postcode: string
sender_firstname: string
lastname: string

Last name

sender_lastname: string
sender_state: string
sender_street: string
Example
{
  "user_group": {
    "id": 1,
    "updated_at": "2017-01-01 12:34:56",
    "created_at": "2017-01-01 12:34:56",
    "quantity": 1000,
    "cockpit_discount": 20,
    "type": "premium"
  },
  "display_name": "Max Mustermann",
  "delivery_receipt_logo": "https://example.com/custom_logo.png",
  "default_first_packin_reference": "ABC123",
  "updated_at": "2017-01-01 12:34:56",
  "integration_count": 2,
  "sender_title": "string",
  "is_billing_valid": true,
  "default_hangtag_reference": "ABC123",
  "city": "Köln",
  "phone": "004930123456",
  "sender_type": "string",
  "email": "mustermann@example.com",
  "sender_company_name": "string",
  "sticker_logo": "https://example.com/custom_logo.png",
  "default_delivery_receipt_logo_reference": "ABC123",
  "postcode": "12345",
  "default_second_packin_reference": "ABC123",
  "street": "Musterstraße 12",
  "firstname": "Max",
  "add_delivery_receipt": true,
  "sender_city": "string",
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "integrations": [
    {
      "default_first_packin_reference": "ABC123",
      "is_auto_pull_orders": "true",
      "default_sticker_reference": "ABC123",
      "delivery_receipt_logo": "https://example.com/custom_logo.png",
      "reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
      "default_second_packin_reference": "ABC123",
      "sticker_logo": "https://example.com/custom_logo.png",
      "image_type": "png",
      "app": "shopify",
      "image_quality": "high",
      "default_label_reference": "ABC123",
      "default_product_packaging_reference": "ABC123",
      "default_order_packaging_reference": "ABC123",
      "default_hangtag_reference": "ABC123",
      "name": "my-cool-shirtstore.myshopify.com",
      "default_imprint_reference": "ABC123",
      "is_pull_orders": "true",
      "id": 111,
      "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
      "use_custom_product_name": "true",
      "default_delivery_receipt_logo_reference": "ABC123",
      "add_delivery_receipt": true,
      "expires_in": "2018-01-01 12:34:56"
    }
  ],
  "sender_country": "string",
  "country": "Deutschland",
  "company_name": "Shirtigo GmbH",
  "has_orders": true,
  "title": "Dr.",
  "is_business": "true",
  "use_custom_product_name": "true",
  "sender_postcode": "string",
  "sender_firstname": "string",
  "lastname": "Mustermann",
  "sender_lastname": "string",
  "sender_state": "string",
  "sender_street": "string"
}

ProductPrice: object

price: Money

Price

type: string

Variant

Example
{
  "type": "generic"
}

OAuthServerException: object

hint: string

A helper hint.

error: string

Machine readable error type.

message: string

Human readable error message.

Example
{
  "hint": "string",
  "error": "string",
  "message": "string"
}

ProductProcessingArea: object

position_id: integer

Numerical identifier

position_name: string

Name of the printarea

template_height: integer

Default template height

height: integer

Height of the printarea in pixels

printable_area_margin_from_top: integer

Distance between top and processable area top

width: integer

Width of the printarea in pixels

width_in_mm: integer

Width of the printarea in millimeters

template: string

Template

height_in_mm: integer

Height of the printarea in millimeters

template_width: integer

Default template width

Example
{
  "position_id": 1,
  "position_name": "front",
  "template_height": 1000,
  "height": 2000,
  "printable_area_margin_from_top": 0,
  "width": 2000,
  "width_in_mm": 100,
  "template": "string",
  "height_in_mm": 100,
  "template_width": 1000
}

ProductColor: object

id: integer

Numerical identifier

color: string

Color name

is_colored: boolean

Is this a non trivial (b/w) color?

color_hex: string

Hexadecimal RGB color value

sizes: object[]

Available sizes

Example
{
  "id": 123,
  "color": "Black",
  "is_colored": true,
  "color_hex": "#000000",
  "sizes": [
    {
      "id": 67,
      "size": "XL",
      "is_available": true,
      "sort_position": 1,
      "is_onlocalstock": true
    }
  ]
}

UtilProductImage: object

color: string

Color name

urls: object

Product name

area: string

Processing area name

Example
{
  "color": "Red",
  "urls": {
    "small": "http://www.example.com/my-orders/small.png",
    "large": "http://www.example.com/my-orders/large.png"
  },
  "area": "front"
}

OrderProduct: object

id: integer

Product id

size: string

Size name

net_total_price: Money

Total price (net_unit_price*amount)

campaign_name: string

Name of the campaign

campaign_product_id: int

ID of the campaign product

amount: integer

Number of items

color: string

Color name

name: string

Product name

images: UtilProductImage

Available image URLs

net_unit_price: Money

Net unit price

campaign_reference: string

Reference of the campaign

Example
{
  "id": "integer",
  "size": "XL",
  "net_total_price": 1375,
  "campaign_name": "Example Project",
  "campaign_product_id": "123",
  "amount": 1,
  "color": "Black",
  "name": "Base product XY",
  "images": [
    {
      "color": "Red",
      "urls": {
        "small": "http://www.example.com/my-orders/small.png",
        "large": "http://www.example.com/my-orders/large.png"
      },
      "area": "front"
    }
  ],
  "campaign_reference": "F7S33M2"
}

Order: object

delivery: OrderAddress

Delivery address

packins: object

Array of packins and hangtags in this order

bill: OrderAddress

Billing address

delivery_receipt_note: string

Custom note on delivery receipt

vat_rate: integer

VAT rate in percent

net_price: Money

Total net price of this order

reference: string

Unique identifier of this order

created_at: string

Timestamp of creation

total_items: integer

Total number of items in the order

fulfillment: object

Fulfillment details or false if no details are available

products: object

Array of products in this order

sender: OrderAddress

Sender address

status: string

Human readable order status

shipping: OrderShipping

Details on the shipping method, status and tracking (only present if order is being or has been shipped)

orderStatusEntries: object

Array of status messages associated with this order

vat_amount: Money

VAT amount

payments: object

Array of payments associated with this order

gross_price: Money

Total gross price of this order

updated_at: string

Timestamp of last update

status_key: string

Number of products

invoice_reference: string

Invoice reference

use_custom_product_name: boolean

Use custom product name on delivery receipt

add_delivery_receipt: boolean

Indicates if delivery receipt is added to order

delivery_receipt_logo_reference: string

Media reference for the logo added to delivery_receipt

Example
{
  "delivery": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "packins": {
    "data": [
      {
        "id": "integer",
        "net_total_price": 75,
        "amount": 1,
        "name": "Greeting card",
        "type": "hangtag"
      }
    ]
  },
  "bill": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
  "vat_rate": 19,
  "reference": "ABCDXY1",
  "created_at": "2017-01-01 12:34:56",
  "total_items": 5,
  "fulfillment": {},
  "products": {
    "data": [
      {
        "id": "integer",
        "size": "XL",
        "net_total_price": 1375,
        "campaign_name": "Example Project",
        "campaign_product_id": "123",
        "amount": 1,
        "color": "Black",
        "name": "Base product XY",
        "images": [
          {
            "color": "Red",
            "urls": {
              "small": "http://www.example.com/my-orders/small.png",
              "large": "http://www.example.com/my-orders/large.png"
            },
            "area": "front"
          }
        ],
        "campaign_reference": "F7S33M2"
      }
    ]
  },
  "sender": {
    "firstname": "Max",
    "street": "Musterstraße 12",
    "title": "Dr.",
    "country": "DE",
    "city": "Köln",
    "lastname": "Mustermann",
    "company": "Shirtigo GmbH",
    "postcode": "12345"
  },
  "status": "Bestellung offen",
  "shipping": {
    "created_at": "2017-01-01 12:34:56",
    "is_shipped": false,
    "updated_at": "2017-01-01 12:34:56",
    "tracking_code": "string",
    "tracking_url": "string",
    "country_code": "DE",
    "type": "delivery"
  },
  "orderStatusEntries": {
    "data": [
      {
        "key": "string",
        "description": "integer",
        "updated_at": "2017-01-01 12:34:56",
        "status": "string",
        "created_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "payments": {
    "data": [
      {
        "id": "d1364568-4b15-4706-89f1-2452efe1261d",
        "vat_rate": 19
      }
    ]
  }
}

ProductManufacturer: object

id: integer

Numerical identifier

name: string

Manufacturer name

Example
{
  "id": 123,
  "name": "Musterfirma"
}

OrderPayment: object

id: string

Unique transaction identifier

vat_rate: integer

VAT rate in percent

net_amount: Money

Net price

updated_at: string

Timestamp of last update

status: string

Payment status

status_details: string

Payment error description (if there is any)

vat_amount: Money

VAT amount

gross_amount: Money

Gross price

type: string

Payment type

Example
{
  "id": "d1364568-4b15-4706-89f1-2452efe1261d",
  "vat_rate": 19,
  "updated_at": "2017-01-01 12:34:56",
  "status": "paid",
  "status_details": "An error occured.",
  "type": "creditcard"
}

ProductDimensions: object

size: string

Product size name

height: integer

Height in mm

width: integer

Width in mm

Example
{
  "size": "XL",
  "height": 500,
  "width": 200
}

CampaignIntegrationProduct: object

integration_id: integer

The cockpit internal id of the used user integration

integration_product_id: string

The identifier used by the integration application

updated_at: string

Timestamp of last update

Example
{
  "integration_id": 111,
  "integration_product_id": "9286211826",
  "updated_at": "2017-01-01 12:34:56"
}

CampaignProductIntegrationSync: object

integration_id: integer

The cockpit internal id of the used user integration

integration_name: string

Name of the integration application

updated_at: string

Timestamp of last update

is_successful: boolean

Has the product been rendered?

error: string

Error message

in_queue: boolean

Is the current sync-process still in queue?

integration_product_id: string

The identifier used by the integration application

is_syncing: boolean

Is the product available?

Example
{
  "integration_id": 111,
  "integration_name": "shopify",
  "updated_at": "2017-01-01 12:34:56",
  "is_successful": true,
  "error": "Invalid or missing auth.",
  "in_queue": true,
  "integration_product_id": "9286211826",
  "is_syncing": true
}

OrderStatusEntry: object

key: string

Order status key

description: integer

Verbose status description

updated_at: string

Timestamp of last update

status: string

Human readable status

created_at: string

Timestamp of creation

Example
{
  "key": "string",
  "description": "integer",
  "updated_at": "2017-01-01 12:34:56",
  "status": "string",
  "created_at": "2017-01-01 12:34:56"
}

OrderAddress: object

Address

firstname: string

First name

street: string

Street and number

title: string

(Academic) title

country: string

A country iso-code (ISO 3166-1 alpha2) as listed in the /delivery-countries endpoint

city: string

City

lastname: string

Last name

company: string

Company name

postcode: string

ZIP/area code

Example
{
  "firstname": "Max",
  "street": "Musterstraße 12",
  "title": "Dr.",
  "country": "DE",
  "city": "Köln",
  "lastname": "Mustermann",
  "company": "Shirtigo GmbH",
  "postcode": "12345"
}

Design: object

height: integer

Height of the design file in pixels

is_dark: boolean

Is this a design with dark colors?

complementary_color: string

Complementary color

preview: string

URL to preview image

name: string

Design Name

is_processed: boolean

Has the design been rendered?

updated_at: string

Timestamp of last update

colors: integer

Total number of colors in the color palette

palette: string[]

List of hex-codes of representative colors

original_file: string

URL to full resolution image

filename: string

Design file name

created_at: string

Timestamp of creation

filetype: string

Extension of the design file name

reference: string

Unique identifier of this design

width: integer

Width of the design file in pixels

Example
{
  "height": 3000,
  "is_dark": true,
  "complementary_color": "",
  "preview": "https://example.com/product_prev.png",
  "name": "My cool design",
  "is_processed": true,
  "updated_at": "2017-01-01 12:34:56",
  "colors": 5,
  "palette": [
    "A20061",
    "FFBC42",
    "1C838A",
    "021618",
    "A3AAAB"
  ],
  "original_file": "https://example.com/product.png",
  "filename": "ABCDE",
  "created_at": "2017-01-01 12:34:56",
  "filetype": "png",
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "width": 5000
}

Pagination: object

Pagination information

count: integer

Number of items on current page

total_pages: integer

Total number of pages

links: object

URLs of adjacent pages

current_page: integer

Index of current page

total: integer

Total number of items

per_page: integer

Default number of items per page

Example
{
  "count": 10,
  "total_pages": 4,
  "links": {
    "previous": "string",
    "next": "string"
  },
  "current_page": 2,
  "total": 32,
  "per_page": 10
}

UserPackin: object

is_active: boolean

Packins receives status is_active, when article is checked and warehoused

stocking_costs: Money

Daily costs for stocking packin

inventory: integer

Actual stock level of packin

name: string

Packin name

type: string

Packin type (packin or hangtag)

initial_inventory: integer

Initial stock level of packin

weight_gram: integer

Weight of one single packin in gram

size_id: integer

Product size ID for which imprint will be applied

position: string

Position of Label

color_ids: string

Array of product color ids for which imprint or label will be applied

width_mm: integer

Width of the packin in millimeter

height_mm: integer

Height of the packin in millimeter

reference: ABC123

Packin reference

preview_path: string

Path to packin preview

Example
{
  "is_active": "true",
  "stocking_costs": 50,
  "inventory": "1000",
  "name": "Greetings card",
  "type": "packin",
  "initial_inventory": "1000",
  "weight_gram": "10",
  "size_id": "3",
  "position": "seam-left",
  "color_ids": "['147','157']",
  "width_mm": "100",
  "height_mm": "100",
  "reference": "ABC123",
  "preview_path": "https://s3.amazon.com/preview.png"
}

Country: object

name: string

Country name

iso: string

Two-letter identifier according to ISO 3166-1

Example
{
  "name": "Germany",
  "iso": "DE"
}

Product: object

original_name: string

Base product name

processing_areas: object

Available processing areas

shipping_category: integer

Shipping category

category_id: integer

Numerical category identifier

is_active: boolean

Activation status. Base products may not be available for orders in rare cases.

short_description: string

Short description

colors: object

Color information

id: integer

Numeric identifier of this product

name: string

Product name

sales_price: object

Pricing information on sales

manufacturer: ProductManufacturer

Manufacturer information

sizechart_image: string

URL of the product size table image

category: string

Category name

images: object

Product images

description: string

Detailed description

price: object

Pricing information

Example
{
  "original_name": "T-Shirt",
  "processing_areas": {
    "data": [
      {
        "position_id": 1,
        "position_name": "front",
        "template_height": 1000,
        "height": 2000,
        "printable_area_margin_from_top": 0,
        "width": 2000,
        "width_in_mm": 100,
        "template": "string",
        "height_in_mm": 100,
        "template_width": 1000
      }
    ]
  },
  "shipping_category": 1,
  "category_id": 5,
  "is_active": "boolean",
  "short_description": "string",
  "colors": {
    "data": [
      {
        "id": 123,
        "color": "Black",
        "is_colored": true,
        "color_hex": "#000000",
        "sizes": [
          {
            "id": 67,
            "size": "XL",
            "is_available": true,
            "sort_position": 1,
            "is_onlocalstock": true
          }
        ]
      }
    ]
  },
  "id": 1,
  "name": "Base product XY",
  "sales_price": {
    "data": [
      {
        "type": "generic"
      }
    ]
  },
  "manufacturer": {
    "id": 123,
    "name": "Musterfirma"
  },
  "sizechart_image": "string",
  "category": "Unisex-Shirts",
  "images": {
    "data": [
      {
        "url": "https://www.example.com/image.jpg",
        "sort_position": 1
      }
    ]
  },
  "description": "string",
  "price": {
    "data": [
      {
        "type": "generic"
      }
    ]
  }
}

OrderShipping: object

created_at: string

Timestamp of creation

is_shipped: boolean

Has the order been shipped yet?

updated_at: string

Timestamp of last update

tracking_code: string

Carrier tracking code

tracking_url: string

Carrier tracking URL

cost: Money

Shipping price

country_code: string

Two letter country code

type: string

Shipping type

Example
{
  "created_at": "2017-01-01 12:34:56",
  "is_shipped": false,
  "updated_at": "2017-01-01 12:34:56",
  "tracking_code": "string",
  "tracking_url": "string",
  "country_code": "DE",
  "type": "delivery"
}

ProductImage: object

url: string

URL of the image file

sort_position: integer

Numerical index used for sorting

Example
{
  "url": "https://www.example.com/image.jpg",
  "sort_position": 1
}

Project: object

processings: object

Processings associated with this project

updated_at: string

Timestamp of last update

is_syncing: array

Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently syncing.

status: string

Project status

created_at: string

Timestamp of initial creation

is_published: boolean

Has the project been published?

name: string

Project name

is_queueing: array

Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently in queue.

reference: string

Unique identifier of this project

type: string

Type

products_count: integer

Number of products

Example
{
  "processings": {
    "data": [
      {
        "method": "print",
        "height": 300,
        "offset_center": 0,
        "area": "front",
        "offset_top": 50,
        "position": "center",
        "design": {
          "height": 3000,
          "is_dark": true,
          "complementary_color": "",
          "preview": "https://example.com/product_prev.png",
          "name": "My cool design",
          "is_processed": true,
          "updated_at": "2017-01-01 12:34:56",
          "colors": 5,
          "palette": [
            "A20061",
            "FFBC42",
            "1C838A",
            "021618",
            "A3AAAB"
          ],
          "original_file": "https://example.com/product.png",
          "filename": "ABCDE",
          "created_at": "2017-01-01 12:34:56",
          "filetype": "png",
          "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
          "width": 5000
        },
        "width": 200,
        "updated_at": "2017-01-01 12:34:56"
      }
    ]
  },
  "updated_at": "2017-01-01 12:34:56",
  "is_syncing": {
    "12": true
  },
  "status": "Finalisiert",
  "created_at": "2017-01-01 12:34:56",
  "is_published": true,
  "name": "My cool project",
  "is_queueing": {
    "12": true
  },
  "reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
  "type": "ondemand",
  "products_count": 3
}

OrderComment: object

id: integer

ID of the order comment

comment: string

Text of the order comment

created_at: string

Timestamp of creation

Example
{
  "id": "integer",
  "comment": "Great communication with customer",
  "created_at": "2017-01-01 12:34:56"
}
Documentation by Spectacle