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