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.com/apiRequest Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: 1.0.0
Authentication
cockpit_apikey
This API supports access via an API key. A key can be obtained from the integrations dashboard. The key must be presented in the 'Authorization' header, e.g. 'Authorization: Bearer [key]'.
cockpit_oauth
This API supports OAuth2 with the authorization-code flow. A detailed tutorial on this topic can be found
here. Note that the endpoint is /oauth/, not /api/oauth/ as indicated here in the documentation.
oauth
This section contains endpoints related to the OAuth2 implementation.
Request access token
This endpoint constitutes the second step of the OAuth2 authorization flow, obtaining an access token from the access code. This is done on the client side and does not require any user interaction.
Grant type
Code received in callback from /oauth/authorize
Client ID (from registration)
Client Secret (from registration)
Success, token issued.
Error.
Error, invalid client (client ID or secret are wrong).
Response Example (200 OK)
{
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjVjZj...",
"refresh_token": "tYI1iHjH7lGBLlBi+VD6uYYCn3pZo8Do/BSmcgzwTOuZ+f7v/z...",
"expires_in": 31536000,
"token_type": "Bearer"
}
Response Example (400 Bad Request)
{
"error": "string",
"message": "string",
"hint": "string"
}
Response Example (401 Unauthorized)
{
"error": "string",
"message": "string",
"hint": "string"
}
user
Endpoints in this section control data of the currently logged in user profile.
Get all transactions
Retrieve all accounting transactions issued by the currently authenticated user. The result will be paginated, meta information is included in the response.
Page number
Items per page
Search query
Property to order by
Order direction
Days to show (default: all)
Action to filter for (default: none)
Success
Response Example (200 OK)
{
"data": [
{
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"status": "invoice",
"status_title": "Erstattung",
"payment_reference": "Kreditkarte",
"order": {
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"invoice_reference": "string",
"fulfillment": {},
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"total_items": 5,
"add_delivery_receipt": true,
"delivery_receipt_logo_reference": "A456HJ",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"products": {
"data": [
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€"
}
}
]
}
}
}
]
}
Get balance for current user
Return a Money object for the users current balance
Success
Response Example (200 OK)
{
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
}
Get user information
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: integrations, billingMethod, availableBillingMethods
Success
Response Example (200 OK)
{
"email": "mustermann@example.com",
"firstname": "Max",
"lastname": "Mustermann",
"display_name": "Max Mustermann",
"user_group": {
"id": 1,
"type": "premium",
"cockpit_discount": 20,
"quantity": 1000,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
},
"is_business": "true",
"title": "Dr.",
"company_name": "Shirtigo GmbH",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "Deutschland",
"phone": "004930123456",
"sender_title": "string",
"sender_company_name": "string",
"sender_firstname": "string",
"sender_lastname": "string",
"sender_street": "string",
"sender_postcode": "string",
"sender_city": "string",
"sender_state": "string",
"sender_country": "string",
"sender_type": "string",
"fulfillment_key": "24h-express",
"is_billing_valid": true,
"has_orders": true,
"integration_count": 2,
"is_auto_onhold": true,
"integrations": [
{
"id": 111,
"app": "shopify",
"name": "my-cool-shirtstore.myshopify.com",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"expires_in": "2018-01-01 12:34:56",
"image_type": "png",
"image_quality": "high",
"fulfillment_mode_key": "24h-express",
"is_pull_orders": "true",
"is_auto_pull_orders": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_imprint_reference": "ABC123",
"default_label_reference": "ABC123",
"default_product_packaging_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"default_sticker_reference": "ABC123",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"sticker_logo": "https://example.com/custom_logo.png",
"is_auto_onhold": true,
"is_refresh_token_expired": false
}
],
"updated_at": "2017-01-01 12:34:56",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"sticker_logo": "https://example.com/custom_logo.png"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
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.
- lastname: string
-
Update user information
Update (some) fields of the currently authenticated user profile.
- street: string
-
Update user information
Update (some) fields of the currently authenticated user profile.
- postcode: 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.
- country: 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.
- phone: string
-
Update user information
Update (some) fields of the currently authenticated user profile.
- is_business: boolean
-
Update user information
Update (some) fields of the currently authenticated user profile.
- fulfillment_mode_key: boolean
-
Update user information
Update (some) fields of the currently authenticated user profile.
Request Example
{
"firstname": "string",
"lastname": "string",
"street": "string",
"postcode": "string",
"city": "string",
"country": "string",
"company_name": "string",
"phone": "string",
"is_business": "boolean",
"fulfillment_mode_key": "boolean"
}
User information updated.
Validation of inputs failed.
| 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 |
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 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 |
Delete a sticker assigned to your account or integration
The endpoint returns an empty array with exit code 200.
Unique integration identifier
Success, sticker was deleted
| cockpit_apikey | |
| cockpit_oauth | write-user |
Update sender address
Update sender address fields of currently authenticated user.
- sender_company_name: string (up to 30 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_firstname: string (up to 20 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_lastname: string (up to 20 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_street: string (up to 35 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_postcode: string (3 to 9 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_city: string (up to 30 chars)
-
Update sender address
Update sender address fields of currently authenticated user.
- sender_country: string
-
Update sender address
Update sender address fields of currently authenticated user.
Request Example
{
"sender_company_name": "string",
"sender_firstname": "string",
"sender_lastname": "string",
"sender_street": "string",
"sender_postcode": "string",
"sender_city": "string",
"sender_country": "string"
}
User information updated.
Validation of inputs failed.
| cockpit_apikey | |
| cockpit_oauth | write-user |
Update user advanced
Update advanced user settings.
- locale: string
-
Update user advanced
Update advanced user settings.
- accounting_email: string
-
Update user advanced
Update advanced user settings.
- customs_email: string
-
Update user advanced
Update advanced user settings.
- receives_mail_order_placed: boolean
-
Update user advanced
Update advanced user settings.
- receives_mail_order_shipped: boolean
-
Update user advanced
Update advanced user settings.
- use_tracking_de: boolean
-
Update user advanced
Update advanced user settings.
- use_tracking_eu: boolean
-
Update user advanced
Update advanced user settings.
- use_tracking_world: boolean
-
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.
- delivery_receipt_note: string
-
Update user advanced
Update advanced user settings.
- default_first_packin_reference: string
-
Update user advanced
Update advanced user settings.
- default_second_packin_reference: string
-
Update user advanced
Update advanced user settings.
- default_hangtag_reference: string
-
Update user advanced
Update advanced user settings.
- default_imprint_reference: string
-
Update user advanced
Update advanced user settings.
- default_label_reference: string
-
Update user advanced
Update advanced user settings.
- default_product_packaging_reference: string
-
Update user advanced
Update advanced user settings.
- default_order_packaging_reference: string
-
Update user advanced
Update advanced user settings.
Request Example
{
"locale": "string",
"accounting_email": "string",
"customs_email": "string",
"receives_mail_order_placed": "boolean",
"receives_mail_order_shipped": "boolean",
"use_tracking_de": "boolean",
"use_tracking_eu": "boolean",
"use_tracking_world": "boolean",
"add_delivery_receipt": "boolean",
"use_custom_product_name": "boolean",
"delivery_receipt_note": "string",
"default_first_packin_reference": "string",
"default_second_packin_reference": "string",
"default_hangtag_reference": "string",
"default_imprint_reference": "string",
"default_label_reference": "string",
"default_product_packaging_reference": "string",
"default_order_packaging_reference": "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.
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",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-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",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-design |
Update design
Update a single design based on the parameters given in the form body.
- name: string
-
name of the design
- tags: string[]
-
List of tags for this design
- colors: object[]
-
List of hex-color pairs with the currently used color and the color to replace. Only available for embroidery design files.
Unique design identifier
Request Example
{
"name": "string",
"tags": [
"string"
],
"colors": [
{
"F2E9EA": "25282A",
"D0DF00": "84754E"
}
]
}
Success
Design not found
Response Example (200 OK)
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
Delete design
Only designs by the currently authenticated user may be deleted.
Unique design identifier
Success, design deleted
Design not found
| cockpit_apikey | |
| cockpit_oauth | write-design |
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.
- processingmethod: string
-
The processingmethod for which the design will be used (dtg, embroidery, engraving)
- name: string
-
name for the design
- tags: string[]
-
List of tags for this design
Design file
Request Content-Types: multipart/form-data
Request Example
{
"processingmethod": "dtg",
"name": "my-design",
"tags": [
"string"
]
}
Success, all file has been processed
Error, image file does not meet requirements
Response Example (200 OK)
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
| 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.
- data: string
-
Base64-encoded data
- original_filename: string
-
Original file name (optional)
- processingmethod: string
-
The processingmethod for which the design will be used (dtg, embroidery, engraving)
- name: string
-
name for the design
- tags: string[]
-
List of tags for this design
Request Example
{
"data": "string",
"original_filename": "string",
"processingmethod": "dtg",
"name": "my-design",
"tags": [
"string"
]
}
Success, URL has been processed
Error, URL / image file does not meet requirements
Response Example (200 OK)
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
Create design from URL
Create a new design from the submitted URL.
The endpoint returns the created design.
- url: string
-
Design file URL
- processingmethod: string
-
The processingmethod for which the design will be used (dtg, embroidery, engraving)
- name: string
-
name for the design
- tags: string[]
-
List of tags for this design
Request Example
{
"url": "string",
"processingmethod": "dtg",
"name": "my-design",
"tags": [
"string"
]
}
Success, URL has been processed
Error, URL / image file does not meet requirements
Response Example (200 OK)
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | write-design |
product
Endpoints in this section retrieve customized products available to the currently logged in user.
Get all products
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
Only return products where rendering is finished.
A search term used to filter on the product and product group (collection) names.
Return only products for a given campaign
Return only products which contain a processingarea where the design for the given design_id is used
Return which are based on the given base product id
Filter for products containing a given tag
Success
Response Example (200 OK)
{
"data": [
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{}
]
}
}
}
]
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Get product
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
Numerical product identifier
Success
Product not found
Response Example (200 OK)
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {}
}
]
}
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Update product
Update names, descriptions, prices and add/delete a product of the authenticated user.
- custom_name: string
-
Product name
- price: integer
-
Gross product price in Euro-cents
- description: string
-
Short description
- tags: string[]
-
List of tags for this product
- colors: integer[]
-
List of color ids
- delete_unmentioned_colors: bool
-
Set to true if colors which are stored but do not appear in the request should be deleted. Default: false
- sort_position: integer
-
Set a sort position for this product within its project
Numerical product identifier
Request Example
{
"custom_name": "My cool product",
"price": 400,
"description": "string",
"tags": [
"string"
],
"colors": [
"integer"
],
"delete_unmentioned_colors": "bool",
"sort_position": "1"
}
Success
Product not found
Response Example (200 OK)
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {}
}
]
}
}
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Delete product
Numerical product identifier
Success, product deleted
Product not found
| cockpit_apikey | |
| cockpit_oauth | write-project |
Synchronize integrations
Trigger synchronization for all requested integrations for this product. The synchronization is performed in the background. Its status can be observed by querying the active_integration_syncs field in the product response.
- integrations: object[]
-
Integration ids
Numerical product identifier
Request Example
{
"integrations": [
null
]
}
Success, all integrations processed
| cockpit_apikey | |
| cockpit_oauth | write-project |
Create product
Use this endpoint to a create a product based on a specific baseProduct. The product can be customized on the baseProduct color level. This allows you to have a different design, size and positioning for each baseProduct color. Each processing can be associated to one or many colorIds. Multiple processings can be added. Workflow: create project, add customized-products
- 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": [
{
"processingarea_type": "front",
"processingposition": "chest-center",
"processingmethod": "dtg",
"design_reference": "310ef229-2254-4f4f-9041-a8e02674ff36",
"offset_top": 50,
"offset_center": 0,
"width": 200,
"is_customizable": "false",
"force_position": "false",
"colors": [
{
"colorId": 608,
"price": 2195,
"sortPosition": 1
}
]
}
]
}
Success
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (200 OK)
{
"data": [
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{}
]
}
}
}
]
}
| 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": [
{
"processingarea_type": "front",
"processingposition": "chest-center",
"processingmethod": "dtg",
"design_reference": "310ef229-2254-4f4f-9041-a8e02674ff36",
"offset_top": 50,
"offset_center": 0,
"width": 200,
"is_customizable": "false",
"force_position": "false",
"colors": [
{
"colorId": 608,
"referenceColorId": 2195,
"price": 2195,
"sortPosition": 1
}
]
}
]
}
Success
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (200 OK)
{
"data": [
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{}
]
}
}
}
]
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Adds Product Image for Color
Url
Style
Processing Area type
Name
Sort weight
Success, product image was added
Error, image file does not meet requirements
| cockpit_apikey | |
| cockpit_oauth | write-user |
baseProduct
Endpoints in this section retrieve baseProducts available for creating customized products.
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": [
{
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
},
"sales_price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
}
}
]
}
Get base product
Retrieve information on a single base product.
Numerical base product identifier
Success
Product not found
Response Example (200 OK)
{
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
},
"sales_price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
}
}
List available categories
Success
Response Example (200 OK)
{
"data": [
{
"id": 10,
"name": "Unisex-Shirts",
"sort_position": 1
}
]
}
project
Endpoints in this section manipulate (create, view, modify) projects of the currently logged in user.
Get all projects / collections
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: products, productInfo
Current page
Number of items per page
Column used to sort the results. You can sort by: name, reference, url, default_preview_position, created_at, updated_at
Direction for sorting
Success
Response Example (200 OK)
{
"data": [
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"name": "My cool project",
"type": "ondemand",
"products_count": 3,
"is_published": true,
"is_syncing": [
{
"12": true
}
],
"is_queueing": [
{
"12": true
}
],
"status": "Finalisiert",
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"processings": {
"data": [
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
]
}
}
],
"meta": {
"pagination": {
"total": 32,
"count": 10,
"per_page": 10,
"current_page": 2,
"total_pages": 4,
"links": {
"previous": "string",
"next": "string"
}
}
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Create project / collection
Create a new project and return the inserted information. Associate the project with the currently authenticated user.
- name: string
-
Project name
- description: string
-
Project description
- is_deprecated_campaign: boolean
-
indicates if deprecated way for product creation is used (use 1/0 instead of true/false)
Request Example
{
"name": "My cool project",
"description": "My cool project",
"is_deprecated_campaign": "0"
}
Success
Response Example (200 OK)
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"name": "My cool project",
"type": "ondemand",
"products_count": 3,
"is_published": true,
"is_syncing": [
{
"12": true
}
],
"is_queueing": [
{
"12": true
}
],
"status": "Finalisiert",
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"processings": {
"data": [
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
]
}
}
| cockpit_apikey | |
| cockpit_oauth | write-project |
Get project / collection
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: products, productInfo
Unique project identifier
Success
Project not found
Response Example (200 OK)
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"name": "My cool project",
"type": "ondemand",
"products_count": 3,
"is_published": true,
"is_syncing": [
{
"12": true
}
],
"is_queueing": [
{
"12": true
}
],
"status": "Finalisiert",
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"processings": {
"data": [
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
]
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Update project / Collection
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",
"name": "My cool project",
"type": "ondemand",
"products_count": 3,
"is_published": true,
"is_syncing": [
{
"12": true
}
],
"is_queueing": [
{
"12": true
}
],
"status": "Finalisiert",
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"processings": {
"data": [
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
]
}
}
| cockpit_apikey | |
| cockpit_oauth | read-project |
Delete project / collection
Delete the selected project.
Unique project identifier
Success, project deleted
Project not found
Project could not be dleted due to problems to delete product integrations
Get products for a project / collection
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
Unique project identifier
Success
Project not found
Response Example (200 OK)
[
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{}
]
}
}
}
]
| 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 coupon info
Retrieve information about a single order coupon.
Alphanumerical coupon identifier as provided to the customer
Success
Coupon not found
Response Example (200 OK)
{
"coupon_code": "Shirt-coupon-XYZ",
"coupon_type": "discount",
"discount_type": "euro",
"discount_percent": 10,
"discount_netto": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"discount_brutto": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"is_active": true,
"min_order_value": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"is_expired": false,
"expiration_date": "2017-01-01 12:34:56",
"n_activations": "1",
"remaining_activations": "1",
"new_user_only": "1",
"rate_limit_exceeded": "1",
"has_orders": "1"
}
| cockpit_apikey | |
| cockpit_oauth | read-order |
Get all orders
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: parent, children, comments, products, warehouseProducts, payments, orderStatusEntries, shipping, packins
Page number
Filter by order status id
Items per page
Search query
Property to order by
Order direction
Days to show (default: all)
Secondary filter level (e.g. filter reprint orders)
Success
Response Example (200 OK)
{
"data": [
{
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"invoice_reference": "string",
"fulfillment": {},
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"total_items": 5,
"add_delivery_receipt": true,
"delivery_receipt_logo_reference": "A456HJ",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"products": {
"data": [
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"campaign_reference": "F7S33M2",
"campaign_name": "Example Project",
"campaign_product_id": "123"
}
]
},
"packins": {}
}
]
}
| 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. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- 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. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- sender: OrderAddress
-
Create order
Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- products: object[]
-
Selected products created upfront via create product endpoint. It is not possible to order blank baseProducts.
- packaging_branding: object[]
-
Selected packaging brandings (optional)
- default_product_branding: object[]
-
Selected default product brandings (optional)
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- use_custom_product_name: boolean
-
Indicates if your custom product names are used on the delivery note (default = false)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- fulfillment_mode_key: string
-
Choose a special fulfilment mode for this order.
- billing_method_reference: string
-
Reference of billing method used for this order.
- external_reference: string
-
Your internal reference for the order, that will be added to the delivery note.
- check_unique_external_reference: boolean
-
This attribute validates whether the external reference provided has been used for any other order within your account, ensuring the prevention of duplicate orders.
Request Example
{
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"products": [
{
"sku": "c123456.122.8",
"amount": 2,
"customizations": [
{
"my_textfield_1": "John",
"my_textfield_2": "Doe"
}
],
"branding": {
"hangtag_reference": "A12345",
"product_packaging_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345"
}
},
{
"sku": "WV-044E8BAB7F",
"amount": 2
},
{
"base_product_sku": "STTK909C71012",
"external_reference": "EX-123",
"custom_name": "My product name",
"sales_price_gross": "2199",
"amount": 1,
"processings": [
{
"design_url": "https://mydomain.com/myimage.png",
"width": 100,
"height": 80,
"processingarea_type": "front",
"processingposition": "chest-center",
"processingmethod": "dtg",
"offset_top": 20,
"offset_center": 0,
"force_position": false
}
]
}
],
"packaging_branding": [
{
"first_packin_reference": "A12345",
"second_packin_reference": "A12345",
"order_packaging_reference": "A12345",
"sticker_reference": "A12345"
}
],
"default_product_branding": [
{
"hangtag_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345",
"product_packaging_reference": "A12345"
}
],
"is_onhold": "true",
"use_custom_product_name": "true",
"add_delivery_receipt": "true",
"delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"fulfillment_mode_key": "24h-express",
"billing_method_reference": "F80D66CF",
"external_reference": "your internal order reference",
"check_unique_external_reference": "true"
}
Success, order has been created
Unauthorized (no credentials or not eligible for ordering)
Validation failed, details in response body
Response Example (201 Created)
{
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"invoice_reference": "string",
"fulfillment": {},
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"total_items": 5,
"add_delivery_receipt": true,
"delivery_receipt_logo_reference": "A456HJ",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"products": {
"data": [
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"campaign_reference": "F7S33M2",
"campaign_name": "Example Project",
"campaign_product_id": "123"
}
]
},
"packins": {
"data": [
null
]
}
}
| cockpit_apikey | |
| cockpit_oauth | write-order |
Get order
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: parent, children, comments, products, warehouseProducts, payments, orderStatusEntries, shipping, packins
Alphanumerical order identifier
Success
Order not found
Response Example (200 OK)
{
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"invoice_reference": "string",
"fulfillment": {},
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"total_items": 5,
"add_delivery_receipt": true,
"delivery_receipt_logo_reference": "A456HJ",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"products": {
"data": [
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"campaign_reference": "F7S33M2",
"campaign_name": "Example Project",
"campaign_product_id": "123"
}
]
},
"packins": {
"data": [
null
]
}
}
| cockpit_apikey | |
| cockpit_oauth | read-order |
Release onhold
Orders with Flag Onhold will not be send to production until flag is released. Only Orders having completely rendered Images can be released.
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
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 |
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: 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. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- sender: OrderAddress
-
Create order
Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- products: object[]
-
Selected products created upfront via create product endpoint. It is not possible to order blank baseProducts.
- packaging_branding: object[]
-
Selected packaging brandings (optional)
- default_product_branding: object[]
-
Selected default product brandings (optional)
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- use_custom_product_name: boolean
-
Indicates if your custom product names are used on the delivery note (default = false)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- fulfillment_mode_key: string
-
Choose a special fulfilment mode for this order.
- billing_method_reference: string
-
Reference of billing method used for this order.
- external_reference: string
-
Your internal reference for the order, that will be added to the delivery note.
- check_unique_external_reference: boolean
-
This attribute validates whether the external reference provided has been used for any other order within your account, ensuring the prevention of duplicate orders.
Request Example
{
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"products": [
{
"sku": "c123456.122.8",
"amount": 2,
"customizations": [
{
"my_textfield_1": "John",
"my_textfield_2": "Doe"
}
],
"branding": {
"hangtag_reference": "A12345",
"product_packaging_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345"
}
},
{
"sku": "WV-044E8BAB7F",
"amount": 2
},
{
"base_product_sku": "STTK909C71012",
"external_reference": "EX-123",
"custom_name": "My product name",
"sales_price_gross": "2199",
"amount": 1,
"processings": [
{
"design_url": "https://mydomain.com/myimage.png",
"width": 100,
"height": 80,
"processingarea_type": "front",
"processingposition": "chest-center",
"processingmethod": "dtg",
"offset_top": 20,
"offset_center": 0,
"force_position": false
}
]
}
],
"packaging_branding": [
{
"first_packin_reference": "A12345",
"second_packin_reference": "A12345",
"order_packaging_reference": "A12345",
"sticker_reference": "A12345"
}
],
"default_product_branding": [
{
"hangtag_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345",
"product_packaging_reference": "A12345"
}
],
"is_onhold": "true",
"use_custom_product_name": "true",
"add_delivery_receipt": "true",
"delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"fulfillment_mode_key": "24h-express",
"billing_method_reference": "F80D66CF",
"external_reference": "your internal order reference",
"check_unique_external_reference": "true"
}
Success, price has been calculated
Validation failed, details in response body
Response Example (200 OK)
{
"products_net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"shipping_net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"total_net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"total_gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"included_tax": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"included_tax_rate": 19
}
Get available fulfillment modes
Get a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect the available options in a checkout process.
- 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. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- sender: OrderAddress
-
Create order
Submit a new order for the currently authenticated user. The user must have at least one registered billing method. The sender information is optional, if not provided, the current user information will be used. You can either order an existing product from your account by entering the sku from the corresponding variant. The sku can be found in the product.colors.sizes array or by downloading the csv export for the collection/project. This way is also used to order warehouseProducts (sku starts with "WV-"). If you want to order non-existing products, please refer to the part of the example request that contains the base_product_sku. The base_product_sku defines the color-size variant of the baseProduct. Our complete catalog can be downloaded as xlsx in the Cockpit dashboard (Import -> Download -> product catalog). You can customize the baseProductVariant with multiple processing areas (front + back). to This workflow is commonly used if each order has a unique design (e.g. customized products).
- products: object[]
-
Selected products created upfront via create product endpoint. It is not possible to order blank baseProducts.
- packaging_branding: object[]
-
Selected packaging brandings (optional)
- default_product_branding: object[]
-
Selected default product brandings (optional)
- is_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- use_custom_product_name: boolean
-
Indicates if your custom product names are used on the delivery note (default = false)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to delivery (default = true)
- delivery_receipt_logo_reference: string
-
Logo printed on delivery receipt (optional)
- delivery_receipt_note: string
-
Custom note printed on delivery receipt
- fulfillment_mode_key: string
-
Choose a special fulfilment mode for this order.
- billing_method_reference: string
-
Reference of billing method used for this order.
- external_reference: string
-
Your internal reference for the order, that will be added to the delivery note.
- check_unique_external_reference: boolean
-
This attribute validates whether the external reference provided has been used for any other order within your account, ensuring the prevention of duplicate orders.
Request Example
{
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"products": [
{
"sku": "c123456.122.8",
"amount": 2,
"customizations": [
{
"my_textfield_1": "John",
"my_textfield_2": "Doe"
}
],
"branding": {
"hangtag_reference": "A12345",
"product_packaging_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345"
}
},
{
"sku": "WV-044E8BAB7F",
"amount": 2
},
{
"base_product_sku": "STTK909C71012",
"external_reference": "EX-123",
"custom_name": "My product name",
"sales_price_gross": "2199",
"amount": 1,
"processings": [
{
"design_url": "https://mydomain.com/myimage.png",
"width": 100,
"height": 80,
"processingarea_type": "front",
"processingposition": "chest-center",
"processingmethod": "dtg",
"offset_top": 20,
"offset_center": 0,
"force_position": false
}
]
}
],
"packaging_branding": [
{
"first_packin_reference": "A12345",
"second_packin_reference": "A12345",
"order_packaging_reference": "A12345",
"sticker_reference": "A12345"
}
],
"default_product_branding": [
{
"hangtag_reference": "A12345",
"imprint_reference": "A12345",
"label_reference": "A12345",
"product_packaging_reference": "A12345"
}
],
"is_onhold": "true",
"use_custom_product_name": "true",
"add_delivery_receipt": "true",
"delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_note": "Use Voucher XYZ for a 10% discount.",
"fulfillment_mode_key": "24h-express",
"billing_method_reference": "F80D66CF",
"external_reference": "your internal order reference",
"check_unique_external_reference": "true"
}
Success
Validation failed, details in response body
Response Example (200 OK)
{
"data": [
{
"key": "24h-express",
"name": "24h Express",
"description": "The order is produced and handed to the carrier within 24h",
"is_per_order": "true",
"price_net": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"fulfillment_days": "1",
"sort_weight": "22"
}
]
}
Retry payment
Set the order payment method to the current user's payment method and retry credit card capture.
Alphanumerical order identifier
Success, order has been paid.
Payment failed (either duplicate payment or an error occured).
| cockpit_apikey | |
| cockpit_oauth | read-order |
Cancel order
Set the order status to canceled.
Alphanumerical order identifier
Success, order has been canceled.
Order not found
| cockpit_apikey | |
| cockpit_oauth | write-order |
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 |
integration
Endpoints in this section control data about integrations to 3rd party applications for fullfilments. Integrations may only be updated or deleted via API while the initial installation of integrations is performed in the user dashboard
Get UserIntegration
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: fulfillmentPolicy, regions, defaultStock
- syncs: integer
-
Includes current product states
Request Example
{
"syncs": "integer"
}
Success
integration not found
Response Example (200 OK)
{
"id": 111,
"app": "shopify",
"name": "my-cool-shirtstore.myshopify.com",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"expires_in": "2018-01-01 12:34:56",
"image_type": "png",
"image_quality": "high",
"fulfillment_mode_key": "24h-express",
"is_pull_orders": "true",
"is_auto_pull_orders": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_imprint_reference": "ABC123",
"default_label_reference": "ABC123",
"default_product_packaging_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"default_sticker_reference": "ABC123",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"sticker_logo": "https://example.com/custom_logo.png",
"is_auto_onhold": true,
"is_refresh_token_expired": false
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
Update UserIntegration
Update settings for a single user integration.
The endpoint returns the updated integration.
- image_type: string
-
The image file format. Available options are jpg and png
- image_quality: string
-
Image resolution quality flag for transferred images. Available options are low and high
- is_auto_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- is_auto_pull_orders: boolean
-
Indicates if orders will be pulled and processed by Cockpit automatically (default = false)
- default_first_packin_reference: string
-
Default first packin added to orders received via this intergrations (optional)
- default_second_packin_reference: string
-
Default second packin added to orders received via this intergrations (optional)
- default_hangtag_reference: string
-
Default hangtag added to all textil products of orders received via this intergrations (optional)
- default_imprint_reference: string
-
Default imprinted added to all tagless 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_product_packaging_reference: string
-
Default packaging used for all textil products of orders received via this intergrations (optional)
- default_order_packaging_reference: string
-
Default packging used for all orders received via this intergrations (optional)
- default_sticker_reference: string
-
Default sticker applied to packaging of orders received via this intergrations (optional)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to orders received via this intergrations
- 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_product_inventory: integer
-
Default stock-inventory for UserIntegration (Optional)
- fulfillment_mode_key: string
-
Key of the fulfillment mode to be used if available for orders with this integration
- fulfillmentPolicy: object[]
-
Fulfillment-Policy
- regions: object[]
-
Declaration of regions a packet will be sent to
Request Example
{
"image_type": "string",
"image_quality": "string",
"is_auto_onhold": true,
"is_auto_pull_orders": true,
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_imprint_reference": "ABC123",
"default_label_reference": "ABC123",
"default_product_packaging_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"default_sticker_reference": "ABC123",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"default_product_inventory": "5",
"fulfillment_mode_key": "24h-express",
"fulfillmentPolicy": [
{
"national_shipping_cost": "2.00",
"international_shipping_cost": "2.00",
"international_additional_shipping_cost": "2.00",
"handling_time": "5"
}
],
"regions": [
{
"region_included": "Worldwide"
}
]
}
Success, URL has been processed
Error, Something goes wrong
| cockpit_apikey | |
| cockpit_oauth | write-user |
Delete UserIntegration
Uninstall this integration from your 3rd party store and delete the integration. IMPORTANT: all synchronized products will be deleted as well in the 3rd party store.
Unique design identifier
Success, integration uninstalled and deleted
integration not found
| cockpit_apikey | |
| cockpit_oauth | write-user |
Get UserIntegration
Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: colors, base_product, active_integration_syncs, integration_sync_log, integration_products, projectProductColors
- syncs: integer
-
Includes current product states
Request Example
{
"syncs": "integer"
}
Success
integration not found
Response Example (200 OK)
{
"id": 111,
"app": "shopify",
"name": "my-cool-shirtstore.myshopify.com",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"expires_in": "2018-01-01 12:34:56",
"image_type": "png",
"image_quality": "high",
"fulfillment_mode_key": "24h-express",
"is_pull_orders": "true",
"is_auto_pull_orders": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_imprint_reference": "ABC123",
"default_label_reference": "ABC123",
"default_product_packaging_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"default_sticker_reference": "ABC123",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"sticker_logo": "https://example.com/custom_logo.png",
"is_auto_onhold": true,
"is_refresh_token_expired": false
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
Get OrderReference
Get shirtigo order reference for given integrationId and integration orderId
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
other
This section contains miscellaneous endpoints.
Calculate production cost
Calculate the net production cost for a given product, set of print areas and color information. The VAT rate rate is preliminary, the final rate depends on the shipping target, involvement of business customers and other factors.
- is_colored: boolean
-
Is this a color print?
- printareas: integer[]
-
Desired print areas
- product_id: integer
-
Desired base product
Request Example
{
"is_colored": true,
"printareas": [
"integer"
],
"product_id": 375
}
Success
Product not found
Response Example (200 OK)
{
"vat_rate": 19,
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
}
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": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"month": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"week": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"today": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"total_amount": 36,
"month_amount": 14,
"week_amount": 3,
"today_amount": 1
}
Get all fulfillment_modes
Retrieve a list of available fulfillment_modes, which are available to authenticated user.
Success
Response Example (200 OK)
{
"data": [
{
"key": "24h-express",
"name": "24h Express",
"description": "The order is produced and handed to the carrier within 24h",
"is_per_order": "true",
"price_net": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"fulfillment_days": "1",
"sort_weight": "22"
}
]
}
orderProduct
Customize OrderProduct
Customize an existing OrderProduct for the currently authenticated user.
Reference of design
Processingarea to be customized. 1 = front, 2 = back
Width of design in millimeter
Offset to collar in millimeter
x-shift to centerline in millimeter
Success, orderProduct customized
| cockpit_apikey | |
| cockpit_oauth | write-project |
warehousing
GET /warehousing/shipments/{reference}
Return the WarehouseInboundShipment. Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: items
Reference of the Variant to be updated
Which linked entities you want to include into the response, separated by comma. Available includes are Items
Success
WarehouseInboundShipment not found
Response Example (200 OK)
{
"id": "1",
"reference": "A1234567",
"name": "Warehouse inbound shipment",
"carrier": "DHL",
"tracking_number": "AA123345567BB",
"url": "https://dhl.com/tracking",
"count": 5,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
DELETE /warehousing/shipments/{reference}
Deletes WarehouseInboundShipment
Reference of the InboundShipment to be deleted
Success
WarehouseInboundShipment not found
Response Example (200 OK)
{
"id": "1",
"reference": "A1234567",
"name": "Warehouse inbound shipment",
"carrier": "DHL",
"tracking_number": "AA123345567BB",
"url": "https://dhl.com/tracking",
"count": 5,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
GET /warehousing/inventory
Returns the list of WarehouseProductVariants assiciated with the particular User.
Which linked entities you want to include into the response, separated by comma. Available includes are Image and Product
Search in in variants by the name
Current page
Number of items per page
Column used to sort the results. You can sort by: name, reference, created_at, updated_at
Direction for sorting
Success
Response Example (200 OK)
{
"data": [
{
"id": "1",
"reference": "A12345",
"product_reference": "A12345",
"name": "Warehouse product variant name",
"description": "Warehouse product variant description",
"color_id": "1",
"size_id": "1",
"color": "Red",
"size": "XL",
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"item_value": 300,
"net_sales_price": 25,
"shirtigo_price": 20,
"min_stock_quantity": 100,
"needs_box_shipping": "true",
"country_of_origin": "DE",
"hs_code": "A123123",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56",
"is_stored": "true",
"is_approved": "true",
"is_rejected": "false",
"stock_amount": 100
}
],
"meta": {
"pagination": {
"total": 32,
"count": 10,
"per_page": 10,
"current_page": 2,
"total_pages": 4,
"links": {
"previous": "string",
"next": "string"
}
}
}
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
GET /warehousing/products/{reference}
Return the WarehouseProduct. Some of the listed resources are available as optional includes (add to the query ?include=firstInclude,secondInclude.subInclude). The available includes for this endpoint are: variant, variants
Reference of the Variant to be updated
Which linked entities you want to include into the response, separated by comma. Available includes are Variant and Variants
Success
WarehouseProduct not found
Response Example (200 OK)
{
"id": "1",
"reference": "A12345",
"name": "Warehouse product name",
"description": "Warehouse product description",
"hs_code": "A123123",
"country_of_origin": "DE",
"color_id": "1",
"item_value": 300,
"net_sales_price": 25,
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"needs_box_shipping": "true",
"min_stock_quantity": 100,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
PUT /warehousing/products/{reference}
Updates WarehouseProduct with default Variant and associated Variants
- name: string
-
Project name
- description: string
-
Project description
- size: string
-
Size of the default product's variant
- color: string
-
Color of the default product's variant
- hs_cde: string
-
HS Code of default product's variant
- country_of_origin: string
-
Country of Origin of default product's variant
- item_value: integer
-
Item value in cents of default product's variant
- net_sales_price: integer
-
Net sales price in cents of default product's variant
- depth_cm: integer
-
Depth in cm of default product's variant
- width_cm: integer
-
Width in cm of default product's variant
- height_cm: integer
-
Height in cm of default product's variant
- weight_gram: integer
-
Weight in grams of default product's variant
- needs_box_shipping: boolean
-
Indicates whether the default product's variant should be shipping in a box
- min_stock_quantity: integer
-
Minimal stock quantity of default product's variant
- image: Media
-
WarehouseProduct variant image
- variants: WarehouseProductVariant
-
The array of variants of the WarehouseProduct, excluding default one
Reference of the WarehouseProduct to be updated
Request Example
{
"name": "My cool warehouse product",
"description": "My cool warehouse product's description",
"size": "S",
"color": "white",
"hs_cde": "DE123456",
"country_of_origin": "DE",
"item_value": "52000",
"net_sales_price": "1250",
"depth_cm": "30",
"width_cm": "30",
"height_cm": "30",
"weight_gram": "30",
"needs_box_shipping": "false",
"min_stock_quantity": "100",
"image": {
"reference": "A12345",
"url": "https://example.com/image.png",
"filename": "image.png"
},
"variants": [
{
"id": "1",
"reference": "A12345",
"product_reference": "A12345",
"name": "Warehouse product variant name",
"description": "Warehouse product variant description",
"color_id": "1",
"size_id": "1",
"color": "Red",
"size": "XL",
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"item_value": 300,
"net_sales_price": 25,
"shirtigo_price": 20,
"min_stock_quantity": 100,
"needs_box_shipping": "true",
"country_of_origin": "DE",
"hs_code": "A123123",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56",
"is_stored": "true",
"is_approved": "true",
"is_rejected": "false",
"stock_amount": 100
}
]
}
Success
WarehouseProduct not found
Response Example (200 OK)
{
"id": "1",
"reference": "A12345",
"name": "Warehouse product name",
"description": "Warehouse product description",
"hs_code": "A123123",
"country_of_origin": "DE",
"color_id": "1",
"item_value": 300,
"net_sales_price": 25,
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"needs_box_shipping": "true",
"min_stock_quantity": 100,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
POST /warehousing/products
Creates WarehouseProduct with default Variant and associated Variants
- name: string
-
Project name
- description: string
-
Project description
- size: string
-
Size of the default product's variant
- color: string
-
Color of the default product's variant
- hs_cde: string
-
HS Code of default product's variant
- country_of_origin: string
-
Country of Origin of default product's variant
- item_value: integer
-
Item value in cents of default product's variant
- net_sales_price: integer
-
Net sales price in cents of default product's variant
- depth_cm: integer
-
Depth in cm of default product's variant
- width_cm: integer
-
Width in cm of default product's variant
- height_cm: integer
-
Height in cm of default product's variant
- weight_gram: integer
-
Weight in grams of default product's variant
- needs_box_shipping: boolean
-
Indicates whether the default product's variant should be shipping in a box
- min_stock_quantity: integer
-
Minimal stock quantity of default product's variant
- image: Media
-
WarehouseProduct image
- variants: WarehouseProductVariant
-
The array of variants of the WarehouseProduct, excluding default one
Request Example
{
"name": "My cool warehouse product",
"description": "My cool warehouse product's description",
"size": "S",
"color": "white",
"hs_cde": "DE123456",
"country_of_origin": "DE",
"item_value": "52000",
"net_sales_price": "1250",
"depth_cm": "30",
"width_cm": "30",
"height_cm": "30",
"weight_gram": "30",
"needs_box_shipping": "false",
"min_stock_quantity": "100",
"image": {
"reference": "A12345",
"url": "https://example.com/image.png",
"filename": "image.png"
},
"variants": [
{
"id": "1",
"reference": "A12345",
"product_reference": "A12345",
"name": "Warehouse product variant name",
"description": "Warehouse product variant description",
"color_id": "1",
"size_id": "1",
"color": "Red",
"size": "XL",
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"item_value": 300,
"net_sales_price": 25,
"shirtigo_price": 20,
"min_stock_quantity": 100,
"needs_box_shipping": "true",
"country_of_origin": "DE",
"hs_code": "A123123",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56",
"is_stored": "true",
"is_approved": "true",
"is_rejected": "false",
"stock_amount": 100
}
]
}
Success
Response Example (200 OK)
{
"id": "1",
"reference": "A12345",
"name": "Warehouse product name",
"description": "Warehouse product description",
"hs_code": "A123123",
"country_of_origin": "DE",
"color_id": "1",
"item_value": 300,
"net_sales_price": 25,
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"needs_box_shipping": "true",
"min_stock_quantity": 100,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
PUT /warehousing/products/{product_reference}/variants/{reference}
Updates WarehouseProductVariant
- name: string
-
Project name
- description: string
-
Project description
- size: string
-
Size of the product's variant
- color: string
-
Color of the product's variant
- hs_cde: string
-
HS Code of product's variant
- country_of_origin: string
-
Country of Origin of product's variant
- item_value: integer
-
Item value in cents of product's variant
- net_sales_price: integer
-
Net sales price in cents of product's variant
- depth_cm: integer
-
Depth in cm of product's variant
- width_cm: integer
-
Width in cm of product's variant
- height_cm: integer
-
Height in cm of product's variant
- weight_gram: integer
-
Weight in grams of product's variant
- needs_box_shipping: boolean
-
Indicates whether the product's variant should be shipping in a box
- min_stock_quantity: integer
-
Minimal stock quantity of product's variant
- image: Media
-
WarehouseProduct variant image
Reference of the WarehouseProduct to which the updated Variant belongs to
Reference of the Variant to be updated
Request Example
{
"name": "My cool warehouse product variant",
"description": "My cool warehouse product variant's description",
"size": "S",
"color": "white",
"hs_cde": "DE123456",
"country_of_origin": "DE",
"item_value": "52000",
"net_sales_price": "1250",
"depth_cm": "30",
"width_cm": "30",
"height_cm": "30",
"weight_gram": "30",
"needs_box_shipping": "false",
"min_stock_quantity": "100",
"image": {
"reference": "A12345",
"url": "https://example.com/image.png",
"filename": "image.png"
}
}
Success
WarehouseProductVariant not found
Response Example (200 OK)
{
"id": "1",
"reference": "A12345",
"product_reference": "A12345",
"name": "Warehouse product variant name",
"description": "Warehouse product variant description",
"color_id": "1",
"size_id": "1",
"color": "Red",
"size": "XL",
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"item_value": 300,
"net_sales_price": 25,
"shirtigo_price": 20,
"min_stock_quantity": 100,
"needs_box_shipping": "true",
"country_of_origin": "DE",
"hs_code": "A123123",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56",
"is_stored": "true",
"is_approved": "true",
"is_rejected": "false",
"stock_amount": 100
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
DELETE /warehousing/products/{product_reference}/variants/{reference}
Deletes WarehouseProductVariant
Reference of the WarehouseProduct to which the deleted Variant belongs to
Reference of the Variant to be deleted
Success
WarehouseProductVariant not found
Response Example (200 OK)
{
"id": "1",
"reference": "A12345",
"product_reference": "A12345",
"name": "Warehouse product variant name",
"description": "Warehouse product variant description",
"color_id": "1",
"size_id": "1",
"color": "Red",
"size": "XL",
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"item_value": 300,
"net_sales_price": 25,
"shirtigo_price": 20,
"min_stock_quantity": 100,
"needs_box_shipping": "true",
"country_of_origin": "DE",
"hs_code": "A123123",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56",
"is_stored": "true",
"is_approved": "true",
"is_rejected": "false",
"stock_amount": 100
}
| cockpit_apikey | |
| cockpit_oauth | read-user |
Schema Definitions
Payment: object
- id: string
-
Unique transaction identifier
- status: string
-
Payment type
- status_title: string
-
Payment description
- payment_reference: string
-
Payment reference
- order: Order
-
Order
- net_amount: Money
-
Net price
- gross_amount: Money
-
Gross price
- vat_amount: Money
-
VAT amount
- vat_rate: integer
-
VAT rate in percent
- created_at: string
-
Timestamp of creation
Example
{
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"status": "invoice",
"status_title": "Erstattung",
"payment_reference": "Kreditkarte",
"order": {
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"invoice_reference": "string",
"fulfillment": {},
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"total_items": 5,
"add_delivery_receipt": true,
"delivery_receipt_logo_reference": "A456HJ",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"products": {
"data": [
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"campaign_reference": "F7S33M2"
}
]
}
}
}
CampaignIntegrationProduct: object
- integration_id: integer
-
The cockpit internal id of the used user integration
- integration_product_id: string
-
The identifier used by the integration application
- updated_at: string
-
Timestamp of last update
Example
{
"integration_id": 111,
"integration_product_id": "9286211826",
"updated_at": "2017-01-01 12:34:56"
}
ProjectPrint: object
- area: string
-
Processing site
- position: string
-
Processing position
- method: string
-
Processing method
- height: integer
-
Design height in millimeters
- width: integer
-
Design width in millimeters
- offset_top: integer
-
Vertical offset from top in millimeters
- offset_center: integer
-
Horizontal offset from center in millimeters
- updated_at: string
-
Timestamp of last update
- design: Design
Example
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
CampaignProductIntegrationSync: object
- integration_name: string
-
Name of the integration application
- integration_id: integer
-
The cockpit internal id of the used user integration
- integration_product_id: string
-
The identifier used by the integration application
- is_syncing: boolean
-
Is the product available?
- is_successful: boolean
-
Has the product been rendered?
- in_queue: boolean
-
Is the current sync-process still in queue?
- error: string
-
Error message
- updated_at: string
-
Timestamp of last update
Example
{
"integration_name": "shopify",
"integration_id": 111,
"integration_product_id": "9286211826",
"is_syncing": true,
"is_successful": true,
"in_queue": true,
"error": "Invalid or missing auth.",
"updated_at": "2017-01-01 12:34:56"
}
CampaignProduct: object
- id: integer
-
Numerical identifier
- project: string
-
Project reference
- project_name: string
-
Project name
- name: string
-
Product name
- custom_name: string
-
User defined product name
- description: string
-
Short description in HTML format
- tags: string[]
-
List of tags for this design
- price: Money
-
Net price
- sort_position: integer
-
Numerical identifier
- colors: ProductColor
-
List of available colors
- is_available: boolean
-
Is the product available?
- is_rendered: boolean
-
Has the product been rendered?
- has_express: boolean
-
Is the product available for express processing?
- images: UtilProductImage
-
Product images
- base_product: Product
-
Base product
- active_integration_syncs: CampaignProductIntegrationSync
-
List of currently active synchronizations with integrations
- integration_sync_log: CampaignProductIntegrationSync
-
History of synchronizations with integrations for this product
- integration_products: CampaignIntegrationProduct
-
List of integration products (e.g. products in shopify) for this products
- updated_at: string
-
Timestamp of last update
Example
{
"id": 123,
"project": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"project_name": "Projekt 123",
"name": "Base Product Name XY",
"custom_name": "My cool product",
"description": "string",
"tags": [
"string"
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_position": 0,
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"is_available": true,
"is_rendered": true,
"has_express": false,
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {
"amount": 999
}
}
]
}
}
}
UtilProductImage: object
- id: integer
-
id of the image object
- color: string
-
Color name
- area: string
-
Processing area name
- urls: object
-
Product name
Example
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
Project: object
- reference: string
-
Unique identifier of this project
- name: string
-
Project name
- type: string
-
Type
- products_count: integer
-
Number of products
- is_published: boolean
-
Has the project been published?
- is_syncing: boolean[][]
-
Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently syncing.
- is_queueing: boolean[][]
-
Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently in queue.
- status: string
-
Project status
- updated_at: string
-
Timestamp of last update
- created_at: string
-
Timestamp of initial creation
- processings: object
-
Processings associated with this project
Example
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"name": "My cool project",
"type": "ondemand",
"products_count": 3,
"is_published": true,
"is_syncing": [
{
"12": true
}
],
"is_queueing": [
{
"12": true
}
],
"status": "Finalisiert",
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"processings": {
"data": [
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
]
}
}
ProjectWithProducts:
Example
{
"products": [
{
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
}
}
],
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"name": "My cool project",
"type": "ondemand",
"products_count": 3,
"is_published": true,
"is_syncing": [
{
"12": true
}
],
"is_queueing": [
{
"12": true
}
],
"status": "Finalisiert",
"updated_at": "2017-01-01 12:34:56",
"created_at": "2017-01-01 12:34:56",
"processings": {
"data": [
{
"area": "front",
"position": "center",
"method": "print",
"height": 300,
"width": 200,
"offset_top": 50,
"offset_center": 0,
"updated_at": "2017-01-01 12:34:56",
"design": {
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
}
]
}
}
Coupon: object
- coupon_code: string
-
The identifier on the promo coupon
- coupon_type: string
-
The type of the coupon (discount, free shipping, etc.)
- discount_type: string
-
The type of discount, either percentage or euro
- discount_percent: integer
-
The granted discount in percent on the cart value without handling and shipping (filled for discount type percentage)
- discount_netto: Money
-
The granted discount without sales taxes in euro cent (filled for discount type euro)
- discount_brutto: Money
-
The gross granted discount in euro cent (filled for discount type euro)
- is_active: boolean
-
Activation status of coupon
- min_order_value: Money
-
Minimal total value in euro cents for an order to make this coupon applicable
- is_expired: boolean
-
Flag to indicate if the coupon is expired
- expiration_date: string
-
Timestamp for the validity of the coupon code
- n_activations: integer
-
Number of usages for this coupon
- remaining_activations: integer
-
Number of remaining usages for this coupon
- new_user_only: integer
-
Flag to indicate if the coupon is for new users only
- rate_limit_exceeded: integer
-
Flag to indicate if the coupon was used too often in the last hour.
- has_orders: integer
-
Flag to indicate if orders for user exist.
Example
{
"coupon_code": "Shirt-coupon-XYZ",
"coupon_type": "discount",
"discount_type": "euro",
"discount_percent": 10,
"discount_netto": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"discount_brutto": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"is_active": true,
"min_order_value": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"is_expired": false,
"expiration_date": "2017-01-01 12:34:56",
"n_activations": "1",
"remaining_activations": "1",
"new_user_only": "1",
"rate_limit_exceeded": "1",
"has_orders": "1"
}
Country: object
- iso: string
-
Two-letter identifier according to ISO 3166-1
- name: string
-
Country name
Example
{
"iso": "DE",
"name": "Germany"
}
Design: object
- reference: string
-
Unique identifier of this design
- filename: string
-
Design file name
- name: string
-
Design Name
- width: integer
-
Width of the design file in pixels
- height: integer
-
Height of the design file in pixels
- filetype: string
-
Extension of the design file name
- tags: string[]
-
List of tags for this design
- processingmethod_key: string
-
Indicates for which processingmethod the design can be used
- colors: integer
-
Total number of colors in the color palette
- palette: string[]
-
List of hex-codes of representative colors
- complementary_color: string
-
Complementary color
- preview: string
-
URL to preview image
- original_file: string
-
URL to full resolution image
- is_processed: boolean
-
Has the design been rendered?
- is_dark: boolean
-
Is this a design with dark colors?
- is_editable: boolean
-
Indicates if design colors can be updated
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
Example
{
"reference": "9e7aba40-3bce-4639-9caa-9a9a0397cbff",
"filename": "ABCDE",
"name": "My cool design",
"width": 5000,
"height": 3000,
"filetype": "png",
"tags": "summer-collection",
"processingmethod_key": "dtg",
"colors": 5,
"palette": [
"A20061",
"FFBC42",
"1C838A",
"021618",
"A3AAAB"
],
"complementary_color": "",
"preview": "https://example.com/product_prev.png",
"original_file": "https://example.com/product.png",
"is_processed": true,
"is_dark": true,
"is_editable": true,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
FulfillmentMode: object
- key: string
-
A unique key to identify a fulfillment mode
- name: string
-
The name of the fulfillment mode
- description: string
-
A description of the fulfillment conditions for this mode
- is_per_order: boolean
-
Flag to indicate if the surcharge for this mode is per order or per item
- price_net: Money
-
The net price, either per order or per item, dependent in the is_per_order_setting
- fulfillment_days: string
-
The number of fulfillment days for this fulfillment mode
- sort_weight: string
-
Country name
Example
{
"key": "24h-express",
"name": "24h Express",
"description": "The order is produced and handed to the carrier within 24h",
"is_per_order": "true",
"price_net": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"fulfillment_days": "1",
"sort_weight": "22"
}
Media:
- reference: string
-
Reference
- url: string
-
Media url
- filename: string
-
The basename of the file
Example
{
"reference": "A12345",
"url": "https://example.com/image.png",
"filename": "image.png"
}
OrderComment: object
- id: integer
-
ID of the order comment
- comment: string
-
Text of the order comment
- created_at: string
-
Timestamp of creation
Example
{
"id": "integer",
"comment": "Great communication with customer",
"created_at": "2017-01-01 12:34:56"
}
OrderPackin: object
Example
{
"id": "integer",
"amount": 1,
"name": "Greeting card",
"type": "hangtag",
"net_total_price": 75,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
}
}
OrderPayment: object
- id: string
-
Unique transaction identifier
- status: string
-
Payment status
- status_details: string
-
Payment error description (if there is any)
- type: string
-
Payment type
- net_amount: Money
-
Net price
- gross_amount: Money
-
Gross price
- vat_amount: Money
-
VAT amount
- vat_rate: integer
-
VAT rate in percent
- updated_at: string
-
Timestamp of last update
Example
{
"id": "d1364568-4b15-4706-89f1-2452efe1261d",
"status": "paid",
"status_details": "An error occured.",
"type": "creditcard",
"net_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"updated_at": "2017-01-01 12:34:56"
}
OrderProduct: object
- id: integer
-
Product id
- amount: integer
-
Number of items
- name: string
-
Product name
- color: string
-
Color name
- size: string
-
Size name
- images: UtilProductImage
-
Available image URLs
- net_total_price: Money
-
Total price (net_unit_price*amount)
- net_unit_price: Money
-
Net unit price
- campaign_reference: string
-
Reference of the campaign
- campaign_name: string
-
Name of the campaign
- campaign_product_id: int
-
ID of the campaign product
Example
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"campaign_reference": "F7S33M2",
"campaign_name": "Example Project",
"campaign_product_id": "123"
}
OrderRelation: object
- reference: string
-
Unique identifier of this order
- net_price: Money
-
Total net price of this order
- gross_price: Money
-
Total gross price of this order
- vat_rate: integer
-
VAT rate in percent
- vat_amount: Money
-
VAT amount
- status: string
-
Human readable order status
- status_key: string
-
Number of products
- total_items: integer
-
Total number of items in the order
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
Example
{
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"total_items": 5,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
OrderShipping: object
- type: string
-
Shipping type
- cost: Money
-
Shipping price
- is_shipped: boolean
-
Has the order been shipped yet?
- country_code: string
-
Two letter country code
- tracking_code: string
-
Carrier tracking code
- tracking_url: string
-
Carrier tracking URL
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
Example
{
"type": "delivery",
"cost": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"is_shipped": false,
"country_code": "DE",
"tracking_code": "string",
"tracking_url": "string",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
OrderStatusEntry: object
- key: string
-
Order status key
- status: string
-
Human readable status
- description: integer
-
Verbose status description
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
Example
{
"key": "string",
"status": "string",
"description": "integer",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
Order: object
- reference: string
-
Unique identifier of this order
- net_price: Money
-
Total net price of this order
- gross_price: Money
-
Total gross price of this order
- vat_rate: integer
-
VAT rate in percent
- vat_amount: Money
-
VAT amount
- status: string
-
Human readable order status
- status_key: string
-
Number of products
- invoice_reference: string
-
Invoice reference
- fulfillment: object
-
Fulfillment details or
falseif no details are available - delivery: OrderAddress
-
Delivery address
- sender: OrderAddress
-
Sender address
- bill: OrderAddress
-
Billing address
- total_items: integer
-
Total number of items in the order
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to order
- delivery_receipt_logo_reference: string
-
Media reference for the logo added to delivery_receipt
- delivery_receipt_note: string
-
Custom note on delivery receipt
- use_custom_product_name: boolean
-
Use custom product name on delivery receipt
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
- products: object
-
Array of products in this order
- packins: object
-
Array of packins and hangtags in this order
- payments: object
-
Array of payments associated with this order
- orderStatusEntries: object
-
Array of status messages associated with this order
- shipping: OrderShipping
-
Details on the shipping method, status and tracking (only present if order is being or has been shipped)
Example
{
"reference": "ABCDXY1",
"net_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"gross_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"vat_rate": 19,
"vat_amount": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"status": "Bestellung offen",
"status_key": "",
"invoice_reference": "string",
"fulfillment": {},
"delivery": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"sender": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"bill": {
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
},
"total_items": 5,
"add_delivery_receipt": true,
"delivery_receipt_logo_reference": "A456HJ",
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"use_custom_product_name": "true",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"products": {
"data": [
{
"id": "integer",
"amount": 1,
"name": "Base product XY",
"color": "Black",
"size": "XL",
"images": [
{
"id": "1222",
"color": "Red",
"area": "front",
"urls": {
"small": "http://www.example.com/my-orders/small.png",
"large": "http://www.example.com/my-orders/large.png"
}
}
],
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"campaign_reference": "F7S33M2",
"campaign_name": "Example Project",
"campaign_product_id": "123"
}
]
},
"packins": {
"data": [
{}
]
}
}
OrderAddress: object
Address
- title: string
-
(Academic) title
- company: string
-
Company name
- firstname: string
-
First name
- lastname: string
-
Last name
- care_of: string
-
Care of (c/o)
- street: string
-
Street and number
- postcode: string
-
ZIP/area code
- city: string
-
City
- country: string
-
A country iso-code (ISO 3166-1 alpha2) as listed in the /delivery-countries endpoint
Example
{
"title": "Dr.",
"company": "Shirtigo GmbH",
"firstname": "Max",
"lastname": "Mustermann",
"care_of": "Gift for Mrs. Doe",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "DE"
}
OrderWarehouseProduct: object
Example
{
"reference": "string",
"amount": 1,
"name": "Base product XY",
"sku": "WP-12345",
"net_total_price": 1375,
"net_unit_price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
}
}
Plan: object
- key: string
-
A unique key to identify a plan
- name: string
-
The name of the plan
- description: string
-
The description of the plan
- type: string
-
The type of the plan
- invoice_period: integer
-
number of month in interval
- invoice_interval: string
-
runtime of plan
- price_net: Money
-
The net price for the plan and the given priode
- sort_weight: integer
-
sort weight of the plan
Example
{
"key": "warehousing",
"name": "Warehousing",
"description": "Warehousing",
"type": "warehousing",
"invoice_period": "1",
"invoice_interval": "month",
"price_net": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"sort_weight": "1"
}
ProductColor: object
- id: integer
-
Numerical identifier
- color: string
-
Color name
- color_hex: string
-
Hexadecimal RGB color value
- is_colored: boolean
-
Is this a non trivial (b/w) color?
- sizes: object[]
-
Available sizes
Example
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
ProductDimensions: object
- size: string
-
Product size name
- width: integer
-
Width in mm
- height: integer
-
Height in mm
Example
{
"size": "XL",
"width": 200,
"height": 500
}
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"
}
ProductManufacturer: object
- id: integer
-
Numerical identifier
- name: string
-
Manufacturer name
Example
{
"id": 123,
"name": "Musterfirma"
}
ProductPrice: object
- price: Money
-
Price
- type: string
-
Variant
Example
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
ProductProcessingArea: object
- position_id: integer
-
Numerical identifier
- position_name: string
-
Name of the printarea
- width_in_mm: integer
-
Width of the printarea in millimeters
- height_in_mm: integer
-
Height of the printarea in millimeters
- width: integer
-
Width of the printarea in pixels
- height: integer
-
Height of the printarea in pixels
- printable_area_margin_from_top: integer
-
Distance between top and processable area top
- template_width: integer
-
Default template width
- template_height: integer
-
Default template height
- template: string
-
Template
Example
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
Product: object
- id: integer
-
Numeric identifier of this product
- name: string
-
Product name
- original_name: string
-
Base product name
- shipping_category: integer
-
Shipping category
- category_id: integer
-
Numerical category identifier
- category: string
-
Category name
- short_description: string
-
Short description
- description: string
-
Detailed description
- sizechart_image: string
-
URL of the product size table image
- is_active: boolean
-
Activation status. Base products may not be available for orders in rare cases.
- manufacturer: ProductManufacturer
-
Manufacturer information
- images: object
-
Product images
- colors: object
-
Color information
- processing_areas: object
-
Available processing areas
- price: object
-
Pricing information
- sales_price: object
-
Pricing information on sales
Example
{
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
},
"sales_price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
}
}
ProvisionalProduct: object
- name: string
-
Product name
- description: string
-
Short description
- colors: ProductColor
-
List of available colors
- price: Money
-
Net price
- base_product: Product
-
Base product
Example
{
"name": "Base product XY",
"description": "string",
"colors": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
],
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"base_product": {
"id": 1,
"name": "Base product XY",
"original_name": "T-Shirt",
"shipping_category": 1,
"category_id": 5,
"category": "Unisex-Shirts",
"short_description": "string",
"description": "string",
"sizechart_image": "string",
"is_active": "boolean",
"manufacturer": {
"id": 123,
"name": "Musterfirma"
},
"images": {
"data": [
{
"sort_position": 1,
"url": "https://www.example.com/image.jpg"
}
]
},
"colors": {
"data": [
{
"id": 123,
"color": "Black",
"color_hex": "#000000",
"is_colored": true,
"sizes": [
{
"id": 67,
"size": "XL",
"is_onlocalstock": true,
"is_available": true,
"sort_position": 1
}
]
}
]
},
"processing_areas": {
"data": [
{
"position_id": 1,
"position_name": "front",
"width_in_mm": 100,
"height_in_mm": 100,
"width": 2000,
"height": 2000,
"printable_area_margin_from_top": 0,
"template_width": 1000,
"template_height": 1000,
"template": "string"
}
]
},
"price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
},
"sales_price": {
"data": [
{
"price": {
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
},
"type": "generic"
}
]
}
}
}
UserBillingMethod: object
- reference: ABC123
-
Billing method reference
- recharge_amount: integer
-
The amount in cents used to auto recharge wallet
- gateway: string
-
billing method type
- last4: string
-
last 4 digits of credit card
- provider: string
-
credit card provider
- exp_month: string
-
month credit card will expire
- exp_year: string
-
year credit card will expire
- is_active: boolean
-
indicates if billing method is the primary billing method for the user account
Example
{
"reference": "ABC123",
"recharge_amount": "10000",
"gateway": "stripe, prepayment, wallet",
"last4": "4242",
"provider": "visa",
"exp_month": "12",
"exp_year": "2023",
"is_active": "true"
}
UserIntegration: object
- id: integer
-
The internal cockpit id of the used user integration
- app: string
-
Name of the integration application
- name: string
-
The name of the integration, i.e. the shop URL
- reference: uuid
-
Reference of the integration
- expires_in: string
-
Date of expire
- image_type: string
-
Type of image transfered to external shop
- image_quality: string
-
Quality of image transfered to external shop
- fulfillment_mode_key: string
-
The fulfillment mode used when orders are placed via this integration
- is_pull_orders: boolean
-
Flag if manually reimporting of orders is enabled.
- is_auto_pull_orders: boolean
-
Flag if automatically reimporting of orders is enabled.
- default_first_packin_reference: string
-
Default first packin added to orders received via this intergrations (optional)
- default_second_packin_reference: string
-
Default second packin added to orders received via this intergrations (optional)
- default_hangtag_reference: string
-
Default hangtag added to all textil products of orders received via this intergrations (optional)
- default_imprint_reference: string
-
Default imprinted added to all tagless 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_product_packaging_reference: string
-
Default packaging used for all textil products of orders received via this intergrations (optional)
- default_order_packaging_reference: string
-
Default packging used for all orders received via this intergrations (optional)
- default_sticker_reference: string
-
Default sticker applied to packaging of orders received via this intergrations (optional)
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to orders received via this intergrations
- delivery_receipt_note: string
-
Custom note on delivery receipt
- default_delivery_receipt_logo_reference: string
-
Default delivery receipt logo used for orders received via this intergrations (optional)
- delivery_receipt_logo: string
-
Url to custom logo added to delivery slip for orders received via this intergrations (optional)
- use_custom_product_name: boolean
-
Indicates if custom product name is used on delivery receipt
- sticker_logo: string
-
Url to custom sticker logo for orders received via this intergrations (optional)
- is_auto_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- is_refresh_token_expired: boolean
-
Indicates if the (OAuth-)refresh-token is expired. Currently only used for ebay. (default = false)
Example
{
"id": 111,
"app": "shopify",
"name": "my-cool-shirtstore.myshopify.com",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"expires_in": "2018-01-01 12:34:56",
"image_type": "png",
"image_quality": "high",
"fulfillment_mode_key": "24h-express",
"is_pull_orders": "true",
"is_auto_pull_orders": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_imprint_reference": "ABC123",
"default_label_reference": "ABC123",
"default_product_packaging_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"default_sticker_reference": "ABC123",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"sticker_logo": "https://example.com/custom_logo.png",
"is_auto_onhold": true,
"is_refresh_token_expired": false
}
UserPackin: object
- reference: ABC123
-
Packin reference
- name: string
-
Packin name
- type: string
-
Packin type (packin or hangtag)
- position: string
-
Position of Label
- size_id: integer
-
Product size ID for which imprint will be applied
- color_ids: string
-
Array of product color ids for which imprint or label will be applied
- weight_gram: integer
-
Weight of one single packin in gram
- width_mm: integer
-
Width of the packin in millimeter
- height_mm: integer
-
Height of the packin in millimeter
- initial_inventory: integer
-
Initial stock level of packin
- inventory: integer
-
Actual stock level of packin
- preview_path: string
-
Path to packin preview
- is_active: boolean
-
Packins receives status is_active, when article is checked and warehoused
- stocking_costs: Money
-
Daily costs for stocking packin
- item_costs: Money
-
Costs for adding one packin to an order
Example
{
"reference": "ABC123",
"name": "Greetings card",
"type": "packin",
"position": "seam-left",
"size_id": "3",
"color_ids": "['147','157']",
"weight_gram": "10",
"width_mm": "100",
"height_mm": "100",
"initial_inventory": "1000",
"inventory": "1000",
"preview_path": "https://s3.amazon.com/preview.png",
"is_active": "true",
"stocking_costs": 50,
"item_costs": 75
}
UserPayment: object
- reference: string
-
payment reference
- type: string
-
payment type
- status: string
-
payment status
- amount: integer
-
payment amount
- billing_method_reference: string
-
reference of the associated billing method
- is_auto_recharged: boolean
-
indicates if payment was trigger by user or via auto-recharge
Example
{
"reference": "UPD7FF829231CB",
"type": "paypal",
"status": "paid",
"amount": "10000",
"billing_method_reference": "E60C9604",
"is_auto_recharged": "1"
}
UserSubscription: object
- name: string
-
The name of the plan
- valid_from: string
-
The date from which is subscription is valid
- valid_until: string
-
The date until which the subscription is valid
- is_canceled: boolean
-
indicates if subscription was canceled
- is_renewed: boolean
-
indicates if subscription was renewed
- is_valid: boolean
-
indicates if subscription is still valid
Example
{
"name": "Warehousing",
"valid_from": "2022-09-01 08:00:00",
"valid_until": "2022-09-01 08:00:00",
"is_canceled": "1",
"is_renewed": "1",
"is_valid": "1"
}
UserGroup: object
- id: integer
-
Numerical group identifier
- type: string
-
Group name
- cockpit_discount: integer
-
Discount in percent
- quantity: integer
-
Required number of sold products
- created_at: string
-
Timestamp of creation
- updated_at: string
-
Timestamp of last update
Example
{
"id": 1,
"type": "premium",
"cockpit_discount": 20,
"quantity": 1000,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
}
User: object
- email: string
-
Email address
- firstname: string
-
First name(s)
- lastname: string
-
Last name
- display_name: string
-
Display name, e.g. first + last name
- user_group: UserGroup
- is_business: boolean
-
Is a business customer
- title: string
-
(Academical) title
- company_name: string
-
Company name
- street: string
-
Street and number, used for billing
- postcode: string
-
ZIP code, used for billing
- city: string
-
City, used for billing
- country: string
-
Country, used for billing
- phone: string
-
Phone nubmer
- sender_title: string
- sender_company_name: string
- sender_firstname: string
- sender_lastname: string
- sender_street: string
- sender_postcode: string
- sender_city: string
- sender_state: string
- sender_country: string
- sender_type: string full, company, legacy
- fulfillment_key: string
-
The desired fulfillment mode
- is_billing_valid: boolean
-
Have billing options been filled out?
- has_orders: boolean
-
Does user have orders?
- integration_count: number
-
Number of active integrations
- is_auto_onhold: boolean
-
Indicates if order is automatically pushed to production (default = false)
- integrations: UserIntegration
-
List of integrations (connected applications) for this user
- updated_at: string
-
Timestamp of last update
- add_delivery_receipt: boolean
-
Indicates if delivery receipt is added to orders received via this intergrations
- delivery_receipt_note: string
-
Custom note on delivery receipt
- default_delivery_receipt_logo_reference: string
-
Default delivery receipt logo used for orders placed via dashboard
- delivery_receipt_logo: string
-
Url to custom logo added to delivery slip and shipping lable for orders placed via dashboard
- 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)
- default_second_packin_reference: string
-
Default second packin added to orders placed via dashboard (optional)
- default_hangtag_reference: string
-
Default hangtag added to all textil products of orders placed via dashboard (optional)
- sticker_logo: string
-
Url to custom sticker logo for orders placed via dashboard (optional)
Example
{
"email": "mustermann@example.com",
"firstname": "Max",
"lastname": "Mustermann",
"display_name": "Max Mustermann",
"user_group": {
"id": 1,
"type": "premium",
"cockpit_discount": 20,
"quantity": 1000,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56"
},
"is_business": "true",
"title": "Dr.",
"company_name": "Shirtigo GmbH",
"street": "Musterstraße 12",
"postcode": "12345",
"city": "Köln",
"country": "Deutschland",
"phone": "004930123456",
"sender_title": "string",
"sender_company_name": "string",
"sender_firstname": "string",
"sender_lastname": "string",
"sender_street": "string",
"sender_postcode": "string",
"sender_city": "string",
"sender_state": "string",
"sender_country": "string",
"sender_type": "string",
"fulfillment_key": "24h-express",
"is_billing_valid": true,
"has_orders": true,
"integration_count": 2,
"is_auto_onhold": true,
"integrations": [
{
"id": 111,
"app": "shopify",
"name": "my-cool-shirtstore.myshopify.com",
"reference": "154e3f69-c081-4e20-8706-d1c7477e15c8",
"expires_in": "2018-01-01 12:34:56",
"image_type": "png",
"image_quality": "high",
"fulfillment_mode_key": "24h-express",
"is_pull_orders": "true",
"is_auto_pull_orders": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"default_imprint_reference": "ABC123",
"default_label_reference": "ABC123",
"default_product_packaging_reference": "ABC123",
"default_order_packaging_reference": "ABC123",
"default_sticker_reference": "ABC123",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"sticker_logo": "https://example.com/custom_logo.png",
"is_auto_onhold": true,
"is_refresh_token_expired": false
}
],
"updated_at": "2017-01-01 12:34:56",
"add_delivery_receipt": true,
"delivery_receipt_note": "Use voucher XYZ and get a 10% discount for your next order",
"default_delivery_receipt_logo_reference": "ABC123",
"delivery_receipt_logo": "https://example.com/custom_logo.png",
"use_custom_product_name": "true",
"default_first_packin_reference": "ABC123",
"default_second_packin_reference": "ABC123",
"default_hangtag_reference": "ABC123",
"sticker_logo": "https://example.com/custom_logo.png"
}
WarehouseInboundShipment:
- id: 1
-
id
- reference: string
-
Reference
- name: string
-
Name of the Warehouse inbound shipment
- carrier: string
-
Carrier's name
- tracking_number: string
-
Shipment tracking number
- url: string
-
Inbound shipment URL
- count: string
-
Count of the items in the shipment
- created_at: string
-
Timestamp when the record was created
- updated_at: string
-
Timestamp when the record was updated
- deleted_at: string
-
Timestamp when the record was deleted
Example
{
"id": "1",
"reference": "A1234567",
"name": "Warehouse inbound shipment",
"carrier": "DHL",
"tracking_number": "AA123345567BB",
"url": "https://dhl.com/tracking",
"count": 5,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
WarehouseProduct:
- id: 1
-
id
- reference: string
-
Reference
- name: string
-
Name of the Warehouse product
- description: string
-
Description of the Warehouse product
- hs_code: string
-
HS code of the item
- country_of_origin: string
-
The name the country of origin
- color_id: string
-
ID of the color of the item
- item_value: integer
-
Value of the item
- net_sales_price: integer
-
Net sales price of the item
- width_cm: integer
-
Width of the item in cm
- height_cm: integer
-
Height of the item in cm
- depth_cm: integer
-
Depth of the item in cm
- weight_gram: integer
-
Weight of the item in gramm
- needs_box_shipping: boolean
-
Boolean if the item needs extra package for shipping
- min_stock_quantity: integer
-
Minimum stock quantity of the item
- created_at: string
-
Timestamp when the record was created
- updated_at: string
-
Timestamp when the record was updated
- deleted_at: string
-
Timestamp when the record was deleted
Example
{
"id": "1",
"reference": "A12345",
"name": "Warehouse product name",
"description": "Warehouse product description",
"hs_code": "A123123",
"country_of_origin": "DE",
"color_id": "1",
"item_value": 300,
"net_sales_price": 25,
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"needs_box_shipping": "true",
"min_stock_quantity": 100,
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56"
}
WarehouseProductVariant:
- id: 1
-
id
- reference: string
-
Reference
- product_reference: string
-
Warehouse Product reference
- name: string
-
Name of the Warehouse product variant
- description: string
-
Description of the Warehouse product variant
- color_id: string
-
ID of the color of the item
- size_id: string
-
ID of the size of the item
- color: string
-
Name of the color of the item
- size: string
-
Name of the size of the item
- width_cm: integer
-
Width of the item in cm
- height_cm: integer
-
Height of the item in cm
- depth_cm: integer
-
Depth of the item in cm
- weight_gram: integer
-
Weight of the item in gramm
- item_value: integer
-
Value of the item
- net_sales_price: integer
-
Net sales price of the item
- shirtigo_price: integer
-
Shirtigo sales price of the item
- min_stock_quantity: integer
-
Minimum stock quantity of the item
- needs_box_shipping: boolean
-
Boolean if the item needs extra package for shipping
- country_of_origin: string
-
The name the country of origin
- hs_code: string
-
HS code of the item
- created_at: string
-
Timestamp when the record was created
- updated_at: string
-
Timestamp when the record was updated
- deleted_at: string
-
Timestamp when the record was deleted
- is_stored: boolean
-
Boolean if the item is stored
- is_approved: boolean
-
Boolean if the item is approved
- is_rejected: boolean
-
Boolean if the item is rejected to store
- stock_amount: integer
-
Current stock amount of the item
Example
{
"id": "1",
"reference": "A12345",
"product_reference": "A12345",
"name": "Warehouse product variant name",
"description": "Warehouse product variant description",
"color_id": "1",
"size_id": "1",
"color": "Red",
"size": "XL",
"width_cm": 20,
"height_cm": 20,
"depth_cm": 30,
"weight_gram": 500,
"item_value": 300,
"net_sales_price": 25,
"shirtigo_price": 20,
"min_stock_quantity": 100,
"needs_box_shipping": "true",
"country_of_origin": "DE",
"hs_code": "A123123",
"created_at": "2017-01-01 12:34:56",
"updated_at": "2017-01-01 12:34:56",
"deleted_at": "2017-01-01 12:34:56",
"is_stored": "true",
"is_approved": "true",
"is_rejected": "false",
"stock_amount": 100
}
Money: object
- amount: integer
-
Price in cents
- currency_symbol: string
-
Currency symbol
- currency_code: string
-
Three letter ISO 4217 code
- currency_factor: integer
-
Number of cents in one unit of currency
Example
{
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
}
MoneyVatInclude:
- vat_rate: integer
-
Value added tax (VAT) rate in percent as an integer
Example
{
"vat_rate": 19
}
MoneyWithVat: object
Example
{
"vat_rate": 19,
"amount": 999,
"currency_symbol": "€",
"currency_code": "EUR",
"currency_factor": 100
}
OAuthServerException: object
- error: string
-
Machine readable error type.
- message: string
-
Human readable error message.
- hint: string
-
A helper hint.
Example
{
"error": "string",
"message": "string",
"hint": "string"
}
Pagination: object
Pagination information
- total: integer
-
Total number of items
- count: integer
-
Number of items on current page
- per_page: integer
-
Default number of items per page
- current_page: integer
-
Index of current page
- total_pages: integer
-
Total number of pages
- links: object
-
URLs of adjacent pages
Example
{
"total": 32,
"count": 10,
"per_page": 10,
"current_page": 2,
"total_pages": 4,
"links": {
"previous": "string",
"next": "string"
}
}