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_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.
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]'.
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)
{
"expires_in": 31536000,
"refresh_token": "tYI1iHjH7lGBLlBi+VD6uYYCn3pZo8Do/BSmcgzwTOuZ+f7v/z...",
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjVjZj...",
"token_type": "Bearer"
}
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.
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.
- 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.
- postcode: 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.
- 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.
- street: string
-
Update user information
Update (some) fields of the currently authenticated user profile.
- phone: string
-
Update user information
Update (some) fields of the currently authenticated user profile.
Request Example
{
"firstname": "string",
"city": "string",
"company_name": "string",
"postcode": "string",
"lastname": "string",
"country": "string",
"is_business": "boolean",
"street": "string",
"phone": "string"
}
User information updated.
Validation of inputs failed.
| cockpit_apikey | |
| cockpit_oauth | write-user |
Get user information
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: integrations, billingMethod, availableBillingMethods
Success
Response Example (200 OK)
{
"user_group": {
"type": "premium",
"id": 1,
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"quantity": 1000,
"cockpit_discount": 20
},
"sender_street": "string",
"add_delivery_receipt": true,
"sender_state": "string",
"lastname": "Mustermann",
"default_second_packin_reference": "ABC123",
"sender_firstname": "string",
"integrations": [
null
],
"has_orders": true,
"sender_lastname": "string",
"phone": "004930123456",
"sender_type": "string",
"use_custom_product_name": "true",
"default_delivery_receipt_logo_reference": "ABC123",
"city": "Köln",
"is_billing_valid": true,
"is_business": "true",
"sender_country": "string",
"default_first_packin_reference": "ABC123",
"street": "Musterstraße 12",
"default_hangtag_reference": "ABC123",
"title": "Dr.",
"company_name": "Shirtigo GmbH",
"postcode": "12345",
"sender_title": "string",
"is_auto_onhold": true,
"display_name": "Max Mustermann",
"sender_city": "string",
"email": "mustermann@example.com",
"sender_postcode": "string",
"firstname": "Max",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"country": "Deutschland",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"updated_at": "2017-01-01 12:34:56",
"sticker_logo": "https://example.com/custom_logo.png",
"sender_company_name": "string",
"integration_count": 2
}
| 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 |
Update user advanced
Update advanced user settings.
- accounting_email: string
-
Update user advanced
Update advanced user settings.
- use_tracking_world: boolean
-
Update user advanced
Update advanced user settings.
- default_imprint_reference: string
-
Update user advanced
Update advanced user settings.
- default_first_packin_reference: string
-
Update user advanced
Update advanced user settings.
- default_product_packaging_reference: string
-
Update user advanced
Update advanced user settings.
- default_second_packin_reference: string
-
Update user advanced
Update advanced user settings.
- default_hangtag_reference: string
-
Update user advanced
Update advanced user settings.
- locale: string
-
Update user advanced
Update advanced user settings.
- customs_email: string
-
Update user advanced
Update advanced user settings.
- add_delivery_receipt: boolean
-
Update user advanced
Update advanced user settings.
- receives_mail_order_shipped: boolean
-
Update user advanced
Update advanced user settings.
- default_order_packaging_reference: string
-
Update user advanced
Update advanced user settings.
- use_custom_product_name: boolean
-
Update user advanced
Update advanced user settings.
- use_tracking_eu: boolean
-
Update user advanced
Update advanced user settings.
- default_label_reference: string
-
Update user advanced
Update advanced user settings.
- use_tracking_de: boolean
-
Update user advanced
Update advanced user settings.
- delivery_receipt_note: string
-
Update user advanced
Update advanced user settings.
- receives_mail_order_placed: boolean
-
Update user advanced
Update advanced user settings.
Request Example
{
"accounting_email": "string",
"use_tracking_world": "boolean",
"default_imprint_reference": "string",
"default_first_packin_reference": "string",
"default_product_packaging_reference": "string",
"default_second_packin_reference": "string",
"default_hangtag_reference": "string",
"locale": "string",
"customs_email": "string",
"add_delivery_receipt": "boolean",
"receives_mail_order_shipped": "boolean",
"default_order_packaging_reference": "string",
"use_custom_product_name": "boolean",
"use_tracking_eu": "boolean",
"default_label_reference": "string",
"use_tracking_de": "boolean",
"delivery_receipt_note": "string",
"receives_mail_order_placed": "boolean"
}
User information updated.
Validation of inputs failed.
| cockpit_apikey | |
| cockpit_oauth | write-user |
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.
- sender_company_name: string (up to 30 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_postcode: string (3 to 9 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_firstname: string (up to 20 chars)
-
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_city: string (up to 30 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
Request Example
{
"sender_country": "string",
"sender_street": "string",
"sender_company_name": "string",
"sender_postcode": "string",
"sender_firstname": "string",
"sender_lastname": "string",
"sender_city": "string"
}
User information updated.
Validation of inputs failed.
| 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 |
Get balance for current user
Return a Money object for the users current balance
Success
Response Example (200 OK)
{
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
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 |
Get all transactions
Retrieve all accounting transactions 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": [
{
"payment_reference": "Kreditkarte",
"vat_rate": 19,
"status": "invoice",
"order": {
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL"
}
]
}
}
}
]
}
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 |
design
Endpoints in this section manipulate (create, view, modify) designs by the currently logged in user.
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",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
| 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",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
| 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",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-design |
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",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
| cockpit_apikey | |
| cockpit_oauth | write-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 |
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",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
| cockpit_apikey | |
| cockpit_oauth | read-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",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
product
Endpoints in this section retrieve customized products available to the currently logged in user.
DEPRECATED: Create provisional product
This endpoint is deprecated. Use the customized-product endpoint instead. (Retrieve information for a draft product.)
Identifier of desired base product
Success
Response Example (200 OK)
{
"description": "string",
"name": "Base product XY",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"colors": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Update product colors
Use this endpoint to update an existing product. The product can be customized on the baseProduct color level similar to the create endpoint. Each processing can be associated to one or many colorIds. Multiple processings can be added. Instead of the complete processing information (design, width, position info) it is possible to pass a baseProduct color id as a referenceColorId. In this case all processing information is created based on the existing processings for the reference color.
- processings: object[]
-
List of processings to add / update
Request Example
{
"processings": [
{
"processingposition": "chest-center",
"force_position": "false",
"offset_center": 0,
"width": 200,
"processingarea_type": "front",
"design_reference": "310ef229-2254-4f4f-9041-a8e02674ff36",
"colors": [
{
"sortPosition": 1,
"referenceColorId": 2195,
"price": 2195,
"colorId": 608
}
],
"is_customizable": "false",
"processingmethod": "dtg",
"offset_top": 50
}
]
}
Success
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (200 OK)
{
"data": [
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Delete product
Numerical product identifier
Success, product deleted
Product not found
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get product
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
Numerical product identifier
Success
Product not found
Response Example (200 OK)
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Update product
Update names, descriptions, prices and add/delete a product of the authenticated user.
- price: integer
-
Gross product price in Euro-cents
- colors: integer[]
-
List of color ids
- delete_unmentioned_colors: bool
-
Set to true if colors which are stored but do not appear in the request should be deleted. Default: false
- description: string
-
Short description
- sort_position: integer
-
Set a sort position for this product within its project
- custom_name: string
-
Product name
Numerical product identifier
Request Example
{
"price": 400,
"colors": [
"integer"
],
"delete_unmentioned_colors": "bool",
"description": "string",
"sort_position": "1",
"custom_name": "My cool product"
}
Success
Product not found
Response Example (200 OK)
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
}
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-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 |
Create product
Use this endpoint to a create a product based on a specific baseProduct. The product can be customized on the baseProduct color level. This allows you to have a different design, size and positioning for each baseProduct color. Each processing can be associated to one or many colorIds. Multiple processings can be added. Workflow: create project, add customized-products
- base_product_id: integer
-
Identifier of desired base product
- project_id: string
-
Identifier of existing project
- processings: object[]
-
List of processings to apply
Request Example
{
"base_product_id": 235,
"project_id": "CP94791DFD28",
"processings": [
{
"processingposition": "chest-center",
"force_position": "false",
"design": "310ef229-2254-4f4f-9041-a8e02674ff36",
"offset_center": 0,
"processingarea_type": "front",
"is_customizable": "false",
"colors": [
{
"sortPosition": 1,
"price": 2195,
"colorId": 608
}
],
"width": 200,
"processingmethod": "dtg",
"offset_top": 50
}
]
}
Success
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (200 OK)
{
"data": [
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get all products
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
Only return products where rendering is finished.
Success
Response Example (200 OK)
{
"data": [
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
baseProduct
Endpoints in this section retrieve baseProducts available for creating customized products.
List available categories
Success
Response Example (200 OK)
{
"data": [
{
"name": "Unisex-Shirts",
"id": 10,
"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": [
{
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
}
]
}
Get base product
Retrieve information on a single base product.
Numerical base product identifier
Success
Product not found
Response Example (200 OK)
{
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
}
project
Endpoints in this section manipulate (create, view, modify) projects of the currently logged in user.
DEPRECATED: Remove processing
This endpoint is deprecated. Use the customized-product endpoint instead. (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 |
DEPRECATED: Update processing
This endpoint is deprecated. Use the customized-product endpoint instead. (Update processing information on a single campaign.)
Unique project identifier
Processing site to remove
Processing position to remove
Request Example
{
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"area": "front",
"offset_top": 50
}
Success
Project not found
| cockpit_apikey | |
| cockpit_oauth | write-campaign |
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
Get project
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: products, productInfo
Unique project identifier
Success
Project not found
Response Example (200 OK)
{
"is_published": true,
"type": "ondemand",
"name": "My cool project",
"products_count": 3,
"status": "Finalisiert",
"is_syncing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"is_queueing": {
"12": true
},
"processings": {
"data": [
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
]
},
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff"
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
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)
{
"is_published": true,
"type": "ondemand",
"name": "My cool project",
"products_count": 3,
"status": "Finalisiert",
"is_syncing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"is_queueing": {
"12": true
},
"processings": {
"data": [
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
]
},
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff"
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
DEPRECATED: Publish project
This endpoint is deprecated. Use the customized-product endpoint instead. (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 |
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 |
Create project
Create a new project and return the inserted information. Associate the project with the currently authenticated user.
- description: string
-
Project description
- name: string
-
Project name
- is_deprecated_campaign: boolean
-
indicates if deprecated way for product creation is used (use 1/0 instead of true/false)
Request Example
{
"description": "My cool project",
"name": "My cool project",
"is_deprecated_campaign": "0"
}
Success
Response Example (200 OK)
{
"is_published": true,
"type": "ondemand",
"name": "My cool project",
"products_count": 3,
"status": "Finalisiert",
"is_syncing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"is_queueing": {
"12": true
},
"processings": {
"data": [
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
]
},
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff"
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get all projects
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: products, productInfo
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": [
{
"is_published": true,
"type": "ondemand",
"name": "My cool project",
"products_count": 3,
"status": "Finalisiert",
"is_syncing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"is_queueing": {
"12": true
},
"processings": {
"data": [
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
]
},
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff"
}
],
"meta": {
"pagination": {
"per_page": 10,
"current_page": 2,
"total": 32,
"total_pages": 4,
"count": 10,
"links": {
"previous": "string",
"next": "string"
}
}
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
DEPRECATED: Add processing
This endpoint is deprecated. Use the customized-product endpoint instead. (Add processing information to a single campaign.)
Unique project identifier
Request Example
{
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"area": "front",
"offset_top": 50
}
Success
Project not found
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get products for a project
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
Unique project identifier
Success
Project not found
Response Example (200 OK)
[
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png"
}
}
]
}
]
| cockpit_apikey | |
| cockpit_oauth | read-project |
DEPRECATED: Create product
This endpoint is deprecated. Use the customized-product endpoint instead. (Add a product to a project from the catalog of available base products.)
- price: integer
-
Price in Euro-cents
- colors: integer[]
-
List of colors ids
- project_id: string
-
Identifier of existing project
- base_product_id: integer
-
Identifier of desired base product
- sort_position: integer
-
Set a sort position for this product within its project
- 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
Request Example
{
"price": "1999",
"colors": [
"212,239"
],
"project_id": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"base_product_id": 25,
"sort_position": "1",
"custom_name": "My fancy product name"
}
Success
Project or base product not found
Requirements not fulfilled
Response Example (200 OK)
{
"data": [
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
order
Endpoints in this section retrieve information about issued orders.
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)
{
"coupon_code": "Shirt-coupon-XYZ",
"has_orders": "1",
"discount_type": "euro",
"expiration_date": "2017-01-01 12:34:56",
"discount_percent": 10,
"is_expired": false,
"coupon_type": "discount",
"discount_netto": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"remaining_activations": "1",
"discount_brutto": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"new_user_only": "1",
"min_order_value": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"n_activations": "1",
"is_active": true,
"rate_limit_exceeded": "1"
}
| cockpit_apikey | |
| cockpit_oauth | read-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.
- packins: object[]
-
Selected packins (optional)
- products: object[]
-
Selected products
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- sender: OrderAddress
-
Create order
Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- 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.
Request Example
{
"packins": [
{
"second_packin_reference": "A12345",
"sticker_reference": "A12345",
"hangtag_reference": "A12345",
"order_packaging_reference": "A12345",
"product_packaging_reference": "A12345",
"first_packin_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345"
}
],
"products": [
{
"amount": 1,
"productId": 235,
"sizeId": 1,
"colorId": 326
}
],
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"is_onhold": "true",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "ABC123",
"add_delivery_receipt": "true",
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
}
}
Success, price has been calculated
Validation failed, details in response body
Response Example (200 OK)
{
"included_tax_rate": 19,
"shipping_net_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"products_net_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"included_tax": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"total_gross_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"total_net_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
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_note: string
-
Custom note printed on delivery receipt
- packins: object[]
-
Selected packins (optional)
- sender: OrderAddress
-
Create Quick-Order
Create a design, a product and place an order - in a single step.
- jobs: object[]
-
Processing jobs
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
- delivery: OrderAddress
-
Create Quick-Order
Create a design, a product and place an order - in a single step.
Request Example
{
"add_delivery_receipt": "true",
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"packins": [
{
"second_packin_reference": "A12345",
"sticker_reference": "A12345",
"hangtag_reference": "A12345",
"order_packaging_reference": "A12345",
"product_packaging_reference": "A12345",
"first_packin_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345"
}
],
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"jobs": [
{
"base_products": [
{
"id": 235,
"colors": [
{
"sizes": [
{
"amount": "integer",
"id": 1
}
],
"id": 326
}
]
}
],
"processings": [
{
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"url": "https://myurl/myimage.png"
},
"area": "front",
"offset_top": 50
}
]
}
],
"delivery_receipt_logo_reference": "ABC123",
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
}
}
Success, order has been created
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (201 Created)
{
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
}
| cockpit_apikey | |
| cockpit_oauth | write-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 |
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
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: parent, children, comments, products, warehouseProducts, payments, orderStatusEntries, shipping, packins
Alphanumerical order identifier
Success
Order not found
Response Example (200 OK)
{
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
}
| 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 |
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
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)
- products: object[]
-
Selected products
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- sender: OrderAddress
-
Create order
Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used.
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- 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.
Request Example
{
"packins": [
{
"second_packin_reference": "A12345",
"sticker_reference": "A12345",
"hangtag_reference": "A12345",
"order_packaging_reference": "A12345",
"product_packaging_reference": "A12345",
"first_packin_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345"
}
],
"products": [
{
"amount": 1,
"productId": 235,
"sizeId": 1,
"colorId": 326
}
],
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"is_onhold": "true",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "ABC123",
"add_delivery_receipt": "true",
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
}
}
Success, order has been created
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (201 Created)
{
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
{
"color": "Red",
"urls": {}
}
]
}
]
}
}
| cockpit_apikey | |
| cockpit_oauth | write-order |
Get all orders
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: parent, children, comments, products, warehouseProducts, payments, orderStatusEntries, shipping, packins
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": [
{
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
{}
]
}
]
}
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-order |
integration
Endpoints in this section control data about integrations to 3rd party applications for fullfilments. Integrations may only be updated or deleted via API while the initial installation of integrations is performed in the user dashboard
Get UserIntegration
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
- syncs: integer
-
Includes current product states
Request Example
{
"syncs": "integer"
}
Success
integration not found
Response Example (200 OK)
| cockpit_apikey | |
| cockpit_oauth | read-user |
Delete UserIntegration
Uninstall this integration from your 3rd party store and delete the integration. IMPORTANT: all synchronized products will be deleted as well in the 3rd party store.
Unique design identifier
Success, integration uninstalled and deleted
integration not found
| cockpit_apikey | |
| cockpit_oauth | write-user |
Get UserIntegration
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: fulfillmentPolicy, regions, defaultStock
- syncs: integer
-
Includes current product states
Request Example
{
"syncs": "integer"
}
Success
integration not found
Response Example (200 OK)
| cockpit_apikey | |
| cockpit_oauth | read-user |
Get OrderReference
Get shirtigo order reference for given integrationId and integration orderId
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
other
This section contains miscellaneous endpoints.
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.
- printareas: integer[]
-
Desired print areas
- is_colored: boolean
-
Is this a color print?
- product_id: integer
-
Desired base product
Request Example
{
"printareas": [
"integer"
],
"is_colored": true,
"product_id": 375
}
Success
Product not found
Response Example (200 OK)
{
"vat_rate": 19,
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
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)
{
"month_amount": 14,
"week_amount": 3,
"today": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"month": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"week": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"total": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"today_amount": 1,
"total_amount": 36
}
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 |
warehousing
DELETE /warehousing/shipments/{reference}
Deletes WarehouseInboundShipment
Reference of the InboundShipment to be deleted
Success
WarehouseInboundShipment not found
Response Example (200 OK)
| cockpit_apikey | |
| cockpit_oauth | read-user |
Schema Definitions
OrderStatusEntry: object
- created_at: string
-
Timestamp of creation
- key: string
-
Order status key
- description: integer
-
Verbose status description
- updated_at: string
-
Timestamp of last update
- status: string
-
Human readable status
Example
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
ProductDimensions: object
- height: integer
-
Height in mm
- size: string
-
Product size name
- width: integer
-
Width in mm
Example
{
"height": 500,
"size": "XL",
"width": 200
}
Country: object
- name: string
-
Country name
- iso: string
-
Two-letter identifier according to ISO 3166-1
Example
{
"name": "Germany",
"iso": "DE"
}
ProductProcessingArea: object
- height: integer
-
Height of the printarea in pixels
- printable_area_margin_from_top: integer
-
Distance between top and processable area top
- width_in_mm: integer
-
Width of the printarea in millimeters
- height_in_mm: integer
-
Height of the printarea in millimeters
- width: integer
-
Width of the printarea in pixels
- template_width: integer
-
Default template width
- template_height: integer
-
Default template height
- position_name: string
-
Name of the printarea
- template: string
-
Template
- position_id: integer
-
Numerical identifier
Example
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
ProductPrice: object
- type: string
-
Variant
- price: Money
-
Price
Example
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
ProjectPrint: object
- height: integer
-
Design height in millimeters
- position: string
-
Processing position
- width: integer
-
Design width in millimeters
- offset_center: integer
-
Horizontal offset from center in millimeters
- method: string
-
Processing method
- design: Design
- updated_at: string
-
Timestamp of last update
- area: string
-
Processing site
- offset_top: integer
-
Vertical offset from top in millimeters
Example
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
UserPackin: object
- position: string
-
Position of Label
- inventory: integer
-
Actual stock level of packin
- initial_inventory: integer
-
Initial stock level of packin
- height_mm: integer
-
Height of the packin in millimeter
- weight_gram: integer
-
Weight of one single packin in gram
- preview_path: string
-
Path to packin preview
- color_ids: string
-
Array of product color ids for which imprint or label will be applied
- type: string
-
Packin type (packin or hangtag)
- name: string
-
Packin name
- width_mm: integer
-
Width of the packin in millimeter
- size_id: integer
-
Product size ID for which imprint will be applied
- stocking_costs: Money
-
Daily costs for stocking packin
- reference: ABC123
-
Packin reference
- is_active: boolean
-
Packins receives status is_active, when article is checked and warehoused
Example
{
"position": "seam-left",
"inventory": "1000",
"initial_inventory": "1000",
"height_mm": "100",
"weight_gram": "10",
"preview_path": "https://s3.amazon.com/preview.png",
"color_ids": "['147','157']",
"type": "packin",
"name": "Greetings card",
"width_mm": "100",
"size_id": "3",
"stocking_costs": 50,
"reference": "ABC123",
"is_active": "true"
}
UserGroup: object
- type: string
-
Group name
- id: integer
-
Numerical group identifier
- updated_at: string
-
Timestamp of last update
- created_at: string
-
Timestamp of creation
- quantity: integer
-
Required number of sold products
- cockpit_discount: integer
-
Discount in percent
Example
{
"type": "premium",
"id": 1,
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"quantity": 1000,
"cockpit_discount": 20
}
CampaignProductIntegrationSync: object
- is_syncing: boolean
-
Is the product available?
- in_queue: boolean
-
Is the current sync-process still in queue?
- error: string
-
Error message
- updated_at: string
-
Timestamp of last update
- integration_id: integer
-
The cockpit internal id of the used user integration
- integration_name: string
-
Name of the integration application
- is_successful: boolean
-
Has the product been rendered?
- integration_product_id: string
-
The identifier used by the integration application
Example
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
Product: object
- description: string
-
Detailed description
- short_description: string
-
Short description
- original_name: string
-
Base product name
- id: integer
-
Numeric identifier of this product
- images: object
-
Product images
- processing_areas: object
-
Available processing areas
- category: string
-
Category name
- sales_price: object
-
Pricing information on sales
- name: string
-
Product name
- price: object
-
Pricing information
- category_id: integer
-
Numerical category identifier
- colors: object
-
Color information
- shipping_category: integer
-
Shipping category
- manufacturer: ProductManufacturer
-
Manufacturer information
- is_active: boolean
-
Activation status. Base products may not be available for orders in rare cases.
- sizechart_image: string
-
URL of the product size table image
Example
{
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
}
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"
}
ProvisionalProduct: object
- description: string
-
Short description
- name: string
-
Product name
- price: Money
-
Net price
- base_product: Product
-
Base product
- colors: ProductColor
-
List of available colors
Example
{
"description": "string",
"name": "Base product XY",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"colors": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
}
MoneyWithVat: object
Example
{
"vat_rate": 19,
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
Order: object
- status_key: string
-
Number of products
- sender: OrderAddress
-
Sender address
- delivery_receipt_logo_reference: string
-
Media reference for the logo added to delivery_receipt
- reference: string
-
Unique identifier of this order
- packins: object
-
Array of packins and hangtags in this order
- updated_at: string
-
Timestamp of last update
- status: string
-
Human readable order status
- 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)
- orderStatusEntries: object
-
Array of status messages associated with this order
- bill: OrderAddress
-
Billing address
- products: object
-
Array of products in this order
- invoice_reference: string
-
Invoice reference
- vat_rate: integer
-
VAT rate in percent
- gross_price: Money
-
Total gross price of this order
- payments: object
-
Array of payments associated with this order
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to order
- delivery_receipt_note: string
-
Custom note on delivery receipt
- net_price: Money
-
Total net price of this order
- created_at: string
-
Timestamp of creation
- use_custom_product_name: boolean
-
Use custom product name on delivery receipt
- total_items: integer
-
Total number of items in the order
- delivery: OrderAddress
-
Delivery address
Example
{
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png"
}
}
]
}
]
}
}
OrderWarehouseProduct: object
Example
{
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"sku": "WP-12345",
"amount": 1,
"reference": "string"
}
UtilProductImage: object
- color: string
-
Color name
- urls: object
-
Product name
- area: string
-
Processing area name
Example
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
},
"area": "front"
}
Payment: object
- payment_reference: string
-
Payment reference
- vat_rate: integer
-
VAT rate in percent
- status: string
-
Payment type
- order: Order
-
Order
- created_at: string
-
Timestamp of creation
- vat_amount: Money
-
VAT amount
- id: string
-
Unique transaction identifier
- gross_amount: Money
-
Gross price
- net_amount: Money
-
Net price
- status_title: string
-
Payment description
Example
{
"payment_reference": "Kreditkarte",
"vat_rate": 19,
"status": "invoice",
"order": {
"status_key": "",
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"delivery_receipt_logo_reference": "A456HJ",
"reference": "ABCDXY1",
"packins": {
"data": [
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
]
},
"updated_at": "2017-01-01 12:34:56",
"status": "Bestellung offen",
"fulfillment": {},
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"shipping": {
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
},
"orderStatusEntries": {
"data": [
{
"created_at": "2017-01-01 12:34:56",
"key": "string",
"description": "integer",
"updated_at": "2017-01-01 12:34:56",
"status": "string"
}
]
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
},
"products": {
"data": [
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
null
]
}
]
}
}
}
ProductColor: object
- sizes: object[]
-
Available sizes
- color: string
-
Color name
- id: integer
-
Numerical identifier
- is_colored: boolean
-
Is this a non trivial (b/w) color?
- color_hex: string
-
Hexadecimal RGB color value
Example
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
ProductImage: object
- sort_position: integer
-
Numerical index used for sorting
- url: string
-
URL of the image file
Example
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
OrderComment: object
- comment: string
-
Text of the order comment
- id: integer
-
ID of the order comment
- created_at: string
-
Timestamp of creation
Example
{
"comment": "Great communication with customer",
"id": "integer",
"created_at": "2017-01-01 12:34:56"
}
Project: object
- is_published: boolean
-
Has the project been published?
- type: string
-
Type
- name: string
-
Project name
- products_count: integer
-
Number of products
- status: string
-
Project status
- is_syncing: array
-
Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently syncing.
- created_at: string
-
Timestamp of initial creation
- updated_at: string
-
Timestamp of last update
- is_queueing: array
-
Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently in queue.
- processings: object
-
Processings associated with this project
- reference: string
-
Unique identifier of this project
Example
{
"is_published": true,
"type": "ondemand",
"name": "My cool project",
"products_count": 3,
"status": "Finalisiert",
"is_syncing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"is_queueing": {
"12": true
},
"processings": {
"data": [
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
]
},
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff"
}
OrderAddress: object
Address
- title: string
-
(Academic) title
- company: string
-
Company name
- city: string
-
City
- postcode: string
-
ZIP/area code
- lastname: string
-
Last name
- country: string
-
A country iso-code (ISO 3166-1 alpha2) as listed in the /delivery-countries endpoint
- street: string
-
Street and number
- firstname: string
-
First name
Example
{
"title": "Dr.",
"company": "Shirtigo GmbH",
"city": "Köln",
"postcode": "12345",
"lastname": "Mustermann",
"country": "DE",
"street": "Musterstraße 12",
"firstname": "Max"
}
Pagination: object
Pagination information
- per_page: integer
-
Default number of items per page
- current_page: integer
-
Index of current page
- total: integer
-
Total number of items
- total_pages: integer
-
Total number of pages
- count: integer
-
Number of items on current page
- links: object
-
URLs of adjacent pages
Example
{
"per_page": 10,
"current_page": 2,
"total": 32,
"total_pages": 4,
"count": 10,
"links": {
"previous": "string",
"next": "string"
}
}
ProjectWithProducts:
Example
{
"products": [
{
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
null
]
}
]
}
}
],
"is_published": true,
"type": "ondemand",
"name": "My cool project",
"products_count": 3,
"status": "Finalisiert",
"is_syncing": {
"12": true
},
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"is_queueing": {
"12": true
},
"processings": {
"data": [
{
"height": 300,
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": {
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
},
"updated_at": "2017-01-01 12:34:56",
"area": "front",
"offset_top": 50
}
]
},
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff"
}
Processing: object
Processing to apply
- position: string center
-
Processing position
- width: string 120
-
Design width in millimeters
- offset_center: integer
-
Horizontal offset from center in millimeters
- method: string center
-
Processing method
- design: string
-
Design reference
- area: string
-
Processing area
- offset_top: integer
-
Vertical offset from top in millimeters
Example
{
"position": "center",
"width": 200,
"offset_center": 0,
"method": "print",
"design": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"area": "front",
"offset_top": 50
}
CampaignIntegrationProduct: object
- integration_id: integer
-
The cockpit internal id of the used user integration
- updated_at: string
-
Timestamp of last update
- integration_product_id: string
-
The identifier used by the integration application
Example
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
Design: object
- preview: string
-
URL to preview image
- filename: string
-
Design file name
- created_at: string
-
Timestamp of creation
- complementary_color: string
-
Complementary color
- width: integer
-
Width of the design file in pixels
- original_file: string
-
URL to full resolution image
- reference: string
-
Unique identifier of this design
- height: integer
-
Height of the design file in pixels
- name: string
-
Design Name
- updated_at: string
-
Timestamp of last update
- colors: integer
-
Total number of colors in the color palette
- palette: string[]
-
List of hex-codes of representative colors
- is_processed: boolean
-
Has the design been rendered?
- is_dark: boolean
-
Is this a design with dark colors?
- filetype: string
-
Extension of the design file name
Example
{
"preview": "https://example.com/product_prev.png",
"filename": "ABCDE",
"created_at": "2017-01-01 12:34:56",
"complementary_color": "",
"width": 5000,
"original_file": "https://example.com/product.png",
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"height": 3000,
"name": "My cool design",
"updated_at": "2017-01-01 12:34:56",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"is_processed": true,
"is_dark": true,
"filetype": "png"
}
Money: object
- amount: integer
-
Price in cents
- currency_code: string
-
Three letter ISO 4217 code
- currency_factor: integer
-
Number of cents in one unit of currency
- currency_symbol: string
-
Currency symbol
Example
{
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
OrderPackin: object
Example
{
"type": "hangtag",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Greeting card",
"net_total_price": 75,
"amount": 1,
"id": "integer"
}
Coupon: object
- coupon_code: string
-
The identifier on the promo coupon
- has_orders: integer
-
Flag to indicate if orders for user exist.
- discount_type: string
-
The type of discount, either percentage or euro
- expiration_date: string
-
Timestamp for the validity of the coupon code
- discount_percent: integer
-
The granted discount in percent on the cart value without handling and shipping (filled for discount type percentage)
- is_expired: boolean
-
Flag to indicate if the coupon is expired
- coupon_type: string
-
The type of the coupon (discount, free shipping, etc.)
- discount_netto: Money
-
The granted discount without sales taxes in euro cent (filled for discount type euro)
- remaining_activations: integer
-
Number of remaining usages for this coupon
- discount_brutto: Money
-
The gross granted discount in euro cent (filled for discount type euro)
- new_user_only: integer
-
Flag to indicate if the coupon is for new users only
- min_order_value: Money
-
Minimal total value in euro cents for an order to make this coupon applicable
- n_activations: integer
-
Number of usages for this coupon
- is_active: boolean
-
Activation status of coupon
- rate_limit_exceeded: integer
-
Flag to indicate if the coupon was used too often in the last hour.
Example
{
"coupon_code": "Shirt-coupon-XYZ",
"has_orders": "1",
"discount_type": "euro",
"expiration_date": "2017-01-01 12:34:56",
"discount_percent": 10,
"is_expired": false,
"coupon_type": "discount",
"discount_netto": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"remaining_activations": "1",
"discount_brutto": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"new_user_only": "1",
"min_order_value": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"n_activations": "1",
"is_active": true,
"rate_limit_exceeded": "1"
}
OrderShipping: object
- type: string
-
Shipping type
- cost: Money
-
Shipping price
- tracking_code: string
-
Carrier tracking code
- updated_at: string
-
Timestamp of last update
- tracking_url: string
-
Carrier tracking URL
- country_code: string
-
Two letter country code
- created_at: string
-
Timestamp of creation
- is_shipped: boolean
-
Has the order been shipped yet?
Example
{
"type": "delivery",
"cost": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"tracking_code": "string",
"updated_at": "2017-01-01 12:34:56",
"tracking_url": "string",
"country_code": "DE",
"created_at": "2017-01-01 12:34:56",
"is_shipped": false
}
MoneyVatInclude:
- vat_rate: integer
-
Value added tax (VAT) rate in percent as an integer
Example
{
"vat_rate": 19
}
ProductManufacturer: object
- name: string
-
Manufacturer name
- id: integer
-
Numerical identifier
Example
{
"name": "Musterfirma",
"id": 123
}
OrderRelation: object
- gross_price: Money
-
Total gross price of this order
- updated_at: string
-
Timestamp of last update
- net_price: Money
-
Total net price of this order
- vat_rate: integer
-
VAT rate in percent
- created_at: string
-
Timestamp of creation
- total_items: integer
-
Total number of items in the order
- status: string
-
Human readable order status
- status_key: string
-
Number of products
- vat_amount: Money
-
VAT amount
- reference: string
-
Unique identifier of this order
Example
{
"gross_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"updated_at": "2017-01-01 12:34:56",
"net_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"vat_rate": 19,
"created_at": "2017-01-01 12:34:56",
"total_items": 5,
"status": "Bestellung offen",
"status_key": "",
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"reference": "ABCDXY1"
}
OrderPayment: object
- type: string
-
Payment type
- status_details: string
-
Payment error description (if there is any)
- updated_at: string
-
Timestamp of last update
- vat_rate: integer
-
VAT rate in percent
- status: string
-
Payment status
- vat_amount: Money
-
VAT amount
- id: string
-
Unique transaction identifier
- gross_amount: Money
-
Gross price
- net_amount: Money
-
Net price
Example
{
"type": "creditcard",
"status_details": "An error occured.",
"updated_at": "2017-01-01 12:34:56",
"vat_rate": 19,
"status": "paid",
"vat_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"gross_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"net_amount": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
CampaignProduct: object
- integration_sync_log: CampaignProductIntegrationSync
-
History of synchronizations with integrations for this product
- integration_products: CampaignIntegrationProduct
-
List of integration products (e.g. products in shopify) for this products
- base_product: Product
-
Base product
- id: integer
-
Numerical identifier
- images: UtilProductImage
-
Product images
- is_available: boolean
-
Is the product available?
- project: string
-
Project reference
- has_express: boolean
-
Is the product available for express processing?
- custom_name: string
-
User defined product name
- name: string
-
Product name
- project_name: string
-
Project name
- price: Money
-
Net price
- colors: ProductColor
-
List of available colors
- active_integration_syncs: CampaignProductIntegrationSync
-
List of currently active synchronizations with integrations
- description: string
-
Short description in HTML format
- sort_position: integer
-
Numerical identifier
- updated_at: string
-
Timestamp of last update
- is_rendered: boolean
-
Has the product been rendered?
Example
{
"integration_sync_log": [
{
"is_syncing": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56",
"integration_id": 111,
"integration_name": "shopify",
"is_successful": true,
"integration_product_id": "9286211826"
}
],
"integration_products": [
{
"integration_id": 111,
"updated_at": "2017-01-01 12:34:56",
"integration_product_id": "9286211826"
}
],
"base_product": {
"description": "string",
"short_description": "string",
"original_name": "T-Shirt",
"id": 1,
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"processing_areas": {
"data": [
{
"height": 2000,
"printable_area_margin_from_top": 0,
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"template_width": 1000,
"template_height": 1000,
"position_name": "front",
"template": "string",
"position_id": 1
}
]
},
"category": "Unisex-Shirts",
"sales_price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"name": "Base product XY",
"price": {
"data": [
{
"type": "generic",
"price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
}
}
]
},
"category_id": 5,
"colors": {
"data": [
{
"sizes": [
{
"size": "XL",
"is_onlocalstock": true,
"id": 67,
"sort_position": 1,
"is_available": true
}
],
"color": "Black",
"id": 123,
"is_colored": true,
"color_hex": "#000000"
}
]
},
"shipping_category": 1,
"manufacturer": {
"name": "Musterfirma",
"id": 123
},
"is_active": "boolean",
"sizechart_image": "string"
},
"id": 123,
"images": [
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
},
"area": "front"
}
]
}
User: object
- user_group: UserGroup
- sender_street: string
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to orders received via this intergrations
- sender_state: string
- lastname: string
-
Last name
- default_second_packin_reference: string
-
Default second packin added to orders placed via dashboard (optional)
- sender_firstname: string
- integrations: UserIntegration
-
List of integrations (connected applications) for this user
- has_orders: boolean
-
Does user have orders?
- sender_lastname: string
- phone: string
-
Phone nubmer
- sender_type: string full, company, legacy
- use_custom_product_name: boolean
-
Indicates if custom product name is used on delivery receipt
- default_delivery_receipt_logo_reference: string
-
Default delivery receipt logo used for orders placed via dashboard
- city: string
-
City, used for billing
- is_billing_valid: boolean
-
Have billing options been filled out?
- is_business: boolean
-
Is a business customer
- sender_country: string
- default_first_packin_reference: string
-
Default first packin added to orders placed via dashboard (optional)
- street: string
-
Street and number, used for billing
- default_hangtag_reference: string
-
Default hangtag added to all textil products of orders placed via dashboard (optional)
- title: string
-
(Academical) title
- company_name: string
-
Company name
- postcode: string
-
ZIP code, used for billing
- sender_title: string
- is_auto_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- display_name: string
-
Display name, e.g. first + last name
- sender_city: string
- email: string
-
Email address
- sender_postcode: string
- firstname: string
-
First name(s)
- delivery_receipt_note: string
-
Custom note on delivery receipt
- country: string
-
Country, used for billing
- delivery_receipt_logo: string
-
Url to custom logo added to delivery slip and shipping lable for orders placed via dashboard
- updated_at: string
-
Timestamp of last update
- sticker_logo: string
-
Url to custom sticker logo for orders placed via dashboard (optional)
- sender_company_name: string
- integration_count: number
-
Number of active integrations
Example
{
"user_group": {
"type": "premium",
"id": 1,
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"quantity": 1000,
"cockpit_discount": 20
},
"sender_street": "string",
"add_delivery_receipt": true,
"sender_state": "string",
"lastname": "Mustermann",
"default_second_packin_reference": "ABC123",
"sender_firstname": "string",
"integrations": [
null
],
"has_orders": true,
"sender_lastname": "string",
"phone": "004930123456",
"sender_type": "string",
"use_custom_product_name": "true",
"default_delivery_receipt_logo_reference": "ABC123",
"city": "Köln",
"is_billing_valid": true,
"is_business": "true",
"sender_country": "string",
"default_first_packin_reference": "ABC123",
"street": "Musterstraße 12",
"default_hangtag_reference": "ABC123",
"title": "Dr.",
"company_name": "Shirtigo GmbH",
"postcode": "12345",
"sender_title": "string",
"is_auto_onhold": true,
"display_name": "Max Mustermann",
"sender_city": "string",
"email": "mustermann@example.com",
"sender_postcode": "string",
"firstname": "Max",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"country": "Deutschland",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"updated_at": "2017-01-01 12:34:56",
"sticker_logo": "https://example.com/custom_logo.png",
"sender_company_name": "string",
"integration_count": 2
}
OrderProduct: object
- campaign_product_id: int
-
ID of the campaign product
- campaign_reference: string
-
Reference of the campaign
- net_unit_price: Money
-
Net unit price
- name: string
-
Product name
- net_total_price: Money
-
Total price (net_unit_price*amount)
- campaign_name: string
-
Name of the campaign
- amount: integer
-
Number of items
- size: string
-
Size name
- color: string
-
Color name
- id: integer
-
Product id
- images: UtilProductImage
-
Available image URLs
Example
{
"campaign_product_id": "123",
"campaign_reference": "F7S33M2",
"net_unit_price": {
"amount": 999,
"currency_code": "EUR",
"currency_factor": 100,
"currency_symbol": "€"
},
"name": "Base product XY",
"net_total_price": 1375,
"campaign_name": "Example Project",
"amount": 1,
"size": "XL",
"color": "Black",
"id": "integer",
"images": [
{
"color": "Red",
"urls": {
"large": "http://www.example.com/my-orders/large.png",
"small": "http://www.example.com/my-orders/small.png"
},
"area": "front"
}
]
}