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/apiRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0
Authentication
cockpit_apikey
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]'.
cockpit_oauth
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.
oauth
This section contains endpoints related to the OAuth2 implementation.
Request access 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
Code received in callback from /oauth/authorize
Client ID (from registration)
Client Secret (from registration)
Success, token issued.
Error.
Error, invalid client (client ID or secret are wrong).
Response Example (200 OK)
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjVjZj...",
"refresh_token": "tYI1iHjH7lGBLlBi+VD6uYYCn3pZo8Do/BSmcgzwTOuZ+f7v/z...",
"token_type": "Bearer",
"expires_in": 31536000
}
Response Example (400 Bad Request)
{
"hint": "string",
"message": "string",
"error": "string"
}
Response Example (401 Unauthorized)
{
"hint": "string",
"message": "string",
"error": "string"
}
user
Endpoints in this section control data of the currently logged in user profile.
Upload a logo to be used on the delivery receipt for your customers
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.
Design file
Success, delivery receipt logo was uploaded
Error, image file does not meet requirements
| cockpit_apikey | |
| cockpit_oauth | write-user |
Delete a sticker assigned to your account or integration
The endpoint returns an empty array with exit code 200.
Unique integration identifier
Success, sticker was deleted
| cockpit_apikey | |
| cockpit_oauth | write-user |
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_company_name: string (up to 30 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_postcode: string (3 to 9 chars)
-
Update 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_country: string
-
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_lastname": "string",
"sender_company_name": "string",
"sender_city": "string",
"sender_postcode": "string",
"sender_firstname": "string",
"sender_country": "string",
"sender_street": "string"
}
User information updated.
Validation of inputs failed.
| cockpit_apikey | |
| cockpit_oauth | write-user |
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.
- is_business: boolean
-
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.
- company_name: string
-
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.
- phone: 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.
- 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.
Request Example
{
"country": "string",
"is_business": "boolean",
"city": "string",
"company_name": "string",
"lastname": "string",
"phone": "string",
"postcode": "string",
"firstname": "string",
"street": "string"
}
User information updated.
Validation of inputs failed.
| cockpit_apikey | |
| cockpit_oauth | write-user |
Get user information
Retrieve information about the currently authenticated user.
Success
Response Example (200 OK)
{
"sender_lastname": "string",
"email": "mustermann@example.com",
"is_billing_valid": true,
"city": "Köln",
"default_hangtag_reference": "ABC123",
"company_name": "Shirtigo GmbH",
"has_orders": true,
"sender_country": "string",
"integration_count": 2,
"display_name": "Max Mustermann",
"is_auto_onhold": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"sender_city": "string",
"sender_title": "string",
"sticker_logo": "https://example.com/custom_logo.png",
"sender_firstname": "string",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"street": "Musterstraße 12",
"default_second_packin_reference": "ABC123",
"country": "Deutschland",
"sender_company_name": "string",
"default_first_packin_reference": "ABC123",
"phone": "004930123456",
"user_group": {
"quantity": 1000,
"id": 1,
"updated_at": "2017-01-01 12:34:56",
"type": "premium",
"cockpit_discount": 20,
"created_at": "2017-01-01 12:34:56"
},
"use_custom_product_name": "true",
"integrations": [
{
"default_first_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"image_type": "png",
"default_product_packaging_reference": "ABC123",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"default_imprint_reference": "ABC123",
"sticker_logo": "https://example.com/custom_logo.png",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"default_label_reference": "ABC123",
"is_pull_orders": "true",
"default_delivery_receipt_logo_reference": "ABC123",
"is_auto_pull_orders": "true",
"id": 111,
"use_custom_product_name": "true",
"expires_in": "2018-01-01 12:34:56",
"image_quality": "high",
"default_sticker_reference": "ABC123",
"name": "my-cool-shirtstore.myshopify.com",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"app": "shopify",
"default_second_packin_reference": "ABC123",
"add_delivery_receipt": true
}
],
"postcode": "12345",
"title": "Dr.",
"add_delivery_receipt": true,
"is_business": "true",
"sender_type": "string",
"sender_postcode": "string",
"lastname": "Mustermann",
"updated_at": "2017-01-01 12:34:56",
"sender_state": "string",
"firstname": "Max",
"sender_street": "string"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
Delete a Logo assigned to your account or integration
The endpoint returns an empty array with exit code 200.
Unique integration identifier
Success, delivery receipt logo was deleted
| cockpit_apikey | |
| cockpit_oauth | write-user |
Get balance for current user
Return a Money object for the users current balance
Success
Response Example (200 OK)
Upload a sticker to be used on the delivery receipt for your customers
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.
Design file
Success, sticker was uploaded
Error, image file does not meet requirements
| cockpit_apikey | |
| cockpit_oauth | write-user |
Update user advanced
Update advanced user settings.
- use_tracking_eu: boolean
-
Update user advanced
Update advanced user settings.
- receives_mail_order_shipped: boolean
-
Update user advanced
Update advanced user settings.
- locale: string
-
Update user advanced
Update advanced user settings.
- default_hangtag_reference: string
-
Update user advanced
Update advanced user settings.
- default_first_packin_reference: string
-
Update user advanced
Update advanced user settings.
- use_custom_product_name: boolean
-
Update user advanced
Update advanced user settings.
- default_order_packaging_reference: string
-
Update user advanced
Update advanced user settings.
- receives_mail_order_placed: boolean
-
Update user advanced
Update advanced user settings.
- default_label_reference: string
-
Update user advanced
Update advanced user settings.
- delivery_receipt_note: string
-
Update user advanced
Update advanced user settings.
- default_imprint_reference: string
-
Update user advanced
Update advanced user settings.
- accounting_email: string
-
Update user advanced
Update advanced user settings.
- customs_email: string
-
Update user advanced
Update advanced user settings.
- use_tracking_world: boolean
-
Update user advanced
Update advanced user settings.
- default_product_packaging_reference: string
-
Update user advanced
Update advanced user settings.
- add_delivery_receipt: boolean
-
Update user advanced
Update advanced user settings.
- use_tracking_de: boolean
-
Update user advanced
Update advanced user settings.
- default_second_packin_reference: string
-
Update user advanced
Update advanced user settings.
Request Example
{
"use_tracking_eu": "boolean",
"receives_mail_order_shipped": "boolean",
"locale": "string",
"default_hangtag_reference": "string",
"default_first_packin_reference": "string",
"use_custom_product_name": "boolean",
"default_order_packaging_reference": "string",
"receives_mail_order_placed": "boolean",
"default_label_reference": "string",
"delivery_receipt_note": "string",
"default_imprint_reference": "string",
"accounting_email": "string",
"customs_email": "string",
"use_tracking_world": "boolean",
"default_product_packaging_reference": "string",
"add_delivery_receipt": "boolean",
"use_tracking_de": "boolean",
"default_second_packin_reference": "string"
}
User information updated.
Validation of inputs failed.
| cockpit_apikey | |
| cockpit_oauth | write-user |
Get all payments
Retrieve all payments issued by the currently authenticated user. The result will be paginated, meta information is included in the response.
Page number
Items per page
Search query
Property to order by
Order direction
Days to show (default: all)
Action to filter for (default: none)
Success
Response Example (200 OK)
{
"data": [
{
"status_title": "Erstattung",
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"payment_reference": "Kreditkarte",
"order": {
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann"
}
}
}
]
}
design
Endpoints in this section manipulate (create, view, modify) designs by the currently logged in user.
Create design from 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.
Design file
Success, all file has been processed
Error, image file does not meet requirements
Response Example (200 OK)
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
Get all designs
Retrieve a paginated list of available designs of the currently authenticated user.
Success
Response Example (200 OK)
{
"data": [
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-design |
Delete design
Only designs by the currently authenticated user may be deleted.
Unique design identifier
Success, design deleted
Design not found
| cockpit_apikey | |
| cockpit_oauth | write-design |
Update design
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.
Unique design identifier
Request Example
{
"name": "string"
}
Success
Design not found
Response Example (200 OK)
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
Get design
Retrieve information about a single design. Only searches designs that are available to the currently authenticated user.
Unique design identifier
Success
Design not found
Response Example (200 OK)
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
| cockpit_apikey | |
| cockpit_oauth | read-design |
Create design from base64-encoded data
Create a new design from the base64-encoded data
The endpoint returns the created design.
- data: string
-
Base64-encoded data
- original_filename: string
-
Original file name (optional)
Request Example
{
"data": "string",
"original_filename": "string"
}
Success, URL has been processed
Error, URL / image file does not meet requirements
Response Example (200 OK)
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
Create design from URL
Create a new design from the submitted URL.
The endpoint returns the created design.
- url: string
-
Design file URL
Request Example
{
"url": "string"
}
Success, URL has been processed
Error, URL / image file does not meet requirements
Response Example (200 OK)
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
product
Endpoints in this section retrieve products available to the currently logged in user.
Create provisional product
Retrieve information for a draft product
Identifier of desired base product
Success
Response Example (200 OK)
{
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"name": "Base product XY",
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Create a CampaignProduct
Add a product to a project from the catalog of available base products.
- colors: integer[]
-
List of colors ids
- price: integer
-
Price in Euro-cents
- base_product_id: integer
-
Identifier of desired base product
- project_id: string
-
Identifier of existing 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
- sort_position: integer
-
Set a sort position for this product within its project
Request Example
{
"colors": [
"212,239"
],
"price": "1999",
"base_product_id": 25,
"project_id": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"custom_name": "My fancy product name",
"sort_position": "1"
}
Success
Project or base product not found
Requirements not fulfilled
Response Example (200 OK)
{
"data": [
{
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
},
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"updated_at": "2017-01-01 12:34:56",
"sort_position": "1",
"has_express": false,
"active_integration_syncs": [
{
"integration_name": "shopify",
"error": "Invalid or missing auth."
}
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get all products
Only return products where rendering is finished.
Success
Response Example (200 OK)
{
"data": [
{
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
},
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"updated_at": "2017-01-01 12:34:56",
"sort_position": "1",
"has_express": false,
"active_integration_syncs": [
{
"integration_name": "shopify",
"error": "Invalid or missing auth."
}
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Delete product
Numerical product identifier
Success, product deleted
Product not found
| cockpit_apikey | |
| cockpit_oauth | write-project |
Update product
Update names, descriptions, prices and add/delete a product of the authenticated user.
- delete_unmentioned_colors: bool
-
Set to true if colors which are stored but do not appear in the request should be deleted. Default: false
- price: integer
-
Gross product price in Euro-cents
- description: string
-
Short description
- colors: integer[]
-
List of color ids
- custom_name: string
-
Product name
- sort_position: integer
-
Set a sort position for this product within its project
Numerical product identifier
Request Example
{
"delete_unmentioned_colors": "bool",
"price": 400,
"description": "string",
"colors": [
"integer"
],
"custom_name": "My cool product",
"sort_position": "1"
}
Success
Product not found
Response Example (200 OK)
{
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
},
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"updated_at": "2017-01-01 12:34:56",
"sort_position": "1",
"has_express": false,
"active_integration_syncs": [
{
"integration_name": "shopify",
"error": "Invalid or missing auth.",
"integration_id": 111,
"integration_product_id": "9286211826"
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get product
Retrieve information on a single product.
Numerical product identifier
Success
Product not found
Response Example (200 OK)
{
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
},
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"updated_at": "2017-01-01 12:34:56",
"sort_position": "1",
"has_express": false,
"active_integration_syncs": [
{
"integration_name": "shopify",
"error": "Invalid or missing auth.",
"integration_id": 111,
"integration_product_id": "9286211826"
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Synchronize integrations
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
Numerical product identifier
Request Example
{
"integrations": [
null
]
}
Success, all integrations processed
| cockpit_apikey | |
| cockpit_oauth | write-project |
base-product
Endpoints in this section retrieve base products available during product creation.
List available categories
Success
Response Example (200 OK)
{
"data": [
{
"id": 10,
"name": "Unisex-Shirts",
"sort_position": 1
}
]
}
Get all base products
Retrieve a list of available base products. Optionally, a category can be passed for filtering.
Filter by category identifier (default: any)
Success
Response Example (200 OK)
{
"data": [
{
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
}
]
}
Get base product
Retrieve information on a single base product.
Numerical base product identifier
Success
Product not found
Response Example (200 OK)
{
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
}
project
Endpoints in this section manipulate (create, view, modify) projects of the currently logged in user.
Publish project
Publish project draft. To be eligible for publication, a project must have at least one product and one print attached to it.
Unique project identifier
Success, project transferred
Project not found
Requirements not fulfilled
| cockpit_apikey | |
| cockpit_oauth | write-project |
Add processing
Add processing information to a single campaign.
Unique project identifier
Request Example
{
"offset_top": 50,
"method": "print",
"offset_center": 0,
"design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"position": "center",
"area": "front",
"width": 200
}
Success
Project not found
| cockpit_apikey | |
| cockpit_oauth | write-project |
Delete project
Delete the selected project.
Unique project identifier
Success, project deleted
Project not found
Project could not be dleted due to problems to delete product integrations
Update project
Change information about a project
- name: string
-
Project name
Unique project identifier
Request Example
{
"name": "My cool project"
}
Success
Project not found
Response Example (200 OK)
{
"status": "Finalisiert",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"updated_at": "2017-01-01 12:34:56",
"is_published": true,
"processings": {
"data": [
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
]
},
"type": "ondemand",
"products_count": 3,
"is_queueing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"name": "My cool project",
"is_syncing": {
"12": true
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Get project
Retrieve information about a single project. Only searches projects that are available to the currently authenticated user.
Unique project identifier
Success
Project not found
Response Example (200 OK)
{
"status": "Finalisiert",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"updated_at": "2017-01-01 12:34:56",
"is_published": true,
"processings": {
"data": [
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
]
},
"type": "ondemand",
"products_count": 3,
"is_queueing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"name": "My cool project",
"is_syncing": {
"12": true
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Get products for a project
Retrieve information about the products for a single project. Only searches projects that are available to the currently authenticated user.
Unique project identifier
Success
Project not found
Response Example (200 OK)
[
{
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
},
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"updated_at": "2017-01-01 12:34:56",
"sort_position": "1",
"has_express": false,
"active_integration_syncs": [
{
"integration_name": "shopify",
"error": "Invalid or missing auth.",
"integration_id": 111
}
]
}
]
| cockpit_apikey | |
| cockpit_oauth | read-project |
Synchronize integrations
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
Unique project identifier
Request Example
{
"integrations": [
null
]
}
Success, all integrations processed
| cockpit_apikey | |
| cockpit_oauth | write-project |
Remove processing
Remove processing from specified processing area.
Unique project identifier
Processing site to remove
Processing position to remove
Success
Campaign or processing not found
| cockpit_apikey | |
| cockpit_oauth | write-project |
Update processing
Update processing information on a single campaign.
Unique project identifier
Processing site to remove
Processing position to remove
Request Example
{
"offset_top": 50,
"method": "print",
"offset_center": 0,
"design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"position": "center",
"area": "front",
"width": 200
}
Success
Project not found
| cockpit_apikey | |
| cockpit_oauth | write-campaign |
Create Project
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"
}
Success
Response Example (200 OK)
{
"status": "Finalisiert",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"updated_at": "2017-01-01 12:34:56",
"is_published": true,
"processings": {
"data": [
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
]
},
"type": "ondemand",
"products_count": 3,
"is_queueing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"name": "My cool project",
"is_syncing": {
"12": true
}
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get all projects
Retrieve all projects available for the currently authenticated user. The projects are automatically paginated, meta information is included in the response.
Current page
Number of items per page
Column used to sort the results. You can sort by: name, reference, url, default_preview_position, created_at, updated_at
Direction for sorting
Success
Response Example (200 OK)
{
"data": [
{
"status": "Finalisiert",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"updated_at": "2017-01-01 12:34:56",
"is_published": true,
"processings": {
"data": [
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
]
},
"type": "ondemand",
"products_count": 3,
"is_queueing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"name": "My cool project",
"is_syncing": {
"12": true
}
}
],
"meta": {
"pagination": {
"count": 10,
"total_pages": 4,
"total": 32,
"current_page": 2,
"per_page": 10,
"links": {
"next": "string",
"previous": "string"
}
}
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
order
Endpoints in this section retrieve information about issued orders.
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.
- 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.
- packins: object[]
-
Selected packins (optional)
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- 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.
- products: object[]
-
Selected products
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
Request Example
{
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"packins": [
{
"product_packaging_reference": "A12345",
"imprint_reference": "A12345",
"first_packin_reference": "A12345",
"label_reference": "A12345",
"sticker_reference": "A12345",
"order_packaging_reference": "A12345",
"hangtag_reference": "A12345",
"second_packin_reference": "A12345"
}
],
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"products": [
{
"productId": 235,
"sizeId": 1,
"amount": 1,
"colorId": 326
}
],
"add_delivery_receipt": "true",
"is_onhold": "true",
"delivery_receipt_logo_reference": "ABC123"
}
Success, order has been created
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (201 Created)
{
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | write-order |
Get all orders
Retrieve all orders issued by the currently authenticated user. The result will be paginated, meta information is included in the response.
Page number
Filter by order status id
Items per page
Search query
Property to order by
Order direction
Days to show (default: all)
Secondary filter level (e.g. filter reprint orders)
Success
Response Example (200 OK)
{
"data": [
{
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
}
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-order |
Set onhold
Orders with Flag Onhold will not be send to production until flag is released. Orders can be set to onhold until they are pushed to production
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
Retry payment
Set the order payment method to the current user's payment method and retry credit card capture.
Alphanumerical order identifier
Success, order has been paid.
Payment failed (either duplicate payment or an error occured).
| cockpit_apikey | |
| cockpit_oauth | read-order |
Cancel order
Set the order status to canceled.
Alphanumerical order identifier
Success, order has been canceled.
Order not found
| cockpit_apikey | |
| cockpit_oauth | write-order |
Calculate 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.
- 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.
- packins: object[]
-
Selected packins (optional)
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- 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.
- products: object[]
-
Selected products
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
Request Example
{
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"packins": [
{
"product_packaging_reference": "A12345",
"imprint_reference": "A12345",
"first_packin_reference": "A12345",
"label_reference": "A12345",
"sticker_reference": "A12345",
"order_packaging_reference": "A12345",
"hangtag_reference": "A12345",
"second_packin_reference": "A12345"
}
],
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"products": [
{
"productId": 235,
"sizeId": 1,
"amount": 1,
"colorId": 326
}
],
"add_delivery_receipt": "true",
"is_onhold": "true",
"delivery_receipt_logo_reference": "ABC123"
}
Success, price has been calculated
Validation failed, details in response body
Response Example (200 OK)
{
"included_tax_rate": 19
}
Get coupon info
Retrieve information about a single order coupon.
Alphanumerical coupon identifier as provided to the customer
Success
Coupon not found
Response Example (200 OK)
| cockpit_apikey | |
| cockpit_oauth | read-order |
Release onhold
Orders with Flag Onhold will not be send to production until flag is released. Only Orders having completely rendered Images can be released.
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
Create order comment
Creates a new comment for a given order. Expects the comment text.
Alphanumerical order identifier
Success, comment has been created.
Order not found
| cockpit_apikey | |
| cockpit_oauth | write-order |
Get order
Retrieve information about a single order. Only orders visible by the currently authenticated user may be retrieved.
Alphanumerical order identifier
Success
Order not found
Response Example (200 OK)
{
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-order |
Create Quick-Order
Create a design, a product and place an order - in a single step.
- sender: OrderAddress
-
Create Quick-Order
Create a design, a product and place an order - in a single step.
- packins: object[]
-
Selected packins (optional)
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- jobs: object[]
-
Processing jobs
- delivery: OrderAddress
-
Create Quick-Order
Create a design, a product and place an order - in a single step.
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
Request Example
{
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"packins": [
{
"product_packaging_reference": "A12345",
"imprint_reference": "A12345",
"first_packin_reference": "A12345",
"label_reference": "A12345",
"sticker_reference": "A12345",
"order_packaging_reference": "A12345",
"hangtag_reference": "A12345",
"second_packin_reference": "A12345"
}
],
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"jobs": [
{
"base_products": [
{
"colors": [
{
"id": 326,
"sizes": [
{
"id": 1,
"amount": "integer"
}
]
}
],
"id": 235
}
],
"processings": [
{
"offset_top": 50,
"method": "print",
"offset_center": 0,
"design": {
"url": "https://myurl/myimage.png"
},
"position": "center",
"area": "front",
"width": 200
}
]
}
],
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"add_delivery_receipt": "true",
"delivery_receipt_logo_reference": "ABC123"
}
Success, order has been created
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (201 Created)
{
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | write-order |
other
This section contains miscellaneous endpoints.
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.
Success
Response Example (200 OK)
{
"week_amount": 3,
"total_amount": 36,
"month_amount": 14,
"today_amount": 1
}
Calculate production cost
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?
- product_id: integer
-
Desired base product
- printareas: integer[]
-
Desired print areas
Request Example
{
"is_colored": true,
"product_id": 375,
"printareas": [
"integer"
]
}
Success
Product not found
Response Example (200 OK)
Get delivery targets
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.
Success
Response Example (200 OK)
{
"data": [
{
"name": "Germany",
"iso": "DE"
}
]
}
orderProduct
Customize OrderProduct
Customize an existing OrderProduct for the currently authenticated user.
Reference of design
Processingarea to be customized. 1 = front, 2 = back
Width of design in millimeter
Offset to collar in millimeter
x-shift to centerline in millimeter
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
UserIntegration
Get order-reference Get shirtigo order reference for given integrationId and integration orderId
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
Schema Definitions
ProjectPrint: object
- offset_top: integer
-
Vertical offset from top in millimeters
- height: integer
-
Design height in millimeters
- method: string
-
Processing method
- updated_at: string
-
Timestamp of last update
- offset_center: integer
-
Horizontal offset from center in millimeters
- design: Design
- position: string
-
Processing position
- area: string
-
Processing site
- width: integer
-
Design width in millimeters
Example
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
Country: object
- name: string
-
Country name
- iso: string
-
Two-letter identifier according to ISO 3166-1
Example
{
"name": "Germany",
"iso": "DE"
}
Product: object
- short_description: string
-
Short description
- images: object
-
Product images
- price: object
-
Pricing information
- description: string
-
Detailed description
- colors: object
-
Color information
- sales_price: object
-
Pricing information on sales
- sizechart_image: string
-
URL of the product size table image
- category: string
-
Category name
- id: integer
-
Numeric identifier of this product
- shipping_category: integer
-
Shipping category
- is_active: boolean
-
Activation status. Base products may not be available for orders in rare cases.
- category_id: integer
-
Numerical category identifier
- original_name: string
-
Base product name
- name: string
-
Product name
- processing_areas: object
-
Available processing areas
- manufacturer: ProductManufacturer
-
Manufacturer information
Example
{
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
}
ProjectWithProducts:
Example
{
"products": [
{
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000
}
]
}
}
],
"status": "Finalisiert",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"updated_at": "2017-01-01 12:34:56",
"is_published": true,
"processings": {
"data": [
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
]
},
"type": "ondemand",
"products_count": 3,
"is_queueing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"name": "My cool project",
"is_syncing": {
"12": true
}
}
ProvisionalProduct: object
- colors: ProductColor
-
List of available colors
- price: Money
-
Net price
- name: string
-
Product name
- description: string
-
Short description
- base_product: Product
-
Base product
Example
{
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"name": "Base product XY",
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
}
}
OrderShipping: object
- created_at: string
-
Timestamp of creation
- cost: Money
-
Shipping price
- updated_at: string
-
Timestamp of last update
- type: string
-
Shipping type
- tracking_url: string
-
Carrier tracking URL
- country_code: string
-
Two letter country code
- is_shipped: boolean
-
Has the order been shipped yet?
- tracking_code: string
-
Carrier tracking code
Example
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
}
OrderProduct: object
- net_unit_price: Money
-
Net unit price
- id: integer
-
Product id
- net_total_price: Money
-
Total price (net_unit_price*amount)
- color: string
-
Color name
- amount: integer
-
Number of items
- campaign_name: string
-
Name of the campaign
- images: UtilProductImage
-
Available image URLs
- size: string
-
Size name
- campaign_product_id: int
-
ID of the campaign product
- name: string
-
Product name
- campaign_reference: string
-
Reference of the campaign
Example
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
ProductDimensions: object
- height: integer
-
Height in mm
- size: string
-
Product size name
- width: integer
-
Width in mm
Example
{
"height": 500,
"size": "XL",
"width": 200
}
CampaignIntegrationProduct: object
- updated_at: string
-
Timestamp of last update
- integration_product_id: string
-
The identifier used by the integration application
- integration_id: integer
-
The cockpit internal id of the used user integration
Example
{
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826",
"integration_id": 111
}
Order: object
- total_items: integer
-
Total number of items in the order
- fulfillment: object
-
Fulfillment details or
falseif no details are available - vat_amount: Money
-
VAT amount
- shipping: OrderShipping
-
Details on the shipping method, status and tracking (only present if order is being or has been shipped)
- net_price: Money
-
Total net price of this order
- delivery_receipt_logo_reference: string
-
Media reference for the logo added to delivery_receipt
- reference: string
-
Unique identifier of this order
- vat_rate: integer
-
VAT rate in percent
- status: string
-
Human readable order status
- packins: object
-
Array of packins and hangtags in this order
- created_at: string
-
Timestamp of creation
- orderStatusEntries: object
-
Array of status messages associated with this order
- products: object
-
Array of products in this order
- use_custom_product_name: boolean
-
Use custom product name on delivery receipt
- status_key: string
-
Number of products
- bill: OrderAddress
-
Billing address
- sender: OrderAddress
-
Sender address
- delivery_receipt_note: string
-
Custom note on delivery receipt
- delivery: OrderAddress
-
Delivery address
- updated_at: string
-
Timestamp of last update
- gross_price: Money
-
Total gross price of this order
- invoice_reference: string
-
Invoice reference
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to order
- payments: object
-
Array of payments associated with this order
Example
{
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"updated_at": "2017-01-01 12:34:56",
"invoice_reference": "string"
}
User: object
- sender_lastname: string
- email: string
-
Email address
- is_billing_valid: boolean
-
Have billing options been filled out?
- city: string
-
City, used for billing
- default_hangtag_reference: string
-
Default hangtag added to all textil products of orders placed via dashboard (optional)
- company_name: string
-
Company name
- has_orders: boolean
-
Does user have orders?
- sender_country: string
- integration_count: number
-
Number of active integrations
- display_name: string
-
Display name, e.g. first + last name
- is_auto_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- delivery_receipt_note: string
-
Custom note on delivery receipt
- default_delivery_receipt_logo_reference: string
-
Default delivery receipt logo used for orders placed via dashboard
- sender_city: string
- sender_title: string
- sticker_logo: string
-
Url to custom sticker logo for orders placed via dashboard (optional)
- sender_firstname: string
- delivery_receipt_logo: string
-
Url to custom logo added to delivery slip and shipping lable for orders placed via dashboard
- street: string
-
Street and number, used for billing
- default_second_packin_reference: string
-
Default second packin added to orders placed via dashboard (optional)
- country: string
-
Country, used for billing
- sender_company_name: string
- default_first_packin_reference: string
-
Default first packin added to orders placed via dashboard (optional)
- phone: string
-
Phone nubmer
- user_group: UserGroup
- use_custom_product_name: boolean
-
Indicates if custom product name is used on delivery receipt
- integrations: UserIntegration
-
List of integrations (connected applications) for this user
- postcode: string
-
ZIP code, used for billing
- title: string
-
(Academical) title
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to orders received via this intergrations
- is_business: boolean
-
Is a business customer
- sender_type: string full, company, legacy
- sender_postcode: string
- lastname: string
-
Last name
- updated_at: string
-
Timestamp of last update
- sender_state: string
- firstname: string
-
First name(s)
- sender_street: string
Example
{
"sender_lastname": "string",
"email": "mustermann@example.com",
"is_billing_valid": true,
"city": "Köln",
"default_hangtag_reference": "ABC123",
"company_name": "Shirtigo GmbH",
"has_orders": true,
"sender_country": "string",
"integration_count": 2,
"display_name": "Max Mustermann",
"is_auto_onhold": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"sender_city": "string",
"sender_title": "string",
"sticker_logo": "https://example.com/custom_logo.png",
"sender_firstname": "string",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"street": "Musterstraße 12",
"default_second_packin_reference": "ABC123",
"country": "Deutschland",
"sender_company_name": "string",
"default_first_packin_reference": "ABC123",
"phone": "004930123456",
"user_group": {
"quantity": 1000,
"id": 1,
"updated_at": "2017-01-01 12:34:56",
"type": "premium",
"cockpit_discount": 20,
"created_at": "2017-01-01 12:34:56"
},
"use_custom_product_name": "true",
"integrations": [
{
"default_first_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"image_type": "png",
"default_product_packaging_reference": "ABC123",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"default_imprint_reference": "ABC123",
"sticker_logo": "https://example.com/custom_logo.png",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"default_label_reference": "ABC123",
"is_pull_orders": "true",
"default_delivery_receipt_logo_reference": "ABC123",
"is_auto_pull_orders": "true",
"id": 111,
"use_custom_product_name": "true",
"expires_in": "2018-01-01 12:34:56",
"image_quality": "high",
"default_sticker_reference": "ABC123",
"name": "my-cool-shirtstore.myshopify.com",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"app": "shopify",
"default_second_packin_reference": "ABC123",
"add_delivery_receipt": true
}
],
"postcode": "12345",
"title": "Dr.",
"add_delivery_receipt": true,
"is_business": "true",
"sender_type": "string",
"sender_postcode": "string",
"lastname": "Mustermann",
"updated_at": "2017-01-01 12:34:56",
"sender_state": "string",
"firstname": "Max",
"sender_street": "string"
}
OrderPayment: object
- id: string
-
Unique transaction identifier
- updated_at: string
-
Timestamp of last update
- type: string
-
Payment type
- status_details: string
-
Payment error description (if there is any)
- vat_rate: integer
-
VAT rate in percent
- net_amount: Money
-
Net price
- status: string
-
Payment status
- vat_amount: Money
-
VAT amount
- gross_amount: Money
-
Gross price
Example
{
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"updated_at": "2017-01-01 12:34:56",
"type": "creditcard",
"status_details": "An error occured.",
"vat_rate": 19,
"status": "paid"
}
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
}
UserIntegration: object
- default_first_packin_reference: string
-
Default first packin added to orders received via this intergrations (optional)
- default_hangtag_reference: string
-
Default hangtag added to 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)
- image_type: string
-
Type of image transfered to external shop
- default_product_packaging_reference: string
-
Default packaging used for all textil products of orders received via this intergrations (optional)
- reference: uuid
-
Reference of the integration
- default_imprint_reference: string
-
Default imprinted added to all tagless textil products of orders received via this intergrations (optional)
- sticker_logo: string
-
Url to custom sticker logo for 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)
- default_label_reference: string
-
Default label added to all textil products of orders received via this intergrations (optional)
- is_pull_orders: boolean
-
Flag if manually reimporting of orders is enabled.
- default_delivery_receipt_logo_reference: string
-
Default delivery receipt logo used for orders received via this intergrations (optional)
- is_auto_pull_orders: boolean
-
Flag if automatically reimporting of orders is enabled.
- id: integer
-
The internal cockpit id of the used user integration
- use_custom_product_name: boolean
-
Indicates if custom product name is used on delivery receipt
- expires_in: string
-
Date of expire
- image_quality: string
-
Quality of image transfered to external shop
- default_sticker_reference: string
-
Default sticker applied to packaging of orders received via this intergrations (optional)
- name: string
-
The name of the integration, i.e. the shop URL
- delivery_receipt_note: string
-
Custom note on delivery receipt
- app: string
-
Name of the integration application
- default_second_packin_reference: string
-
Default second packin added to orders received via this intergrations (optional)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to orders received via this intergrations
Example
{
"default_first_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"image_type": "png",
"default_product_packaging_reference": "ABC123",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"default_imprint_reference": "ABC123",
"sticker_logo": "https://example.com/custom_logo.png",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"default_label_reference": "ABC123",
"is_pull_orders": "true",
"default_delivery_receipt_logo_reference": "ABC123",
"is_auto_pull_orders": "true",
"id": 111,
"use_custom_product_name": "true",
"expires_in": "2018-01-01 12:34:56",
"image_quality": "high",
"default_sticker_reference": "ABC123",
"name": "my-cool-shirtstore.myshopify.com",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"app": "shopify",
"default_second_packin_reference": "ABC123",
"add_delivery_receipt": true
}
UtilProductImage: object
- area: string
-
Processing area name
- color: string
-
Color name
- urls: object
-
Product name
Example
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
ProductManufacturer: object
- id: integer
-
Numerical identifier
- name: string
-
Manufacturer name
Example
{
"id": 123,
"name": "Musterfirma"
}
CampaignProduct: object
- project: string
-
Project reference
- images: UtilProductImage
-
Product images
- description: string
-
Short description in HTML format
- price: Money
-
Net price
- base_product: Product
-
Base product
- colors: ProductColor
-
List of available colors
- updated_at: string
-
Timestamp of last update
- sort_position: integer
-
Set a sort position for this product within its project
- has_express: boolean
-
Is the product available for express processing?
- active_integration_syncs: CampaignProductIntegrationSync
-
List of currently active synchronizations with integrations
- id: integer
-
Numerical identifier
- integration_products: CampaignIntegrationProduct
-
List of integration products (e.g. products in shopify) for this products
- is_rendered: boolean
-
Has the product been rendered?
- custom_name: string
-
User defined product name
- is_available: boolean
-
Is the product available?
- name: string
-
Product name
- project_name: string
-
Project name
- integration_sync_log: CampaignProductIntegrationSync
-
History of synchronizations with integrations for this product
Example
{
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"description": "string",
"base_product": {
"short_description": "string",
"images": {
"data": [
{
"url": "https://www.example.com/image.jpg",
"sort_position": 1
}
]
},
"price": {
"data": [
{
"type": "generic"
}
]
},
"description": "string",
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
]
},
"sales_price": {
"data": [
{
"type": "generic"
}
]
},
"sizechart_image": "string",
"category": "Unisex-Shirts",
"id": 1,
"shipping_category": 1,
"is_active": "boolean",
"category_id": 5,
"original_name": "T-Shirt",
"name": "Base product XY",
"processing_areas": {
"data": [
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
]
},
"manufacturer": {
"id": 123,
"name": "Musterfirma"
}
},
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
],
"updated_at": "2017-01-01 12:34:56",
"sort_position": "1",
"has_express": false,
"active_integration_syncs": [
{
"integration_name": "shopify",
"error": "Invalid or missing auth.",
"integration_id": 111,
"integration_product_id": "9286211826",
"updated_at": "2017-01-01 12:34:56"
}
]
}
UserPackin: object
- preview_path: string
-
Path to packin preview
- stocking_costs: Money
-
Daily costs for stocking packin
- height_mm: integer
-
Height of the packin in millimeter
- color_ids: string
-
Array of product color ids for which imprint or label will be applied
- initial_inventory: integer
-
Initial stock level of packin
- inventory: integer
-
Actual stock level of packin
- reference: ABC123
-
Packin reference
- width_mm: integer
-
Width of the packin in millimeter
- is_active: boolean
-
Packins receives status is_active, when article is checked and warehoused
- weight_gram: integer
-
Weight of one single packin in gram
- size_id: integer
-
Product size ID for which imprint will be applied
- type: string
-
Packin type (packin or hangtag)
- position: string
-
Position of Label
- name: string
-
Packin name
Example
{
"preview_path": "https://s3.amazon.com/preview.png",
"stocking_costs": 50,
"height_mm": "100",
"color_ids": "['147','157']",
"initial_inventory": "1000",
"inventory": "1000",
"reference": "ABC123",
"width_mm": "100",
"is_active": "true",
"weight_gram": "10",
"size_id": "3",
"type": "packin",
"position": "seam-left",
"name": "Greetings card"
}
UserGroup: object
- quantity: integer
-
Required number of sold products
- id: integer
-
Numerical group identifier
- updated_at: string
-
Timestamp of last update
- type: string
-
Group name
- cockpit_discount: integer
-
Discount in percent
- created_at: string
-
Timestamp of creation
Example
{
"quantity": 1000,
"id": 1,
"updated_at": "2017-01-01 12:34:56",
"type": "premium",
"cockpit_discount": 20,
"created_at": "2017-01-01 12:34:56"
}
Design: object
- preview: string
-
URL to preview image
- filetype: string
-
Extension of the design file name
- is_processed: boolean
-
Has the design been rendered?
- is_dark: boolean
-
Is this a design with dark colors?
- height: integer
-
Height of the design file in pixels
- colors: integer
-
Total number of colors in the color palette
- updated_at: string
-
Timestamp of last update
- complementary_color: string
-
Complementary color
- original_file: string
-
URL to full resolution image
- name: string
-
Design Name
- created_at: string
-
Timestamp of creation
- reference: string
-
Unique identifier of this design
- filename: string
-
Design file name
- width: integer
-
Width of the design file in pixels
- palette: string[]
-
List of hex-codes of representative colors
Example
{
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
}
OrderPackin: object
Example
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
Project: object
- status: string
-
Project status
- reference: string
-
Unique identifier of this project
- updated_at: string
-
Timestamp of last update
- is_published: boolean
-
Has the project been published?
- processings: object
-
Processings associated with this project
- type: string
-
Type
- products_count: integer
-
Number of products
- is_queueing: array
-
Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently in queue.
- created_at: string
-
Timestamp of initial creation
- name: string
-
Project name
- is_syncing: array
-
Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently syncing.
Example
{
"status": "Finalisiert",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"updated_at": "2017-01-01 12:34:56",
"is_published": true,
"processings": {
"data": [
{
"offset_top": 50,
"height": 300,
"method": "print",
"updated_at": "2017-01-01 12:34:56",
"offset_center": 0,
"design": {
"preview": "https://example.com/product_prev.png",
"filetype": "png",
"is_processed": true,
"is_dark": true,
"height": 3000,
"colors": 5,
"updated_at": "2017-01-01 12:34:56",
"complementary_color": "",
"original_file": "https://example.com/product.png",
"name": "My cool design",
"created_at": "2017-01-01 12:34:56",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"width": 5000,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
]
},
"position": "center",
"area": "front",
"width": 200
}
]
},
"type": "ondemand",
"products_count": 3,
"is_queueing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"name": "My cool project",
"is_syncing": {
"12": true
}
}
OrderComment: object
- created_at: string
-
Timestamp of creation
- id: integer
-
ID of the order comment
- comment: string
-
Text of the order comment
Example
{
"created_at": "2017-01-01 12:34:56",
"id": "integer",
"comment": "Great communication with customer"
}
OAuthServerException: object
- hint: string
-
A helper hint.
- message: string
-
Human readable error message.
- error: string
-
Machine readable error type.
Example
{
"hint": "string",
"message": "string",
"error": "string"
}
ProductProcessingArea: object
- height: integer
-
Height of the printarea in pixels
- position_id: integer
-
Numerical identifier
- height_in_mm: integer
-
Height of the printarea in millimeters
- width_in_mm: integer
-
Width of the printarea in millimeters
- template_height: integer
-
Default template height
- template: string
-
Template
- template_width: integer
-
Default template width
- printable_area_margin_from_top: integer
-
Distance between top and processable area top
- position_name: string
-
Name of the printarea
- width: integer
-
Width of the printarea in pixels
Example
{
"height": 2000,
"position_id": 1,
"height_in_mm": 100,
"width_in_mm": 100,
"template_height": 1000,
"template": "string",
"template_width": 1000,
"printable_area_margin_from_top": 0,
"position_name": "front",
"width": 2000
}
OrderStatusEntry: object
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
- status: string
-
Human readable status
- description: integer
-
Verbose status description
- key: string
-
Order status key
Example
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
Processing: object
Processing to apply
- offset_top: integer
-
Vertical offset from top in millimeters
- method: string center
-
Processing method
- offset_center: integer
-
Horizontal offset from center in millimeters
- design: string
-
Design reference
- position: string center
-
Processing position
- area: string
-
Processing area
- width: string 120
-
Design width in millimeters
Example
{
"offset_top": 50,
"method": "print",
"offset_center": 0,
"design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"position": "center",
"area": "front",
"width": 200
}
OrderAddress: object
Address
- country: string
-
A country iso-code (ISO 3166-1 alpha2) as listed in the /delivery-countries endpoint
- company: string
-
Company name
- lastname: string
-
Last name
- city: string
-
City
- postcode: string
-
ZIP/area code
- firstname: string
-
First name
- title: string
-
(Academic) title
- street: string
-
Street and number
Example
{
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
}
OrderRelation: object
- total_items: integer
-
Total number of items in the order
- reference: string
-
Unique identifier of this order
- status: string
-
Human readable order status
- vat_rate: integer
-
VAT rate in percent
- vat_amount: Money
-
VAT amount
- status_key: string
-
Number of products
- gross_price: Money
-
Total gross price of this order
- created_at: string
-
Timestamp of creation
- net_price: Money
-
Total net price of this order
- updated_at: string
-
Timestamp of last update
Example
{
"total_items": 5,
"reference": "ABCDXY1",
"status": "Bestellung offen",
"vat_rate": 19,
"status_key": "",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
Pagination: object
Pagination information
- count: integer
-
Number of items on current page
- total_pages: integer
-
Total number of pages
- total: integer
-
Total number of items
- current_page: integer
-
Index of current page
- per_page: integer
-
Default number of items per page
- links: object
-
URLs of adjacent pages
Example
{
"count": 10,
"total_pages": 4,
"total": 32,
"current_page": 2,
"per_page": 10,
"links": {
"next": "string",
"previous": "string"
}
}
Payment: object
- status_title: string
-
Payment description
- id: string
-
Unique transaction identifier
- payment_reference: string
-
Payment reference
- order: Order
-
Order
- vat_rate: integer
-
VAT rate in percent
- net_amount: Money
-
Net price
- status: string
-
Payment type
- vat_amount: Money
-
VAT amount
- created_at: string
-
Timestamp of creation
- gross_amount: Money
-
Gross price
Example
{
"status_title": "Erstattung",
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"payment_reference": "Kreditkarte",
"order": {
"total_items": 5,
"fulfillment": {},
"shipping": {
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"type": "delivery",
"tracking_url": "string",
"country_code": "DE",
"is_shipped": false,
"tracking_code": "string"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"vat_rate": 19,
"status": "Bestellung offen",
"packins": {
"data": [
{
"id": "integer",
"net_total_price": 75,
"amount": 1,
"type": "hangtag",
"name": "Greeting card"
}
]
},
"created_at": "2017-01-01 12:34:56",
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"status": "string",
"description": "integer",
"key": "string"
}
]
},
"products": {
"data": [
{
"id": "integer",
"net_total_price": 1375,
"color": "Black",
"amount": 1,
"campaign_name": "Example Project",
"images": [
{
"area": "front",
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
],
"size": "XL",
"campaign_product_id": "123",
"name": "Base product XY",
"campaign_reference": "F7S33M2"
}
]
},
"use_custom_product_name": "true",
"status_key": "",
"bill": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"sender": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max",
"title": "Dr.",
"street": "Musterstraße 12"
},
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"delivery": {
"country": "DE",
"company": "Shirtigo GmbH",
"lastname": "Mustermann",
"city": "Köln",
"postcode": "12345",
"firstname": "Max"
}
}
}
ProductColor: object
- id: integer
-
Numerical identifier
- color: string
-
Color name
- color_hex: string
-
Hexadecimal RGB color value
- sizes: object[]
-
Available sizes
- is_colored: boolean
-
Is this a non trivial (b/w) color?
Example
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
],
"is_colored": true
}
CampaignProductIntegrationSync: object
- integration_name: string
-
Name of the integration application
- error: string
-
Error message
- 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
- in_queue: boolean
-
Is the current sync-process still in queue?
- is_successful: boolean
-
Has the product been rendered?
- is_syncing: boolean
-
Is the product available?
Example
{
"integration_name": "shopify",
"error": "Invalid or missing auth.",
"integration_id": 111,
"integration_product_id": "9286211826",
"updated_at": "2017-01-01 12:34:56",
"in_queue": true,
"is_successful": true,
"is_syncing": true
}
ProductPrice: object
- type: string
-
Variant
- price: Money
-
Price
Example
{
"type": "generic"
}