{ "swagger": "2.0", "info": { "title": "Shirtigo Cockpit API", "description": "API for the Shirtigo Cockpit application.\n The API supports API-Key as well as OAuth2 authentication.\n The API-key / access token has to be presented in the `Authorization` header such as `Authorization: Bearer [key]`.\n Additionally, it is recommended to set the `Accept: application/json` header.\n API Clients for several languages are available on github: https://github.com/shirtigo", "version": "1.0.0", "x-logo": { "url": "/images/cockpit_logo_color.svg", "backgroundColor": "#fafafa" } }, "host": "cockpit.shirtigo.com", "basePath": "/api", "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/transactions": { "get": { "tags": [ "User-API" ], "summary": "Get all transactions", "description": "Retrieve all accounting transactions issued by the currently authenticated user.\nThe result will be paginated, meta information is included in the response.", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "type": "integer", "default": 1 }, { "name": "items", "in": "query", "description": "Items per page", "type": "integer", "default": 12 }, { "name": "search", "in": "query", "description": "Search query", "type": "integer" }, { "name": "sort_col", "in": "query", "description": "Property to order by", "type": "string", "default": "" }, { "name": "sort_dir", "in": "query", "description": "Order direction", "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, { "name": "period", "in": "query", "description": "Days to show (default: all)", "type": "integer" }, { "name": "action", "in": "query", "description": "Action to filter for (default: none)", "type": "integer" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/Payment" } }, "meta": { "description": "Meta information", "properties": { "pagination": { "description": "Get all transactions\n\nRetrieve all accounting transactions issued by the currently authenticated user.\nThe result will be paginated, meta information is included in the response.", "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } } }, "x-summary-de": "Liefert alle Buchungen (Transaktionen) des angemeldeten Nutzers seitenweise, filterbar nach Zeitraum und Aktion.", "x-questions-de": [ "Wie rufe ich meine Buchungen per API ab?", "Wo sehe ich alle Transaktionen meines Kontos?", "Kann ich die Abrechnungen meines Accounts \u00fcber die API exportieren?" ] } }, "/wallet/transactions": { "get": { "tags": [ "User-API" ], "summary": "Get wallet transactions", "operationId": "getWalletTransactions", "parameters": [ { "name": "items", "in": "query", "description": "Number of items per page", "type": "integer" }, { "name": "search", "in": "query", "description": "Search term", "type": "string" }, { "name": "sort_col", "in": "query", "type": "string" }, { "name": "sort_dir", "in": "query", "type": "string", "enum": [ "asc", "desc" ] } ], "responses": { "200": { "description": "Successful operation", "schema": { "properties": { "data": { "description": "Get wallet transactions", "type": "array", "items": { "properties": { "id": { "description": "Get wallet transactions", "type": "integer" }, "reference": { "description": "Get wallet transactions", "type": "string" }, "amount": { "description": "Get wallet transactions", "properties": { "value": { "description": "Get wallet transactions", "type": "number", "format": "float" }, "currency": { "description": "Get wallet transactions", "type": "string" } }, "type": "object" }, "created_at": { "description": "Get wallet transactions", "type": "string", "format": "date-time" }, "description": { "description": "Get wallet transactions", "type": "string" }, "type": { "description": "Get wallet transactions", "type": "string" } }, "type": "object" } }, "meta": { "description": "Get wallet transactions", "properties": { "pagination": { "description": "Get wallet transactions", "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } } }, "x-summary-de": "Liefert die Buchungen des Guthabenkontos (Wallet) des angemeldeten Nutzers.", "x-questions-de": [ "Wie sehe ich die Wallet-Buchungen per API?", "Welche Aufladungen und Abbuchungen gab es auf meinem Guthaben?", "Wie frage ich die Wallet-Historie ab?" ] } }, "/user/balance": { "post": { "tags": [ "User-API" ], "summary": "Get balance for current user", "description": "Return a Money object for the users current balance", "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Money" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Gibt das aktuelle Guthaben des angemeldeten Nutzers zur\u00fcck.", "x-questions-de": [ "Wie frage ich mein Guthaben per API ab?", "Wie viel Geld ist noch auf meinem Wallet?", "Wie bekomme ich den aktuellen Kontostand \u00fcber die API?" ] } }, "/ai/generate-image": { "post": { "tags": [ "Image-API" ], "summary": "Generate media using AI", "operationId": "generateMedia", "parameters": [ { "name": "n_images", "in": "query", "description": "Number of images to generate", "type": "integer" }, { "name": "prompt", "in": "query", "description": "Prompt for image generation", "type": "string" }, { "name": "style_id", "in": "query", "description": "ID of prefered MediaStyle", "type": "integer" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/GeneratedMedia" } }, "422": { "description": "Validation error or insufficient credits" } }, "security": [ { "api_key": [] } ], "x-summary-de": "Erzeugt per KI ein Bild bzw. Motiv aus einer Beschreibung.", "x-questions-de": [ "Wie erstelle ich ein Motiv mit KI \u00fcber die API?", "Kann ich per API Bilder generieren lassen?", "Wie funktioniert die KI-Bildgenerierung?" ] } }, "/ai/variations/{reference}/upscale": { "post": { "tags": [ "Image-API" ], "summary": "Upscale a variation", "operationId": "upscaleVariation", "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Design" } } }, "security": [ { "api_key": [] } ], "x-summary-de": "Skaliert eine per KI erzeugte Bildvariante auf eine h\u00f6here Aufl\u00f6sung hoch.", "x-questions-de": [ "Wie vergr\u00f6\u00dfere ich eine KI-Variante f\u00fcr den Druck?", "Kann ich ein generiertes Bild hochskalieren?", "Wie bekomme ich eine KI-Variante in Druckqualit\u00e4t?" ] } }, "/ai/designs/{reference}/upscale": { "post": { "tags": [ "Image-API" ], "summary": "Upscale a design", "operationId": "upscaleDesign", "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Design" } } }, "security": [ { "api_key": [] } ], "x-summary-de": "Skaliert ein vorhandenes Design per KI auf eine h\u00f6here Aufl\u00f6sung hoch.", "x-questions-de": [ "Wie verbessere ich die Aufl\u00f6sung meines Designs per API?", "Kann ich ein zu kleines Motiv hochskalieren lassen?", "Mein Design ist zu klein f\u00fcr den Druck, was kann ich tun?" ] } }, "/ai/designs/{reference}/remove-background": { "post": { "tags": [ "Image-API" ], "summary": "Remove background from a design", "operationId": "removeBackground", "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/Design" } }, "422": { "description": "Validation error or insufficient credits" } }, "security": [ { "api_key": [] } ], "x-summary-de": "Entfernt per KI den Hintergrund eines Designs.", "x-questions-de": [ "Wie stelle ich ein Motiv per API frei?", "Kann ich den Hintergrund eines Designs automatisch entfernen?", "Wie bekomme ich einen transparenten Hintergrund f\u00fcr mein Motiv?" ] } }, "/ai/media": { "get": { "tags": [ "Image-API" ], "summary": "Get a list of generated media", "operationId": "getGeneratedMediaList", "parameters": [ { "name": "sort_col", "in": "query", "description": "Column to sort by (default: created_at)", "type": "string" }, { "name": "sort_dir", "in": "query", "description": "Sort direction (default: desc)", "type": "string" }, { "name": "filtered_status", "in": "query", "description": "Comma-separated list of filtered statuses", "type": "string" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/GeneratedMedia" } } }, "security": [ { "api_key": [] } ], "x-summary-de": "Liefert die Liste der per KI erzeugten Medien des Nutzers.", "x-questions-de": [ "Wo finde ich meine KI-generierten Bilder?", "Wie liste ich erzeugte Medien per API auf?", "Wie rufe ich alle KI-Bilder ab?" ] } }, "/ai/media/{reference}": { "get": { "tags": [ "Image-API" ], "summary": "Get details of a generated media by reference", "operationId": "getGeneratedMediaDetails", "parameters": [ { "name": "reference", "in": "path", "description": "Reference of the generated media", "required": true, "type": "string" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/GeneratedMedia" } } }, "security": [ { "api_key": [] } ], "x-summary-de": "Liefert die Details eines per KI erzeugten Mediums anhand seiner Referenz.", "x-questions-de": [ "Wie rufe ich ein einzelnes KI-Bild ab?", "Wie sehe ich den Status einer KI-Generierung?", "Wo bekomme ich die URL eines generierten Bildes?" ] } }, "/ai/media-styles": { "get": { "tags": [ "Image-API" ], "summary": "Get a list of media styles", "operationId": "getMediaStyles", "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/MediaStyle" } } }, "security": [ { "api_key": [] } ], "x-summary-de": "Liefert die verf\u00fcgbaren Stile f\u00fcr die KI-Bildgenerierung.", "x-questions-de": [ "Welche Stile gibt es f\u00fcr die KI-Bildgenerierung?", "Wie frage ich die verf\u00fcgbaren KI-Stile ab?", "Welche Bildstile kann ich bei der Generierung w\u00e4hlen?" ] } }, "/base-products": { "get": { "tags": [ "Catalog-API" ], "summary": "Get all base products", "description": "Retrieve a list of available base products.\nOptionally, a category can be passed for filtering.", "parameters": [ { "name": "category", "in": "query", "description": "Filter by category identifier (default: any)", "required": false, "type": "integer" }, { "name": "user_products_only", "in": "query", "description": "Include user specific products", "required": false, "type": "boolean", "default": false }, { "name": "sku", "in": "query", "description": "Filter products with a variant which contains a variant where either the sku or internal_sku contains the passed value", "required": false, "type": "string", "default": "019420001" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/Product" } } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert die verf\u00fcgbaren Basisprodukte (Rohprodukte) des Katalogs, optional gefiltert nach Kategorie.", "x-questions-de": [ "Wie rufe ich den Produktkatalog per API ab?", "Welche Basisprodukte kann ich bedrucken lassen?", "Wie bekomme ich alle verf\u00fcgbaren Textilien \u00fcber die API?" ] } }, "/base-products/{base-product-id}": { "get": { "tags": [ "Catalog-API" ], "summary": "Get base product", "description": "Retrieve information on a single base product.\nTo get stock level and end of life information please add ?include_stock=true to the request\nTo get the actual print dimensions per variant add ?include_print_dimensions=true to the request", "parameters": [ { "name": "base-product-id", "in": "path", "description": "Numerical base product identifier", "required": true, "type": "integer", "x-example": 25 }, { "name": "include_stock", "in": "query", "description": "Include stock information for the product", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Product" } }, "404": { "description": "Product not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert ein einzelnes Basisprodukt mit Details, auf Wunsch mit Lagerbestand und Auslaufinformationen.", "x-questions-de": [ "Wie frage ich Details und Bestand eines Basisprodukts ab?", "Ist ein bestimmtes Textil auf Lager?", "Wie sehe ich, ob ein Produkt ausl\u00e4uft?" ] } }, "/base-categories": { "get": { "tags": [ "Catalog-API" ], "summary": "List available categories", "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "List available categories", "type": "array", "items": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 10 }, "name": { "description": "Category name", "type": "string", "example": "Unisex-Shirts" }, "sort_position": { "description": "Numerical index used for sorting", "type": "integer", "example": 1 } }, "type": "object" } } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert die verf\u00fcgbaren Produktkategorien des Katalogs.", "x-questions-de": [ "Welche Produktkategorien gibt es?", "Wie frage ich die Katalog-Kategorien per API ab?", "Wie filtere ich Basisprodukte nach Kategorie?" ] } }, "/calculation": { "post": { "tags": [ "other" ], "summary": "Calculate production cost", "description": "Calculate the net production cost for a given product, set of print areas and color information. The VAT rate\nrate is preliminary, the final rate depends on the shipping target, involvement of business customers and other factors.", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "is_colored": { "description": "Is this a color print?", "type": "boolean", "example": true }, "printareas": { "description": "Desired print areas", "type": "array", "items": { "type": "integer" } }, "product_id": { "description": "Desired base product", "type": "integer", "example": 375 }, "per_size": { "description": "Also return the price of every size of the color under sizes", "type": "boolean", "example": false } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/MoneyWithVat" } }, "404": { "description": "Product not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Berechnet die Netto-Produktionskosten f\u00fcr ein Produkt mit bestimmten Druckfl\u00e4chen und Farben.", "x-questions-de": [ "Wie berechne ich die Produktionskosten per API?", "Was kostet die Produktion eines bestimmten Shirts?", "Wie bekomme ich den Einkaufspreis f\u00fcr ein Produkt mit Druck?" ] } }, "/delivery-countries": { "get": { "tags": [ "other" ], "summary": "Get delivery targets", "description": "Retrieve a list of valid delivery target countries.\nThe result is presented as associative array: The array keys consist of upper-case\ntwo-letter country codes, the corresponding values are the human readable country names.", "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/Country" } } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert die L\u00e4nder, in die versendet werden kann, als Liste aus L\u00e4ndercode und Name.", "x-questions-de": [ "Welche Lieferl\u00e4nder gibt es?", "Wie frage ich die m\u00f6glichen Versandl\u00e4nder per API ab?", "In welche L\u00e4nder kann ich \u00fcber die API liefern lassen?" ] } }, "/selling-statistics": { "get": { "tags": [ "other" ], "summary": "Get selling statistics", "description": "Retrieve statistics about the current user's sales.\nThis 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.\nPassing from and/or to adds a range block for a freely chosen period, for example a single calendar month.", "parameters": [ { "name": "from", "in": "query", "description": "Start of an additional reporting period as YYYY-MM-DD, counted from the beginning of that day. Omitted means the period is open towards the past.", "required": false, "type": "string", "format": "date" }, { "name": "to", "in": "query", "description": "End of an additional reporting period as YYYY-MM-DD, counted up to the end of that day. Omitted means the period runs up to now. Must not be before from.", "required": false, "type": "string", "format": "date" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "total": { "description": "Total net amount", "$ref": "#/definitions/Money" }, "month": { "description": "Net amount of the last 30 days", "$ref": "#/definitions/Money" }, "week": { "description": "Net amount of the last 7 days", "$ref": "#/definitions/Money" }, "today": { "description": "Net amount of the last 24 hours", "$ref": "#/definitions/Money" }, "total_amount": { "description": "Total number of orders", "type": "integer", "example": 36 }, "month_amount": { "description": "Number of orders during the last 30 days", "type": "integer", "example": 14 }, "week_amount": { "description": "Number of orders during the last 7 days", "type": "integer", "example": 3 }, "today_amount": { "description": "Number of orders during the last 24 hours", "type": "integer", "example": 1 }, "range": { "description": "Only present when from and/or to were passed. Carries the requested bounds plus net, gross and amount for that period.", "properties": { "from": { "description": "Get selling statistics\n\nRetrieve statistics about the current user's sales.\nThis 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.\nPassing from and/or to adds a range block for a freely chosen period, for example a single calendar month.", "type": "string", "format": "date", "example": "2026-03-01" }, "to": { "description": "Get selling statistics\n\nRetrieve statistics about the current user's sales.\nThis 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.\nPassing from and/or to adds a range block for a freely chosen period, for example a single calendar month.", "type": "string", "format": "date", "example": "2026-03-31" }, "net": { "description": "Get selling statistics\n\nRetrieve statistics about the current user's sales.\nThis 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.\nPassing from and/or to adds a range block for a freely chosen period, for example a single calendar month.", "$ref": "#/definitions/Money" }, "gross": { "description": "Get selling statistics\n\nRetrieve statistics about the current user's sales.\nThis 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.\nPassing from and/or to adds a range block for a freely chosen period, for example a single calendar month.", "$ref": "#/definitions/Money" }, "amount": { "description": "Get selling statistics\n\nRetrieve statistics about the current user's sales.\nThis 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.\nPassing from and/or to adds a range block for a freely chosen period, for example a single calendar month.", "type": "integer", "example": 59 } }, "type": "object" } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-stats" ] } ], "x-summary-de": "Liefert Verkaufsstatistiken des Nutzers: Anzahl Verk\u00e4ufe und Netto-Umsatz.", "x-questions-de": [ "Wie rufe ich meine Verkaufszahlen per API ab?", "Wo sehe ich meinen Umsatz \u00fcber die API?", "Wie bekomme ich Verkaufsstatistiken?" ] } }, "/orders-statistics": { "get": { "tags": [ "other" ], "summary": "Get order statistics", "description": "Retrieve statistics about the current user's order status distribution.\nThis endpoint reports the number of open orders (non-shipped, non-canceled) per status (open, preparation, production, clarification)", "responses": { "200": { "description": "Success", "schema": { "properties": { "n_open_orders": { "description": "Number of orders with status open", "type": "integer", "example": 14 }, "n_preparation_orders": { "description": "Number of orders with status prepration for production", "type": "integer", "example": 234 }, "n_production_orders": { "description": "Number of orders with status in production", "type": "integer", "example": 122 }, "n_clarification_orders": { "description": "Number of orders with a status clarification or onhold flag", "type": "integer", "example": 7 } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-stats" ] } ], "x-summary-de": "Liefert die Verteilung der Bestellungen des Nutzers auf die Bestellstatus.", "x-questions-de": [ "Wie viele Bestellungen sind in welchem Status?", "Wie bekomme ich eine \u00dcbersicht \u00fcber offene Bestellungen per API?", "Wie rufe ich Bestellstatistiken ab?" ] } }, "/projects": { "get": { "tags": [ "Project-API" ], "summary": "Get all projects / collections", "description": "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", "parameters": [ { "name": "page", "in": "query", "description": "Current page", "type": "integer", "default": 1 }, { "name": "items", "in": "query", "description": "Number of items per page", "type": "integer", "default": 12 }, { "name": "sort_col", "in": "query", "description": "Column used to sort the results. You can sort by: name, reference, url, default_preview_position, created_at, updated_at", "type": "string", "default": "created_at" }, { "name": "sort_dir", "in": "query", "description": "Direction for sorting", "type": "string", "default": "DESC" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/Project" } }, "meta": { "description": "Meta information", "properties": { "pagination": { "description": "Get all projects / collections\n\nRetrieve all projects available for the currently authenticated user.\nThe projects are automatically paginated, meta information is included in the response.", "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "Liefert alle Projekte bzw. Kollektionen des Nutzers.", "x-questions-de": [ "Wie liste ich meine Projekte per API auf?", "Wo finde ich alle Kollektionen meines Accounts?", "Wie rufe ich Kollektionen \u00fcber die API ab?" ] }, "post": { "tags": [ "Project-API" ], "summary": "Create project / collection", "description": "Create a new project and return the inserted information.\nAssociate the project with the currently authenticated user.", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "name": { "description": "Project name", "type": "string", "example": "My cool project" }, "description": { "description": "Project description", "type": "string", "example": "My cool project" }, "is_deprecated_campaign": { "description": "indicates if deprecated way for product creation is used (use 1/0 instead of true/false)", "type": "boolean", "example": "0" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Legt ein neues Projekt bzw. eine neue Kollektion f\u00fcr den Nutzer an.", "x-questions-de": [ "Wie lege ich per API ein Projekt an?", "Wie erstelle ich eine neue Kollektion?", "Wie gruppiere ich Produkte in einem Projekt?" ] } }, "/projects/{project-reference}": { "get": { "tags": [ "Project-API" ], "summary": "Get project / collection", "description": "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", "parameters": [ { "name": "project-reference", "in": "path", "description": "Unique project identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, { "name": "include_stock", "in": "query", "description": "Include stock information for the products", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project" } }, "400": { "description": "Unknown include" }, "404": { "description": "Project not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "Liefert ein einzelnes Projekt bzw. eine Kollektion anhand der Referenz.", "x-questions-de": [ "Wie rufe ich ein bestimmtes Projekt ab?", "Wie bekomme ich die Details einer Kollektion?", "Wie frage ich ein Projekt per Referenz ab?" ] }, "put": { "tags": [ "Project-API" ], "summary": "Update project / Collection", "description": "Change information about a project", "parameters": [ { "name": "project-reference", "in": "path", "description": "Unique project identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, { "name": "body", "in": "body", "schema": { "properties": { "name": { "description": "Project name", "type": "string", "example": "My cool project" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Project" } }, "404": { "description": "Project not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "\u00c4ndert die Angaben eines Projekts bzw. einer Kollektion.", "x-questions-de": [ "Wie benenne ich ein Projekt per API um?", "Wie \u00e4ndere ich eine Kollektion?", "Wie aktualisiere ich die Daten eines Projekts?" ] }, "delete": { "tags": [ "Project-API" ], "summary": "Delete project / collection", "description": "Delete the selected project.", "parameters": [ { "name": "project-reference", "in": "path", "description": "Unique project identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" } ], "responses": { "202": { "description": "Accepted. The project is hidden immediately, its products, colours and printareas are removed in the background." }, "404": { "description": "Project not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "L\u00f6scht ein Projekt bzw. eine Kollektion.", "x-questions-de": [ "Wie l\u00f6sche ich ein Projekt per API?", "Wie entferne ich eine Kollektion?", "Kann ich ein Projekt \u00fcber die API l\u00f6schen?" ] } }, "/projects/{project-reference}/products": { "get": { "tags": [ "Project-API" ], "summary": "Get products for a project / collection", "description": "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", "parameters": [ { "name": "project-reference", "in": "path", "description": "Unique project identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" } ], "responses": { "200": { "description": "Success", "schema": { "property": "data", "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/CampaignProduct" } } }, "404": { "description": "Project not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "Liefert die Produkte eines Projekts bzw. einer Kollektion.", "x-questions-de": [ "Welche Produkte sind in einem Projekt?", "Wie liste ich die Produkte einer Kollektion auf?", "Wie rufe ich alle Produkte eines Projekts per API ab?" ] } }, "/projects/{project-reference}/sync": { "post": { "tags": [ "Project-API" ], "summary": "Synchronize integrations", "description": "Trigger synchronization with all integrations defined for this campaign.\nThe synchronization is performed in the background. Its status can be observed by querying for the attribute \"status\".\nIt has the following enum-values:\n- 'is_queuing',\n- 'is_syncing',\n- 'is_completed'\n- 'has_errors'", "parameters": [ { "name": "project-reference", "in": "path", "description": "Unique project identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, { "name": "body", "in": "body", "schema": { "properties": { "integrations": { "description": "Integration ids", "type": "array", "items": "integer" } }, "type": "object" } } ], "responses": { "204": { "description": "Success, all integrations processed" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Startet die Synchronisierung eines Projekts mit allen verbundenen Shops; sie l\u00e4uft im Hintergrund.", "x-questions-de": [ "Wie \u00fcbertrage ich ein Projekt in meinen Shop?", "Wie starte ich die Synchronisierung einer Kollektion per API?", "Wie bringe ich alle Produkte eines Projekts in Shopify oder WooCommerce?" ] } }, "/products": { "get": { "tags": [ "Product-API" ], "summary": "Get all products", "description": "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", "parameters": [ { "name": "finished", "in": "query", "description": "Only return products where rendering is finished.", "required": false, "type": "integer" }, { "name": "search", "in": "query", "description": "A search term used to filter on the product and product group (collection) names.", "required": false, "type": "string" }, { "name": "project_id", "in": "query", "description": "Return only products for a given campaign", "required": false, "type": "string", "x-example": "CP4F7C8D1BEF" }, { "name": "design_id", "in": "query", "description": "Return only products which contain a processingarea where the design for the given design_id is used", "required": false, "type": "string", "x-example": "03eaf83f-b61a-4c71-b228-1f08023ce4fc" }, { "name": "base_product_id", "in": "query", "description": "Return which are based on the given base product id", "required": false, "type": "integer", "x-example": 235 }, { "name": "tags", "in": "query", "description": "Filter for products containing a given tag", "required": false, "type": "string", "x-example": "myTag" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/CampaignProduct" } } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "Liefert alle Produkte des Nutzers.", "x-questions-de": [ "Wie liste ich meine Produkte per API auf?", "Wie rufe ich alle angelegten Produkte ab?", "Wo bekomme ich die SKUs meiner Produkte?" ] } }, "/products/{product-id}": { "get": { "tags": [ "Product-API" ], "summary": "Get product", "description": "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", "parameters": [ { "name": "product-id", "in": "path", "description": "Numerical product identifier", "required": true, "type": "integer", "x-example": 25 }, { "name": "include_stock", "in": "query", "description": "Include stock information for the product", "required": false, "type": "boolean", "default": false } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CampaignProduct" } }, "404": { "description": "Product not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "Liefert ein einzelnes Produkt mit Details.", "x-questions-de": [ "Wie rufe ich ein bestimmtes Produkt ab?", "Wie bekomme ich die Varianten und Preise eines Produkts?", "Wie frage ich ein Produkt per ID ab?" ] } }, "/products/{productId}": { "put": { "tags": [ "Product-API" ], "summary": "Update product", "description": "Update names, descriptions, prices and add/delete a product of the authenticated user.", "parameters": [ { "name": "productId", "in": "path", "description": "ID of the product to update", "required": true, "type": "integer", "x-example": 123 }, { "name": "body", "in": "body", "schema": { "properties": { "custom_name": { "description": "Product name", "type": "string", "example": "My cool product" }, "price": { "description": "Gross product price in Euro-cents", "type": "integer", "example": 400 }, "description": { "description": "Short description", "type": "string" }, "tags": { "description": "List of tags for this product", "type": "array", "items": { "type": "string" } }, "colors": { "description": "List of color ids", "type": "array", "items": { "type": "integer" } }, "delete_unmentioned_colors": { "description": "Set to true if colors which are stored but do not appear in the request should be deleted. Default: false", "type": "bool" }, "sort_position": { "description": "Set a sort position for this product within its project", "type": "integer", "example": "1" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/CampaignProduct" } }, "404": { "description": "Product not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "\u00c4ndert Namen, Beschreibungen und Preise eines Produkts.", "x-questions-de": [ "Wie \u00e4ndere ich den Verkaufspreis eines Produkts per API?", "Wie aktualisiere ich Name und Beschreibung eines Produkts?", "Kann ich Produktdaten \u00fcber die API bearbeiten?" ] }, "delete": { "tags": [ "Product-API" ], "summary": "Delete product", "parameters": [ { "name": "productId", "in": "path", "description": "ID of the product to delete", "required": true, "type": "integer", "x-example": 123 } ], "responses": { "204": { "description": "Success, product deleted" }, "404": { "description": "Product not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "L\u00f6scht ein Produkt des Nutzers.", "x-questions-de": [ "Wie l\u00f6sche ich ein Produkt per API?", "Wie entferne ich ein Produkt aus meinem Account?", "Kann ich Produkte \u00fcber die API l\u00f6schen?" ] } }, "/products/{product-id}/sync": { "post": { "tags": [ "Product-API" ], "summary": "Synchronize integrations", "description": "Trigger synchronization for all requested integrations for this product.\nThe synchronization is performed in the background. Its status can be observed by querying the\nactive_integration_syncs field in the product response.", "parameters": [ { "name": "product-id", "in": "path", "description": "Numerical product identifier", "required": true, "type": "integer", "x-example": 25 }, { "name": "body", "in": "body", "schema": { "properties": { "integrations": { "description": "Integration ids", "type": "array", "items": "integer" } }, "type": "object" } } ], "responses": { "204": { "description": "Success, all integrations processed" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Startet die Synchronisierung eines Produkts mit den gew\u00e4hlten Shops; sie l\u00e4uft im Hintergrund.", "x-questions-de": [ "Wie \u00fcbertrage ich ein einzelnes Produkt in meinen Shop?", "Wie synchronisiere ich ein Produkt per API?", "Mein Produkt fehlt im Shop, wie sto\u00dfe ich die \u00dcbertragung an?" ] } }, "/products/{product-id}/sync-images": { "post": { "tags": [ "Product-API" ], "summary": "Synchronize only product images", "description": "Trigger image synchronization for the specified integration for this product.\nOnly images will be updated, other product data remains unchanged.", "parameters": [ { "name": "product-id", "in": "path", "description": "Numerical product identifier", "required": true, "type": "integer", "x-example": 25 }, { "name": "body", "in": "body", "schema": { "properties": { "integration_id": { "description": "Integration id", "type": "integer" } }, "type": "object" } } ], "responses": { "204": { "description": "Success, images synchronized" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Synchronisiert nur die Produktbilder eines Produkts mit einem Shop, die \u00fcbrigen Daten bleiben unver\u00e4ndert.", "x-questions-de": [ "Wie aktualisiere ich nur die Bilder im Shop?", "Wie \u00fcbertrage ich neue Mockups in meinen Shop?", "Kann ich Produktbilder synchronisieren, ohne Preise zu \u00e4ndern?" ] } }, "/customized-product": { "post": { "tags": [ "Product-API" ], "summary": "Create product", "description": "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", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "project_id", "base_product_id", "processings" ], "properties": { "project_id": { "description": "Identifier of existing project", "type": "string", "example": "CP94791DFD28" }, "base_product_id": { "description": "Identifier of desired base product", "type": "integer", "example": 235 }, "price": { "description": "Product price in cents", "type": "integer", "example": 2999 }, "custom_name": { "description": "Custom product name", "type": "string", "example": "My Custom Product" }, "sort_position": { "description": "Sort position", "type": "integer", "example": 1 }, "tags": { "description": "Product tags", "type": "array", "items": { "type": "string", "example": "tag1" } }, "description": { "description": "Product description", "type": "string" }, "integration_feature_description": { "description": "Integration feature description", "type": "array", "items": { "type": "string" } }, "brandings": { "description": "Product brandings", "type": "array", "items": { "type": "string" } }, "processings": { "description": "List of processings to apply", "type": "array", "items": { "properties": { "processingarea_type": { "description": "Processing area type", "type": "string", "example": "front" }, "processingposition": { "description": "Processing position", "type": "string", "default": "chest-center", "example": "chest-center" }, "processingmethod": { "description": "Processing method", "type": "string", "default": "dtg", "example": "dtg" }, "design_reference": { "description": "Design for the customization", "type": "string", "example": "310ef229-2254-4f4f-9041-a8e02674ff36" }, "offset_top": { "description": "Vertical offset from top in millimeters", "type": "integer", "default": 0, "example": 50 }, "offset_center": { "description": "Horizontal offset from center in millimeters", "type": "integer", "default": 0, "example": 0 }, "width": { "description": "Design width in millimeters", "type": "integer", "example": 200 }, "is_customizable": { "description": "Flag to indicate if order products can be customized after order was placed", "type": "boolean", "default": false, "example": false }, "is_blank_design": { "description": "Flag to indicate if order products have blank designs", "type": "boolean", "default": false, "example": false }, "force_position": { "description": "true uses the offsets exactly as given for every size. false (default, recommended) adjusts the position per garment size automatically.", "type": "boolean", "default": false, "example": false }, "mockups": { "description": "List of ids for the desired mockups for this product processing", "type": "array", "items": { "type": "integer", "example": 123 } }, "colors": { "description": "List of baseProduct colors which should be assigned to this processing", "type": "array", "items": { "properties": { "colorId": { "description": "Numeric identifier of baseProduct color", "type": "integer", "example": 608 }, "price": { "description": "Your sales price for this product color in cents", "type": "integer", "example": 2195 }, "sortPosition": { "description": "sort position for this color", "type": "integer", "example": 1 } }, "type": "object" } } }, "type": "object" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/CampaignProduct" } } }, "type": "object" } }, "401": { "description": "Unauthorized (no credentials or not eligible for ordering)" }, "422": { "description": "Validation failed, details in response body" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Legt ein neues Produkt auf Basis eines Basisprodukts an, mit eigenen Motiven, Druckfl\u00e4chen und Farben.", "x-questions-de": [ "Wie lege ich per API ein bedrucktes Produkt an?", "Wie erstelle ich ein Produkt mit meinem Design?", "Wie kombiniere ich Basisprodukt und Motiv \u00fcber die API?" ] } }, "/customized-product/{productId}": { "put": { "tags": [ "Product-API" ], "summary": "Update product colors", "description": "Use this endpoint to update an existing product. The product can be customized on the baseProduct color level similar to the create endpoint.\nEach processing can be associated to one or many colorIds. Multiple processings can be added.\nInstead of the complete processing information (design, width, position info) it is possible to pass a baseProduct color id as a referenceColorId.\nIn this case all processing information is created based on the existing processings for the reference color.", "parameters": [ { "name": "UpdateProductColors", "in": "body", "schema": { "required": [ "processings" ], "properties": { "processings": { "description": "List of processings to add / update", "type": "array", "items": { "properties": { "processingarea_type": { "description": "Processing area type. Not required when only prices are adjusted", "type": "string", "example": "front" }, "processingposition": { "description": "Processing position", "type": "string", "default": "chest-center", "example": "chest-center" }, "processingmethod": { "description": "Processing method", "type": "string", "default": "dtg", "example": "dtg" }, "design_reference": { "description": "Design for the customization. This parameter if new colors are added and the referenceColor option is not used.", "type": "string", "example": "310ef229-2254-4f4f-9041-a8e02674ff36" }, "offset_top": { "description": "Vertical offset from top in millimeters. This parameter if new colors are added and the referenceColor option is not used.", "type": "integer", "default": 0, "example": 50 }, "offset_center": { "description": "Horizontal offset from center in millimeters. This parameter if new colors are added and the referenceColor option is not used.", "type": "integer", "default": 0, "example": 0 }, "width": { "description": "Design width in millimeters. This parameter if new colors are added and the referenceColor option is not used.", "type": "string", "example": 200 }, "is_customizable": { "description": "inidicated if order products can be customized after order was placed", "type": "boolean", "default": "false", "example": "false" }, "force_position": { "description": "true uses the offsets exactly as given for every size. false (default, recommended) adjusts the position per garment size automatically.", "type": "boolean", "default": false, "example": false }, "colors": { "description": "List of baseProduct colors which should be assigned to this processing", "type": "array", "items": { "properties": { "colorId": { "description": "Numeric identifier of baseProduct color", "type": "integer", "example": 608 }, "referenceColorId": { "description": "A reference color, where all processing info is taken from and used as the basis for the added colors.", "type": "integer", "example": 2195 }, "price": { "description": "Your sales price for this product color in cents", "type": "integer", "example": 2195 }, "sortPosition": { "description": "sort position for this color", "type": "integer", "example": 1 } } } } }, "type": "object" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/CampaignProduct" } } }, "type": "object" } }, "401": { "description": "Unauthorized (no credentials or not eligible for ordering)" }, "422": { "description": "Validation failed, details in response body" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "\u00c4ndert ein bestehendes Produkt auf Ebene der Farben des Basisprodukts.", "x-questions-de": [ "Wie f\u00fcge ich einem Produkt weitere Farben hinzu?", "Wie \u00e4ndere ich die Farben eines Produkts per API?", "Wie passe ich ein bestehendes Produkt an?" ] } }, "/products/{productId}/images": { "post": { "tags": [ "Product-API" ], "summary": "Add Image for ProductColor", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "productId", "in": "path", "description": "ID of the product to add image to", "required": true, "type": "integer", "x-example": 123 }, { "name": "url", "in": "query", "description": "Url", "type": "string" }, { "name": "style", "in": "query", "description": "Style", "type": "string" }, { "name": "procesingarea_type", "in": "query", "description": "Processing Area type", "type": "string" }, { "name": "name", "in": "query", "description": "Name", "type": "string" }, { "name": "sort_weight", "in": "query", "description": "Sort weight", "type": "integer" } ], "responses": { "200": { "description": "Success, product image was added" }, "422": { "description": "Error, image file does not meet requirements" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "F\u00fcgt einer Produktfarbe ein eigenes Bild hinzu.", "x-questions-de": [ "Wie lade ich eigene Produktbilder hoch?", "Wie f\u00fcge ich einer Produktfarbe ein Bild hinzu?", "Kann ich eigene Fotos f\u00fcr ein Produkt verwenden?" ] } }, "/products/{projectProductId}/mockups": { "put": { "tags": [ "Product-API" ], "summary": "Update Product Mockups", "description": "Updates the mockups associated with a project product. It allows adding new mockups and removing existing ones based on provided mockup IDs.\nEnsures that at least one mockup remains after updates to prevent product mockup configurations from being empty.", "operationId": "updateProductMockups", "parameters": [ { "name": "projectProductId", "in": "path", "description": "The unique identifier of the project product", "required": true, "type": "integer" }, { "name": "body", "in": "body", "description": "List of mockup IDs to update", "required": true, "schema": { "properties": { "mockups": { "description": "Array of mockup IDs to be updated or removed", "type": "array", "items": { "type": "integer" }, "example": [ 1234, 5678 ] } }, "type": "object" } } ], "responses": { "200": { "description": "Mockups updated successfully", "schema": { "properties": { "message": { "description": "Update Product Mockups\n\nUpdates the mockups associated with a project product. It allows adding new mockups and removing existing ones based on provided mockup IDs.\nEnsures that at least one mockup remains after updates to prevent product mockup configurations from being empty.", "type": "string", "example": "Mockups updated successfully" } }, "type": "object" } }, "404": { "description": "Product not found", "schema": { "properties": { "error": { "description": "Update Product Mockups\n\nUpdates the mockups associated with a project product. It allows adding new mockups and removing existing ones based on provided mockup IDs.\nEnsures that at least one mockup remains after updates to prevent product mockup configurations from being empty.", "type": "string", "example": "Product not found" } }, "type": "object" } }, "422": { "description": "Validation error or the product needs at least one mockup", "schema": { "properties": { "error": { "description": "Update Product Mockups\n\nUpdates the mockups associated with a project product. It allows adding new mockups and removing existing ones based on provided mockup IDs.\nEnsures that at least one mockup remains after updates to prevent product mockup configurations from being empty.", "type": "string", "example": "Some mockups are invalid or not assigned to the base product" }, "invalid_mockups": { "description": "List of invalid mockup IDs", "type": "array", "items": { "type": "integer" } }, "additional_error": { "description": "Update Product Mockups\n\nUpdates the mockups associated with a project product. It allows adding new mockups and removing existing ones based on provided mockup IDs.\nEnsures that at least one mockup remains after updates to prevent product mockup configurations from being empty.", "type": "string", "example": "After performing the action the product needs at least one mockup." } }, "type": "object" } } }, "security": [ { "api_key": [] }, { "bearerAuth": [] } ], "x-summary-de": "\u00c4ndert die Mockups eines Produkts: neue hinzuf\u00fcgen, bestehende entfernen.", "x-questions-de": [ "Wie \u00e4ndere ich die Mockups eines Produkts per API?", "Wie f\u00fcge ich weitere Produktansichten hinzu?", "Wie entferne ich ein Mockup von einem Produkt?" ] } }, "/coupons/{coupon_code}": { "get": { "tags": [ "Order-API" ], "summary": "Get coupon info", "description": "Retrieve information about a single order coupon.", "parameters": [ { "name": "coupon_code", "in": "path", "description": "Alphanumerical coupon identifier as provided to the customer", "required": true, "type": "string", "x-example": "Shirt-coupon-XYZ" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Coupon" } }, "404": { "description": "Coupon not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-order" ] } ], "x-summary-de": "Liefert Informationen zu einem Gutscheincode f\u00fcr Bestellungen.", "x-questions-de": [ "Wie pr\u00fcfe ich einen Gutscheincode per API?", "Ist mein Gutschein g\u00fcltig?", "Wie viel Rabatt gibt ein Gutscheincode?" ] } }, "/designs": { "get": { "tags": [ "Design-API" ], "summary": "Get all designs", "description": "Retrieve a paginated list of available designs of the currently authenticated user.", "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/Design" } } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-design" ] } ], "x-summary-de": "Liefert die Designs bzw. Motive des Nutzers seitenweise.", "x-questions-de": [ "Wie liste ich meine Designs per API auf?", "Wo finde ich alle hochgeladenen Motive?", "Wie rufe ich meine Druckdateien ab?" ] } }, "/designs/{design-reference}": { "get": { "tags": [ "Design-API" ], "summary": "Get design", "description": "Retrieve information about a single design.\nOnly searches designs that are available to the currently authenticated user.", "parameters": [ { "name": "design-reference", "in": "path", "description": "Unique design identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Design" } }, "404": { "description": "Design not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-design" ] } ], "x-summary-de": "Liefert ein einzelnes Design anhand seiner Referenz.", "x-questions-de": [ "Wie rufe ich ein bestimmtes Design ab?", "Wie bekomme ich die Details eines Motivs?", "Wie frage ich ein Design per Referenz ab?" ] }, "put": { "tags": [ "Design-API" ], "summary": "Update design", "description": "Update a single design based on the parameters given in the form body.", "parameters": [ { "name": "design-reference", "in": "path", "description": "Unique design identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, { "name": "body", "in": "body", "schema": { "properties": { "name": { "description": "name of the design", "type": "string" }, "tags": { "description": "List of tags for this design", "type": "array", "items": { "type": "string" } }, "colors": { "description": "List of hex-color pairs with the currently used color and the color to replace. Only available for embroidery design files.", "type": "array", "items": { "properties": { "F2E9EA": { "description": "Update design\n\nUpdate a single design based on the parameters given in the form body.", "type": "string", "example": "25282A" }, "D0DF00": { "description": "Update design\n\nUpdate a single design based on the parameters given in the form body.", "type": "string", "example": "84754E" } }, "type": "object" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Design" } }, "404": { "description": "Design not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-design" ] } ], "x-summary-de": "\u00c4ndert die Angaben eines Designs.", "x-questions-de": [ "Wie benenne ich ein Design per API um?", "Wie \u00e4ndere ich die Daten eines Motivs?", "Kann ich ein Design \u00fcber die API bearbeiten?" ] }, "delete": { "tags": [ "Design-API" ], "summary": "Delete design", "description": "Only designs by the currently authenticated user may be deleted.", "parameters": [ { "name": "design-reference", "in": "path", "description": "Unique design identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" } ], "responses": { "204": { "description": "Success, design deleted" }, "404": { "description": "Design not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-design" ] } ], "x-summary-de": "L\u00f6scht ein Design des Nutzers.", "x-questions-de": [ "Wie l\u00f6sche ich ein Design per API?", "Wie entferne ich ein Motiv?", "Kann ich hochgeladene Designs l\u00f6schen?" ] } }, "/designs/file": { "post": { "tags": [ "Design-API" ], "summary": "Create design from file", "description": "Create a new design from the submitted file.\n\nThe file must be at least 1000px in width or height and must be formatted either as PNG- or JPEG raster image.\n\nThe endpoint returns the created design.", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "processingmethod": { "description": "The processingmethod for which the design will be used (dtg, embroidery, engraving)", "type": "string", "example": "dtg" }, "name": { "description": "name for the design", "type": "string", "example": "my-design" }, "tags": { "description": "List of tags for this design", "type": "array", "items": { "type": "string" } } }, "type": "object" } }, { "name": "file", "in": "formData", "description": "Design file", "type": "file" } ], "responses": { "200": { "description": "Success, all file has been processed", "schema": { "type": "object", "$ref": "#/definitions/Design" } }, "422": { "description": "Error, image file does not meet requirements" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-design" ] } ], "x-summary-de": "Legt ein Design aus einer hochgeladenen Datei an; die Datei muss mindestens 1000 px breit oder hoch sein.", "x-questions-de": [ "Wie lade ich ein Motiv per API hoch?", "Welche Mindestgr\u00f6\u00dfe muss meine Druckdatei haben?", "Wie erstelle ich ein Design aus einer Datei?" ] } }, "/designs/base64": { "post": { "tags": [ "Design-API" ], "summary": "Create design from base64-encoded data", "description": "Create a new design from the base64-encoded data\n\nThe endpoint returns the created design.", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "data": { "description": "Base64-encoded data", "type": "string" }, "original_filename": { "description": "Original file name (optional)", "type": "string" }, "processingmethod": { "description": "The processingmethod for which the design will be used (dtg, embroidery, engraving)", "type": "string", "example": "dtg" }, "name": { "description": "name for the design", "type": "string", "example": "my-design" }, "tags": { "description": "List of tags for this design", "type": "array", "items": { "type": "string" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success, URL has been processed", "schema": { "type": "object", "$ref": "#/definitions/Design" } }, "422": { "description": "Error, URL / image file does not meet requirements" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-design" ] } ], "x-summary-de": "Legt ein Design aus base64-kodierten Bilddaten an.", "x-questions-de": [ "Wie lade ich ein Design als base64 hoch?", "Kann ich ein Motiv ohne Datei-Upload \u00fcbermitteln?", "Wie erstelle ich ein Design aus base64-Daten?" ] } }, "/designs/url": { "post": { "tags": [ "Design-API" ], "summary": "Create design from URL", "description": "Create a new design from the submitted URL.\n\nThe endpoint returns the created design.", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "url": { "description": "Design file URL", "type": "string" }, "processingmethod": { "description": "The processingmethod for which the design will be used (dtg, embroidery, engraving)", "type": "string", "example": "dtg" }, "name": { "description": "name for the design", "type": "string", "example": "my-design" }, "tags": { "description": "List of tags for this design", "type": "array", "items": { "type": "string" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success, URL has been processed", "schema": { "type": "object", "$ref": "#/definitions/Design" } }, "422": { "description": "Error, URL / image file does not meet requirements" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-design" ] } ], "x-summary-de": "Legt ein Design aus einer Bild-URL an.", "x-questions-de": [ "Wie erstelle ich ein Design aus einer URL?", "Kann ich ein Motiv per Link hochladen?", "Wie \u00fcbernehme ich ein Bild aus dem Internet als Design?" ] } }, "/fulfillment-modes": { "get": { "tags": [ "other" ], "summary": "Get all fulfillment_modes", "description": "Retrieve a list of available fulfillment_modes, which are available to authenticated user.", "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/FulfillmentMode" } } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert die Fulfillment-Modi (z. B. Express), die dem Nutzer zur Verf\u00fcgung stehen.", "x-questions-de": [ "Welche Fulfillment-Modi gibt es?", "Wie frage ich die verf\u00fcgbaren Versand- und Produktionsoptionen ab?", "Wie bekomme ich den Key f\u00fcr die Express-Produktion?" ] } }, "/integrations/{integration_id}": { "get": { "tags": [ "Integration-API" ], "summary": "Get UserIntegration", "description": "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", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "syncs": { "description": "Includes current product states", "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/UserIntegration" } }, "404": { "description": "integration not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert eine einzelne Shop-Integration des Nutzers.", "x-questions-de": [ "Wie rufe ich eine Shop-Verbindung per API ab?", "Wie sehe ich die Einstellungen meiner Shopify-Integration?", "Wie frage ich eine Integration per ID ab?" ] }, "put": { "tags": [ "Integration-API" ], "summary": "Update UserIntegration", "description": "Update settings for a single user integration.\n\nThe endpoint returns the updated integration.", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "is_auto_onhold": { "description": "Indicates if order is automatically pushed to production (default = false)", "type": "boolean", "example": true }, "is_auto_pull_orders": { "description": "Indicates if orders will be pulled and processed by Cockpit automatically (default = false)", "type": "boolean", "example": true }, "default_first_packin_reference": { "description": "Default first packin added to orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_second_packin_reference": { "description": "Default second packin added to orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_hangtag_reference": { "description": "Default hangtag added to all textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_imprint_reference": { "description": "Default imprinted added to all tagless textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_label_reference": { "description": "Default label added to all textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_product_packaging_reference": { "description": "Default packaging used for all textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_order_packaging_reference": { "description": "Default packging used for all orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_sticker_reference": { "description": "Default sticker applied to packaging of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "add_delivery_receipt": { "description": "Indicates if delivery receipt is added to orders received via this intergrations", "type": "boolean", "example": true }, "delivery_receipt_note": { "description": "Custom note on delivery receipt", "type": "string", "example": "Use voucher XYZ and get a 10% discount for your next order" }, "use_custom_product_name": { "description": "Indicates if custom product name is used on delivery receipt", "type": "boolean", "example": true }, "default_product_inventory": { "description": "Default stock-inventory for UserIntegration (Optional)", "type": "integer", "example": "5" }, "sales_channel": { "description": "UserIntegration sales channel", "type": "string", "example": "Storefront" }, "fulfillment_mode_key": { "description": "Key of the fulfillment mode to be used if available for orders with this integration ", "type": "string", "example": "24h-express" }, "fulfillmentPolicy": { "description": "Fulfillment-Policy", "type": "array", "items": { "properties": { "national_shipping_cost": { "description": "National shipping prise", "type": "float", "example": "2.00" }, "international_shipping_cost": { "description": "International shipping prise", "type": "float", "example": "2.00" }, "international_additional_shipping_cost": { "description": "International shipping prise for additional articles", "type": "float", "example": "2.00" }, "handling_time": { "description": "Maximum number of business days the seller needs for preparing and shipping an order after receiving a cleared payment for the order.", "type": "integer", "example": "5" } }, "type": "object" } }, "regions": { "description": "Declaration of regions a packet will be sent to", "type": "array", "items": { "properties": { "region_included": { "description": "Region an oder may be shipped.", "type": "string", "example": "Worldwide" } }, "type": "object" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success, URL has been processed" }, "422": { "description": "Error, Something goes wrong" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "\u00c4ndert die Einstellungen einer Shop-Integration.", "x-questions-de": [ "Wie \u00e4ndere ich die Einstellungen meiner Shop-Integration?", "Wie aktiviere ich Optionen f\u00fcr meinen verbundenen Shop?", "Kann ich eine Integration per API konfigurieren?" ] }, "delete": { "tags": [ "Integration-API" ], "summary": "Delete UserIntegration", "description": "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.", "parameters": [ { "name": "design-reference", "in": "path", "description": "Unique design identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" } ], "responses": { "204": { "description": "Success, integration uninstalled and deleted" }, "404": { "description": "integration not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "Entfernt eine Shop-Integration und deinstalliert sie im Shop; synchronisierte Produkte werden dabei gel\u00f6scht.", "x-questions-de": [ "Wie trenne ich meinen Shop vom Cockpit?", "Wie l\u00f6sche ich eine Shop-Integration?", "Was passiert mit den Produkten, wenn ich die Integration entferne?" ] } }, "/integrations/{integration_id}/products": { "get": { "tags": [ "Integration-API" ], "summary": "Get UserIntegration", "description": "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", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "syncs": { "description": "Includes current product states", "type": "integer" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/UserIntegration" } }, "404": { "description": "integration not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert die Produkte, die mit einer Shop-Integration synchronisiert sind.", "x-questions-de": [ "Welche Produkte sind mit meinem Shop verbunden?", "Wie liste ich die synchronisierten Produkte einer Integration auf?", "Wie sehe ich, welche Produkte im Shop sind?" ] } }, "/integrations/sync-errors/{sync_id}/translate": { "post": { "tags": [ "Integration-API" ], "summary": "Translate User Integration Sync Error", "description": "Translate technical integration sync errors into user-friendly explanations", "parameters": [ { "name": "sync_id", "in": "path", "description": "ID of the campaign product integration sync", "required": true, "type": "integer" }, { "name": "body", "in": "body", "schema": { "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "explanation": { "description": "Human-readable explanation of the error", "type": "string" }, "suggestion": { "description": "Actionable steps to resolve the issue", "type": "string" } }, "type": "object" } }, "404": { "description": "Sync record not found or no access" }, "422": { "description": "No error found in sync record" }, "500": { "description": "Error processing AI request" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "\u00dcbersetzt technische Synchronisierungsfehler einer Integration in verst\u00e4ndliche Erkl\u00e4rungen.", "x-questions-de": [ "Was bedeutet mein Synchronisierungsfehler?", "Wie bekomme ich eine verst\u00e4ndliche Erkl\u00e4rung f\u00fcr einen Sync-Fehler?", "Warum ist die \u00dcbertragung in meinen Shop fehlgeschlagen?" ] } }, "/media/order-document": { "post": { "tags": [ "Order-API" ], "summary": "Upload Order Document", "description": "Upload and store a document file related to an order. Accepts either a file upload or a base64 encoded PDF string.", "consumes": [ "multipart/form-data", "application/json" ], "produces": [ "application/json" ], "parameters": [ { "name": "file", "in": "formData", "description": "The document file to upload (required if base64_file is not provided)", "required": false, "type": "file" }, { "name": "type", "in": "formData", "description": "The type of document being uploaded.", "required": true, "type": "string", "enum": [ "delivery-receipt", "merchant-invoice", "return-label" ] }, { "name": "body", "in": "body", "description": "JSON body for base64 file upload", "required": false, "schema": { "properties": { "base64_file": { "description": "Base64 encoded PDF string", "type": "string" }, "type": { "description": "Upload a document for an order", "type": "string", "enum": [ "delivery-receipt", "merchant-invoice", "return-label" ] } }, "type": "object" } } ], "responses": { "200": { "description": "Document uploaded successfully", "schema": { "properties": { "data": { "description": "Upload a document for an order", "type": "object" } } } }, "422": { "description": "Validation error" } }, "security": [ { "Bearer": [] } ], "x-summary-de": "L\u00e4dt ein Dokument zu einer Bestellung hoch, als Datei oder als base64-kodiertes PDF.", "x-questions-de": [ "Wie lade ich ein Dokument zu einer Bestellung hoch?", "Wie \u00fcbermittle ich eine Rechnung oder ein Versandlabel per API?", "Kann ich ein PDF als base64 zu einer Order hochladen?" ] } }, "/mockup-factory/generate-image": { "post": { "tags": [ "Image-API" ], "summary": "Generate Mockup Images", "description": "Generates custom mockup images based on the specifications provided.", "parameters": [ { "name": "body", "in": "body", "description": "Mockup generation parameters", "required": true, "schema": { "required": [ "base_product_id", "mockup_ids" ], "properties": { "external_job_reference": { "description": "External reference to track the job", "type": "string", "example": 100 }, "base_product_id": { "description": "ID of the base product", "type": "integer", "example": 235 }, "base_product_skus": { "description": "SKUs (internal_sku) of the base product variants", "type": "array", "items": { "type": "string" } }, "color_ids": { "description": "Alternative to SKUs, IDs of colors if specific colors are to be used", "type": "array", "items": { "type": "integer" }, "example": 325 }, "mockup_ids": { "description": "IDs of mockups to generate", "type": "array", "items": { "type": "integer" } }, "processingarea_type_key": { "description": "Type of the processing area for the mockup", "type": "string", "example": "front" }, "processing_method_key": { "description": "Processing method key, e.g., 'dtg'", "type": "string", "example": "dtg" }, "mockup_width_px": { "description": "Width of the mockup in pixels; assumed to be square; max. 2000px", "type": "integer", "example": 2000 }, "design_url": { "description": "URL of the design to be used in the mockup", "type": "string", "example": "https://www.mysite.com/sample.png" }, "design_width_mm": { "description": "Width of the design in millimeters", "type": "integer", "example": 200 }, "design_height_mm": { "description": "Height of the design in millimeters", "type": "integer", "example": 150 }, "design_y_top_mm": { "description": "Top offset of the design in millimeters", "type": "integer", "example": 50 }, "design_x_center_mm": { "description": "Center offset of the design in millimeters", "type": "integer", "example": 0 }, "format": { "description": "Format of the generated image, 'jpg' or 'png' allowed", "type": "string", "example": "png" }, "background_color_hex": { "description": "Hex code of the background color", "type": "string", "example": "FFFFFF" }, "background_url": { "description": "URL of the background image", "type": "string" } }, "type": "object" } } ], "responses": { "200": { "description": "Mockup generated successfully", "schema": { "properties": { "success": { "description": "Generate Mockup Images\n\nThis endpoint allows users to generate custom mockup images based on the specified parameters.\nUsers must provide base product details, color specifications, and desired mockups along with design and processing instructions.\nThe baseProduct colors to be rendered can either be defined by a combination of base_product_id and base_product_color_ids or by base_product_skus. If all three paramters are provided, the skus will not be taken into consideration.\nNote: Mockup Factory only supports mockups where is_legacy is false", "type": "boolean", "example": true }, "message": { "description": "Generate Mockup Images\n\nThis endpoint allows users to generate custom mockup images based on the specified parameters.\nUsers must provide base product details, color specifications, and desired mockups along with design and processing instructions.\nThe baseProduct colors to be rendered can either be defined by a combination of base_product_id and base_product_color_ids or by base_product_skus. If all three paramters are provided, the skus will not be taken into consideration.\nNote: Mockup Factory only supports mockups where is_legacy is false", "type": "string", "example": "Mockup generation initiated successfully." } }, "type": "object" } }, "401": { "description": "Unauthorized" }, "422": { "description": "Validation failed for one or more parameters." } }, "security": [ { "api_auth": [] } ], "x-summary-de": "Erzeugt eigene Mockup-Bilder nach den \u00fcbergebenen Vorgaben.", "x-questions-de": [ "Wie erzeuge ich Mockups per API?", "Wie bekomme ich Produktbilder mit meinem Motiv?", "Wie nutze ich die Mockup-Factory?" ] } }, "/mockup-factory/rendering-tasks": { "get": { "tags": [ "Image-API" ], "summary": "Get Rendering Tasks", "description": "Retrieves a paginated list of mockup-factory rendering tasks for the authenticated user. This endpoint can be used to\nfetch all the rendering tasks generated by the user, allowing them to track progress or results.\nYou can register a webhook for the event GeneratedMedia.rendered", "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "List of rendering tasks", "type": "array", "items": { "$ref": "#/definitions/RenderingTask" } } }, "type": "object" } }, "403": { "description": "Unauthorized" }, "500": { "description": "Server Error" } }, "security": [ { "api_key": [] } ], "x-summary-de": "Liefert die Rendering-Auftr\u00e4ge der Mockup-Factory des Nutzers seitenweise.", "x-questions-de": [ "Wie sehe ich den Status meiner Mockup-Auftr\u00e4ge?", "Wie liste ich Mockup-Rendering-Tasks auf?", "Sind meine Mockups schon fertig gerendert?" ] } }, "/mockup-factory/rendering-tasks/{reference}": { "get": { "tags": [ "Image-API" ], "summary": "Get Rendering Task by Reference", "description": "Retrieves detailed information about a specific mockup-factory rendering task associated with the given reference\nidentifier. This endpoint is intended for users to fetch detailed information about a specific task, including\nits variations and current status.", "parameters": [ { "name": "reference", "in": "path", "description": "Unique reference of the rendering task", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Get Rendering Task by Reference\n\nRetrieves detailed information about a specific mockup-factory rendering task associated with the given reference\nidentifier. This endpoint is intended for users to fetch detailed information about a specific task, including\nits variations and current status.", "$ref": "#/definitions/RenderingTask" } }, "type": "object" } }, "404": { "description": "Not Found" }, "500": { "description": "Server Error" } }, "security": [ { "api_key": [] } ], "x-summary-de": "Liefert die Details eines einzelnen Rendering-Auftrags der Mockup-Factory.", "x-questions-de": [ "Wie rufe ich einen bestimmten Mockup-Auftrag ab?", "Wo bekomme ich die fertigen Mockup-Bilder?", "Wie frage ich den Status eines Rendering-Tasks ab?" ] } }, "/orders": { "get": { "tags": [ "Order-API" ], "summary": "Get all orders", "description": "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", "parameters": [ { "name": "page", "in": "query", "description": "Page number", "type": "integer", "default": 1 }, { "name": "filter", "in": "query", "description": "Filter by order status id", "type": "integer", "default": 1 }, { "name": "items", "in": "query", "description": "Items per page", "type": "integer", "default": 12 }, { "name": "search", "in": "query", "description": "Search query", "type": "integer" }, { "name": "sort_col", "in": "query", "description": "Property to order by", "type": "string", "default": "" }, { "name": "sort_dir", "in": "query", "description": "Order direction", "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, { "name": "period", "in": "query", "description": "Days to show (default: all)", "type": "integer" }, { "name": "secondary_filter", "in": "query", "description": "Secondary filter level (e.g. filter reprint orders)", "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/Order" } }, "meta": { "description": "Meta information", "properties": { "pagination": { "description": "Get all orders\n\nRetrieve all orders issued by the currently authenticated user.\nThe result will be paginated, meta information is included in the response.", "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-order" ] } ], "x-summary-de": "Liefert alle Bestellungen des Nutzers, filterbar und seitenweise.", "x-questions-de": [ "Wie rufe ich meine Bestellungen per API ab?", "Wie liste ich alle Orders auf?", "Wie filtere ich Bestellungen nach Status?" ] }, "post": { "tags": [ "Order-API" ], "summary": "Create order", "description": "Submit a new order for the currently authenticated user.\nThe user must have at least one registered and active billing method.\nA delivery address is required. The billing address is taken from the account data.\nThe sender information is optional; if not provided, the current user information will be used.\nOur complete base product catalog can be downloaded as an XLSX file in the Cockpit dashboard (Import -> Download -> Product Catalog).\n\nYou can either:\n1. Order existing products using their SKU (including warehouse products starting with \"WV-\")\n2. Order custom base products using base_product_sku with custom processings", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "required": [ "delivery", "products" ], "properties": { "delivery": { "description": "Delivery address of the recipient.", "$ref": "#/definitions/OrderAddress" }, "sender": { "description": "Sender address printed on the parcel. Must be a physical address in Germany. Default: the address of the account.", "$ref": "#/definitions/OrderAddress" }, "gpsr-manufacturer": { "description": "Manufacturer address for the product safety information (GPSR). Default: the setting of the account.", "$ref": "#/definitions/OrderAddress" }, "gpsr-representative": { "description": "Address of the responsible person in the EU for the product safety information (GPSR). Default: the setting of the account.", "$ref": "#/definitions/OrderAddress" }, "delayed_address_validation": { "description": "When set to true, only basic address validation is performed on the request itself: `delivery.street`, `delivery.postcode`, `delivery.city` and `delivery.country` have to be present, all length limits as well as the requirement for `delivery.firstname` and `delivery.lastname` are dropped.\n The full address validation then runs asynchronously after the order has been created. Orders with an invalid address are set to 'order clarification' status (order_status_id 80) instead of being rejected, and the `Order.clarification` webhook is fired.\n That webhook carries `clarification_type` (to distinguish an address problem from a stock or document problem), `address_errors` with the individual objections and, where available, `address_validation_errors` with the parsed carrier preflight response.\n The address must be corrected afterwards, either in the dashboard or via PUT /orders/{order_reference}. Once it validates, the order returns to its regular status and an `Order.updated` webhook is sent.", "type": "boolean", "example": false }, "products": { "description": "List of products to order. Can contain existing products (using SKU), warehouse products (using SKU starting with 'WV-'), or custom base products (using base_product_sku).", "type": "array", "items": { "properties": { "sku": { "description": "SKU of existing product or warehouse product (starts with 'WV-')", "type": "string" }, "base_product_sku": { "description": "SKU of base product variant for custom items", "type": "string" }, "amount": { "description": "Amount of this product", "type": "integer" }, "sales_price_gross": { "description": "Sales price in cents (only for custom base products)", "type": "integer" }, "external_reference": { "description": "Your internal reference for this product", "type": "string" }, "customizations": { "description": "Custom fields for this product", "type": "object", "example": { "my_textfield_1": "John", "my_textfield_2": "Doe" } }, "branding": { "description": "Branding information for this product", "properties": { "hangtag_reference": { "description": "Reference of the hangtag attached to the product.", "type": "string" }, "product_packaging_reference": { "description": "Reference of the product packaging, e.g. a polybag.", "type": "string" }, "imprint_reference": { "description": "Reference of the imprint, e.g. a neck print.", "type": "string" }, "label_reference": { "description": "Reference of the label sewn into the product.", "type": "string" } }, "type": "object" }, "processings": { "description": "Print data per print area. Required with base_product_sku and ignored for products ordered by sku.", "type": "array", "items": { "properties": { "processingarea_type": { "description": "Print area on the base product: front, back, sleeve-left, sleeve-right or back-inside. It must be available on the base product and is usually used once per product.", "type": "string", "example": "front" }, "processingmethod": { "description": "Print method, e.g. dtg, dtf, embroidery or sublimation. It must be available for this print area on the base product. Default: the only method of the print area, or dtg if there are several.", "type": "string", "example": "dtg" }, "design_url": { "description": "Public URL of the print file (PNG or JPEG). Required unless design_reference is given.", "type": "string", "example": "https://example.com/design.png" }, "design_reference": { "description": "Reference of a design uploaded beforehand via the Design API. Alternative to design_url.", "type": "string", "example": "310ef229-2254-4f4f-9041-a8e02674ff36" }, "width": { "description": "Width of the print in millimetres. Send width or height, the other follows from the aspect ratio of the design. width plus twice the absolute offset_center must fit into the print area.", "type": "integer", "example": 200 }, "height": { "description": "Height of the print in millimetres. height plus offset_top must fit into the print area.", "type": "integer", "example": 40 }, "offset_top": { "description": "Distance in millimetres from the top edge of the print area to the top edge of the design. Default 0.", "type": "integer", "example": 10 }, "offset_center": { "description": "Horizontal shift in millimetres of the design centre from the centre line of the print area, 0 means centred. Default 0.", "type": "integer", "example": 0 }, "force_position": { "description": "true uses the offsets exactly as given for every size. false (default, recommended) adjusts the position per garment size automatically.", "type": "boolean", "example": false }, "extract_size_and_position": { "description": "Treat design_url as a print file covering the whole print area at 300 dpi: transparent margins are trimmed and size and offsets are taken from the visible content. For dtg, dtf, sublimation and poster.", "type": "boolean", "example": false }, "resize_to_processingarea": { "description": "Scale the design down proportionally if it would not fit into the print area.", "type": "boolean", "example": false }, "ignore_validation": { "description": "Skip the minimum resolution check of the design (1000 px in width or height). Default true for design_url.", "type": "boolean", "example": true }, "mockups": { "description": "IDs of the product mockups to render the product images with. Default: the standard mockups of the print area.", "type": "array", "items": { "type": "integer", "example": 123 } } }, "type": "object" } } }, "type": "object" }, "example": [ { "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-123456", "amount": 5 }, { "base_product_sku": "STTK909C71012", "amount": 1, "sales_price_gross": 2199, "external_reference": "EX-123", "processings": [ { "processingarea_type": "front", "design_url": "https://example.com/design.png", "width": 200, "height": 40 } ] } ] }, "packaging_branding": { "description": "Order-level packaging and branding items. These are added once per order regardless of the number of products.", "properties": { "first_packin_reference": { "description": "Reference to the first packin (packaging insert) to be added to the order", "type": "string", "example": "PACKIN001" }, "second_packin_reference": { "description": "Reference to the second packin (packaging insert) to be added to the order", "type": "string", "example": "PACKIN002" }, "order_packaging_reference": { "description": "Reference to the order packaging (e.g., box, envelope) to be used for the entire order", "type": "string", "example": "BOX001" }, "sticker_reference": { "description": "Reference to the sticker to be applied to the order", "type": "string", "example": "STICKER001" } }, "type": "object" }, "default_product_branding": { "description": "Default branding items to be applied to each product in the order. These are applied per product unless overridden by product-specific branding.", "properties": { "hangtag_reference": { "description": "Reference to the hangtag to be attached to each product", "type": "string", "example": "HANGTAG001" }, "imprint_reference": { "description": "Reference to the imprint to be applied to each product", "type": "string", "example": "IMPRINT001" }, "label_reference": { "description": "Reference to the label to be attached to each product", "type": "string", "example": "LABEL001" }, "product_packaging_reference": { "description": "Reference to the product packaging (e.g., polybag) to be used for each product", "type": "string", "example": "BAG001" } }, "type": "object" }, "packins": { "description": "Legacy packin structure (deprecated, use packaging_branding and default_product_branding instead)", "properties": { "first_packin_reference": { "description": "Reference to the first packin", "type": "string" }, "second_packin_reference": { "description": "Reference to the second packin", "type": "string" }, "order_packaging_reference": { "description": "Reference to the order packaging", "type": "string" }, "sticker_reference": { "description": "Reference to the sticker", "type": "string" }, "hangtag_reference": { "description": "Reference to the hangtag", "type": "string" }, "imprint_reference": { "description": "Reference to the imprint", "type": "string" }, "label_reference": { "description": "Reference to the label", "type": "string" }, "product_packaging_reference": { "description": "Reference to the product packaging", "type": "string" } }, "type": "object" }, "documents": { "description": "Optional document references for the order. To use custom delivery receipts or return labels, please get in touch with your key account manager.", "properties": { "delivery-receipt": { "description": "Delivery receipt document information", "properties": { "media_reference": { "description": "Reference to the delivery receipt media", "type": "string", "example": "AABBCC" }, "external_reference": { "description": "External reference for the delivery receipt", "type": "string", "example": "123" } }, "type": "object" }, "merchant-invoice": { "description": "Merchant invoice document information", "properties": { "media_reference": { "description": "Reference to the merchant invoice media", "type": "string", "example": "AABBCC" }, "external_reference": { "description": "External reference for the merchant invoice", "type": "string", "example": "123" } }, "type": "object" }, "return-label": { "description": "Return label document information", "properties": { "external_reference": { "description": "External reference for the return label", "type": "string", "example": "ABCDEFG" }, "carrier_key": { "description": "Carrier key for the return label", "type": "string", "example": "DHL" }, "format": { "description": "Format of the return label. 'A4' includes a return sheet with a table for selecting return items and the return label. '10x20' contains only the return label.", "type": "string", "enum": [ "a4", "10x20" ], "example": "10x20" } }, "type": "object" }, "shipping-label": { "description": "Shipping label document information", "properties": { "media_reference": { "description": "Reference to the shipping label media", "type": "string", "example": "AABBCC" }, "shipping_handle": { "description": "Shipping carrier handle", "type": "string", "example": "DHL_STANDARD" }, "tracking_number": { "description": "Tracking number for the shipment", "type": "string", "example": "00314212423423" } }, "type": "object" } }, "type": "object" }, "fulfillment_mode_key": { "description": "Choose a special fulfilment mode for this order.", "type": "string", "example": "24h-express" }, "billing_method_reference": { "description": "Reference of billing method used for this order.", "type": "string", "example": "F80D66CF" }, "external_reference": { "description": "Your internal reference for the order, that will be added to the delivery note.", "type": "string", "example": "your internal order reference" }, "check_unique_external_reference": { "description": "Ensures that the provided external reference is unique within the account. Defaults to true when `external_reference` is provided. Only orders with an order_status_id below 90 are taken into account, so a reference used by a canceled or payment-failed order becomes available again. On a collision the request is rejected.", "type": "boolean", "example": true } }, "type": "object" } } ], "responses": { "201": { "description": "Success, order has been created", "schema": { "$ref": "#/definitions/Order" } }, "401": { "description": "Unauthorized (no credentials or not eligible for ordering)" }, "422": { "description": "Validation failed, details in response body" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-order" ] } ], "x-summary-de": "Legt eine neue Bestellung an. Eine Lieferadresse und eine aktive Zahlungsmethode sind n\u00f6tig; bestellt werden vorhandene Produkte per SKU oder Basisprodukte mit eigenen Drucken.", "x-questions-de": [ "Wie lege ich eine Bestellung per API an?", "Welche Pflichtfelder hat eine Bestellung \u00fcber die API?", "Wie bestelle ich ein Basisprodukt mit eigenem Motiv per API?", "Wie funktioniert die verz\u00f6gerte Adresspr\u00fcfung bei Bestellungen?" ] } }, "/orders/{order_reference}": { "get": { "tags": [ "Order-API" ], "summary": "Get order", "description": "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", "parameters": [ { "name": "order_reference", "in": "path", "description": "The unique reference identifier of the order", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/Order" } }, "404": { "description": "Order not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-order" ] } ], "x-summary-de": "Liefert eine einzelne Bestellung mit Status, Produkten und Versand.", "x-questions-de": [ "Wie rufe ich eine bestimmte Bestellung ab?", "Wie bekomme ich den Status und die Sendungsnummer einer Order?", "Wie frage ich eine Bestellung per Referenz ab?" ] }, "put": { "tags": [ "Order-API" ], "summary": "Update delivery address", "description": "Updates the delivery address of an existing order, for example to resolve an order in 'order clarification' status.\n The address object is flat and differs from the `delivery` object used when placing an order: it requires the `id` of the address to update\n and accepts only the fields listed below. The `id` is returned by GET /orders/{order_reference} as the address with `type` 'delivery'.\n **Without `id` the address is silently ignored and the endpoint still answers 204.**\n The country of an existing order cannot be changed.\n The submitted address is fully validated before it is stored, so a still incomplete correction is rejected with 400 instead of being accepted.", "parameters": [ { "name": "order_reference", "in": "path", "description": "The unique reference identifier of the order", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "required": [ "address" ], "properties": { "address": { "description": "Updated delivery address information", "required": [ "id" ], "properties": { "id": { "description": "ID of the address to update, taken from GET /orders/{order_reference}", "type": "integer", "example": 123456 }, "company": { "description": "Company name", "type": "string", "example": "Shirtigo GmbH" }, "firstname": { "description": "First name", "type": "string", "example": "Max" }, "lastname": { "description": "Last name", "type": "string", "example": "Mustermann" }, "care_of": { "description": "Care of (c/o)", "type": "string", "example": "Gift for Mrs. Doe" }, "street": { "description": "Street and number", "type": "string", "example": "Musterstra\u00dfe 12" }, "postcode": { "description": "ZIP/area code", "type": "string", "example": "12345" }, "city": { "description": "City", "type": "string", "example": "K\u00f6ln" } }, "type": "object" } }, "type": "object" } } ], "responses": { "400": { "description": "The submitted delivery address is invalid, the response body names the failing fields" }, "204": { "description": "Success, order has been updated" }, "401": { "description": "Unauthorized - Invalid credentials" }, "403": { "description": "Forbidden - Order cannot be edited (wrong status or already in production)" }, "404": { "description": "Order not found" }, "422": { "description": "Validation failed - Invalid address or other data" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-order" ] } ], "x-summary-de": "\u00c4ndert die Lieferadresse einer bestehenden Bestellung, z. B. um eine Bestellung in Kl\u00e4rung zu l\u00f6sen; die ID der Adresse ist Pflicht.", "x-questions-de": [ "Wie \u00e4ndere ich die Lieferadresse einer Bestellung per API?", "Wie korrigiere ich eine falsche Adresse nach dem Bestellen?", "Meine Bestellung h\u00e4ngt in Kl\u00e4rung wegen der Adresse, was tun?" ] } }, "/order/{reference}/release-onhold": { "put": { "tags": [ "Order-API" ], "summary": "Release onhold", "description": "Orders with Flag Onhold will not be send to production until flag is released.\nOnly Orders having completely rendered Images can be released.", "responses": { "204": { "description": "Success, orderProduct customized" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Gibt eine angehaltene (On-Hold) Bestellung f\u00fcr die Produktion frei.", "x-questions-de": [ "Wie gebe ich eine On-Hold-Bestellung frei?", "Wie schicke ich eine angehaltene Bestellung in Produktion?", "Wie hebe ich den On-Hold-Status per API auf?" ] } }, "/orders/{order_reference}/merchant-invoice": { "post": { "tags": [ "Order-API" ], "summary": "Upload Merchant Invoice", "description": "For orders shipped to non-eu states in some cases a customs invoice needs to be added. You can either submit it as an order document with the POST /orders call or react to the webhook after order was placed and use this endpoint.", "parameters": [ { "name": "invoice", "in": "formData", "description": "Merchant invoice file", "type": "file" } ], "responses": { "201": { "description": "Success, merchant invoice has been uploaded" }, "401": { "description": "Unauthorized (no credentials or not eligible for ordering)" }, "422": { "description": "Validation failed, details in response body" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-order" ] } ], "x-summary-de": "L\u00e4dt die Handelsrechnung f\u00fcr Bestellungen in Nicht-EU-L\u00e4nder hoch, die f\u00fcr den Zoll gebraucht wird.", "x-questions-de": [ "Wie lade ich die Handelsrechnung f\u00fcr den Zoll hoch?", "Meine Bestellung wartet auf Dokumente, was muss ich tun?", "Wie \u00fcbermittle ich eine Rechnung f\u00fcr den Versand in die Schweiz?" ] } }, "/order/{reference}/set-onhold": { "put": { "tags": [ "Order-API" ], "summary": "Set onhold", "description": "Orders with Flag Onhold will not be send to production until flag is released.\nOrders can be set to onhold until they are pushed to production", "responses": { "204": { "description": "Success, orderProduct customized" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "H\u00e4lt eine Bestellung an (On-Hold), damit sie nicht in Produktion geht.", "x-questions-de": [ "Wie halte ich eine Bestellung an?", "Wie verhindere ich, dass eine Bestellung produziert wird?", "Wie setze ich eine Order per API auf On-Hold?" ] } }, "/integration/{integrationreference}/{integrationOrderId}/reference": { "get": { "tags": [ "Order-API" ], "summary": "Get OrderReference", "description": "Get shirtigo order reference for given integrationId and integration orderId", "responses": { "204": { "description": "Success, orderProduct customized" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Liefert die Shirtigo-Bestellreferenz zu einer Bestellnummer aus dem Shop.", "x-questions-de": [ "Wie finde ich die Shirtigo-Bestellung zu meiner Shop-Bestellnummer?", "Wie ordne ich eine Shopify-Order der Cockpit-Bestellung zu?", "Wie bekomme ich die Order-Referenz zu einer externen Bestellung?" ] } }, "/orders/predict-price": { "post": { "tags": [ "Order-API" ], "summary": "Calculate price", "description": "Calculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "required": [ "delivery", "products" ], "properties": { "delivery": { "description": "Delivery address of the recipient.", "$ref": "#/definitions/OrderAddress" }, "sender": { "description": "Sender address printed on the parcel. Must be a physical address in Germany. Default: the address of the account.", "$ref": "#/definitions/OrderAddress" }, "gpsr-manufacturer": { "description": "Manufacturer address for the product safety information (GPSR). Default: the setting of the account.", "$ref": "#/definitions/OrderAddress" }, "gpsr-representative": { "description": "Address of the responsible person in the EU for the product safety information (GPSR). Default: the setting of the account.", "$ref": "#/definitions/OrderAddress" }, "products": { "description": "List of products to order", "type": "array", "items": { "properties": { "sku": { "description": "SKU of existing product or warehouse product (starts with 'WV-')", "type": "string", "example": "c123456.122.8" }, "base_product_sku": { "description": "SKU of base product variant for custom items", "type": "string", "example": "STTK909C71012" }, "amount": { "description": "Amount of this product", "type": "integer", "example": 2 }, "customizations": { "description": "Custom fields for this product", "properties": { "my_textfield_1": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "John" }, "my_textfield_2": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "Doe" } }, "type": "object" }, "branding": { "description": "Branding information for this product", "properties": { "hangtag_reference": { "description": "Reference of the hangtag attached to the product.", "type": "string", "example": "A12345" }, "product_packaging_reference": { "description": "Reference of the product packaging, e.g. a polybag.", "type": "string", "example": "A12345" }, "imprint_reference": { "description": "Reference of the imprint, e.g. a neck print.", "type": "string", "example": "A12345" }, "label_reference": { "description": "Reference of the label sewn into the product.", "type": "string", "example": "A12345" } }, "type": "object" }, "processings": { "description": "Print data per print area. Required with base_product_sku and ignored for products ordered by sku.", "type": "array", "items": { "properties": { "processingarea_type": { "description": "Print area on the base product: front, back, sleeve-left, sleeve-right or back-inside. It must be available on the base product and is usually used once per product.", "type": "string", "example": "front" }, "processingmethod": { "description": "Print method, e.g. dtg, dtf, embroidery or sublimation. It must be available for this print area on the base product. Default: the only method of the print area, or dtg if there are several.", "type": "string", "example": "dtg" }, "design_url": { "description": "Public URL of the print file (PNG or JPEG). Required unless design_reference is given.", "type": "string", "example": "https://example.com/design.png" }, "design_reference": { "description": "Reference of a design uploaded beforehand via the Design API. Alternative to design_url.", "type": "string", "example": "310ef229-2254-4f4f-9041-a8e02674ff36" }, "width": { "description": "Width of the print in millimetres. Send width or height, the other follows from the aspect ratio of the design. width plus twice the absolute offset_center must fit into the print area.", "type": "integer", "example": 200 }, "height": { "description": "Height of the print in millimetres. height plus offset_top must fit into the print area.", "type": "integer", "example": 40 }, "offset_top": { "description": "Distance in millimetres from the top edge of the print area to the top edge of the design. Default 0.", "type": "integer", "example": 10 }, "offset_center": { "description": "Horizontal shift in millimetres of the design centre from the centre line of the print area, 0 means centred. Default 0.", "type": "integer", "example": 0 }, "force_position": { "description": "true uses the offsets exactly as given for every size. false (default, recommended) adjusts the position per garment size automatically.", "type": "boolean", "example": false }, "extract_size_and_position": { "description": "Treat design_url as a print file covering the whole print area at 300 dpi: transparent margins are trimmed and size and offsets are taken from the visible content. For dtg, dtf, sublimation and poster.", "type": "boolean", "example": false }, "resize_to_processingarea": { "description": "Scale the design down proportionally if it would not fit into the print area.", "type": "boolean", "example": false }, "ignore_validation": { "description": "Skip the minimum resolution check of the design (1000 px in width or height). Default true for design_url.", "type": "boolean", "example": true }, "mockups": { "description": "IDs of the product mockups to render the product images with. Default: the standard mockups of the print area.", "type": "array", "items": { "type": "integer", "example": 123 } } }, "type": "object" } } }, "type": "object" } }, "packaging_branding": { "description": "Order-level packaging and branding items. These are added once per order regardless of the number of products.", "properties": { "first_packin_reference": { "description": "Reference to the first packin (packaging insert) to be added to the order", "type": "string", "example": "PACKIN001" }, "second_packin_reference": { "description": "Reference to the second packin (packaging insert) to be added to the order", "type": "string", "example": "PACKIN002" }, "order_packaging_reference": { "description": "Reference to the order packaging (e.g., box, envelope) to be used for the entire order", "type": "string", "example": "BOX001" }, "sticker_reference": { "description": "Reference to the sticker to be applied to the order", "type": "string", "example": "STICKER001" } }, "type": "object" }, "default_product_branding": { "description": "Default branding items to be applied to each product in the order. These are applied per product unless overridden by product-specific branding.", "properties": { "hangtag_reference": { "description": "Reference to the hangtag to be attached to each product", "type": "string", "example": "HANGTAG001" }, "imprint_reference": { "description": "Reference to the imprint to be applied to each product", "type": "string", "example": "IMPRINT001" }, "label_reference": { "description": "Reference to the label to be attached to each product", "type": "string", "example": "LABEL001" }, "product_packaging_reference": { "description": "Reference to the product packaging (e.g., polybag) to be used for each product", "type": "string", "example": "BAG001" } }, "type": "object" }, "packins": { "description": "Legacy packin structure (deprecated, use packaging_branding and default_product_branding instead)", "properties": { "first_packin_reference": { "description": "Reference to the first packin", "type": "string" }, "second_packin_reference": { "description": "Reference to the second packin", "type": "string" }, "order_packaging_reference": { "description": "Reference to the order packaging", "type": "string" }, "sticker_reference": { "description": "Reference to the sticker", "type": "string" }, "hangtag_reference": { "description": "Reference to the hangtag", "type": "string" }, "imprint_reference": { "description": "Reference to the imprint", "type": "string" }, "label_reference": { "description": "Reference to the label", "type": "string" }, "product_packaging_reference": { "description": "Reference to the product packaging", "type": "string" } }, "type": "object" }, "fulfillment_mode_key": { "description": "Choose a special fulfilment mode for this order", "type": "string", "example": "24h-express" }, "billing_method_reference": { "description": "Reference of billing method used for this order", "type": "string", "example": "F80D66CF" }, "external_reference": { "description": "Your internal reference for the order", "type": "string", "example": "your internal order reference" }, "check_unique_external_reference": { "description": "Ensures that the provided external reference is unique within the account. Defaults to true when `external_reference` is provided. Only orders with an order_status_id below 90 are taken into account, so a reference used by a canceled or payment-failed order becomes available again. On a collision the request is rejected.", "type": "boolean", "example": true }, "documents": { "description": "Optional document references for the order", "properties": { "delivery_receipt": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "properties": { "media_reference": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "AABBCC" }, "external_reference": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "123" } }, "type": "object" }, "merchant_invoice": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "properties": { "media_reference": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "AABBCC" }, "external_reference": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "123" } }, "type": "object" }, "return_label": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "properties": { "external_reference": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "ABCDEFG" }, "carrier_key": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "DHL" } }, "type": "object" }, "shipping-label": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "properties": { "media_reference": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "AABBCC" }, "shipping_handle": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "DHL_STANDARD" }, "tracking_number": { "description": "Calculate price\n\nCalculate the full price (incl. shipping and taxes) for the selected order candidate.\nThis can be done *before* ordering. The parameters are the same as to the \"Create Order\" endpoint.", "type": "string", "example": "00314212423423" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } ], "responses": { "200": { "description": "Success, price has been calculated", "schema": { "properties": { "products_net_price": { "description": "Net price of all products in the order", "$ref": "#/definitions/Money" }, "shipping_net_price": { "description": "Net shipping price calculated from products", "$ref": "#/definitions/Money" }, "total_net_price": { "description": "Total net price (shipping + products)", "$ref": "#/definitions/Money" }, "total_gross_price": { "description": "Total gross price (shipping + products + taxes)", "$ref": "#/definitions/Money" }, "included_tax": { "description": "Taxes, calculated from the total net price", "$ref": "#/definitions/Money" }, "included_tax_rate": { "description": "VAT rate in percent", "type": "integer", "example": 19 } }, "type": "object" } }, "422": { "description": "Validation failed, details in response body" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Berechnet vor dem Bestellen den Gesamtpreis einer Bestellung inklusive Versand und Steuern.", "x-questions-de": [ "Was kostet eine Bestellung inklusive Versand?", "Wie berechne ich den Preis vor dem Bestellen per API?", "Wie bekomme ich die Versandkosten f\u00fcr eine Bestellung?" ] } }, "/orders/available-fulfillment-modes": { "post": { "tags": [ "Order-API" ], "summary": "Get available fulfillment modes", "description": "Get a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "required": [ "delivery", "products" ], "properties": { "delivery": { "description": "Delivery address of the recipient.", "$ref": "#/definitions/OrderAddress" }, "sender": { "description": "Sender address printed on the parcel. Must be a physical address in Germany. Default: the address of the account.", "$ref": "#/definitions/OrderAddress" }, "gpsr-manufacturer": { "description": "Manufacturer address for the product safety information (GPSR). Default: the setting of the account.", "$ref": "#/definitions/OrderAddress" }, "gpsr-representative": { "description": "Address of the responsible person in the EU for the product safety information (GPSR). Default: the setting of the account.", "$ref": "#/definitions/OrderAddress" }, "products": { "description": "List of products to order", "type": "array", "items": { "properties": { "sku": { "description": "SKU of existing product or warehouse product (starts with 'WV-')", "type": "string", "example": "c123456.122.8" }, "base_product_sku": { "description": "SKU of base product variant for custom items", "type": "string", "example": "STTK909C71012" }, "amount": { "description": "Amount of this product", "type": "integer", "example": 2 }, "customizations": { "description": "Custom fields for this product", "properties": { "my_textfield_1": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "John" }, "my_textfield_2": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "Doe" } }, "type": "object" }, "branding": { "description": "Branding information for this product", "properties": { "hangtag_reference": { "description": "Reference of the hangtag attached to the product.", "type": "string", "example": "A12345" }, "product_packaging_reference": { "description": "Reference of the product packaging, e.g. a polybag.", "type": "string", "example": "A12345" }, "imprint_reference": { "description": "Reference of the imprint, e.g. a neck print.", "type": "string", "example": "A12345" }, "label_reference": { "description": "Reference of the label sewn into the product.", "type": "string", "example": "A12345" } }, "type": "object" }, "processings": { "description": "Print data per print area. Required with base_product_sku and ignored for products ordered by sku.", "type": "array", "items": { "properties": { "processingarea_type": { "description": "Print area on the base product: front, back, sleeve-left, sleeve-right or back-inside. It must be available on the base product and is usually used once per product.", "type": "string", "example": "front" }, "processingmethod": { "description": "Print method, e.g. dtg, dtf, embroidery or sublimation. It must be available for this print area on the base product. Default: the only method of the print area, or dtg if there are several.", "type": "string", "example": "dtg" }, "design_url": { "description": "Public URL of the print file (PNG or JPEG). Required unless design_reference is given.", "type": "string", "example": "https://example.com/design.png" }, "design_reference": { "description": "Reference of a design uploaded beforehand via the Design API. Alternative to design_url.", "type": "string", "example": "310ef229-2254-4f4f-9041-a8e02674ff36" }, "width": { "description": "Width of the print in millimetres. Send width or height, the other follows from the aspect ratio of the design. width plus twice the absolute offset_center must fit into the print area.", "type": "integer", "example": 200 }, "height": { "description": "Height of the print in millimetres. height plus offset_top must fit into the print area.", "type": "integer", "example": 40 }, "offset_top": { "description": "Distance in millimetres from the top edge of the print area to the top edge of the design. Default 0.", "type": "integer", "example": 10 }, "offset_center": { "description": "Horizontal shift in millimetres of the design centre from the centre line of the print area, 0 means centred. Default 0.", "type": "integer", "example": 0 }, "force_position": { "description": "true uses the offsets exactly as given for every size. false (default, recommended) adjusts the position per garment size automatically.", "type": "boolean", "example": false }, "extract_size_and_position": { "description": "Treat design_url as a print file covering the whole print area at 300 dpi: transparent margins are trimmed and size and offsets are taken from the visible content. For dtg, dtf, sublimation and poster.", "type": "boolean", "example": false }, "resize_to_processingarea": { "description": "Scale the design down proportionally if it would not fit into the print area.", "type": "boolean", "example": false }, "ignore_validation": { "description": "Skip the minimum resolution check of the design (1000 px in width or height). Default true for design_url.", "type": "boolean", "example": true }, "mockups": { "description": "IDs of the product mockups to render the product images with. Default: the standard mockups of the print area.", "type": "array", "items": { "type": "integer", "example": 123 } } }, "type": "object" } } }, "type": "object" } }, "packaging_branding": { "description": "Order-level packaging and branding items. These are added once per order regardless of the number of products.", "properties": { "first_packin_reference": { "description": "Reference to the first packin (packaging insert) to be added to the order", "type": "string", "example": "PACKIN001" }, "second_packin_reference": { "description": "Reference to the second packin (packaging insert) to be added to the order", "type": "string", "example": "PACKIN002" }, "order_packaging_reference": { "description": "Reference to the order packaging (e.g., box, envelope) to be used for the entire order", "type": "string", "example": "BOX001" }, "sticker_reference": { "description": "Reference to the sticker to be applied to the order", "type": "string", "example": "STICKER001" } }, "type": "object" }, "default_product_branding": { "description": "Default branding items to be applied to each product in the order. These are applied per product unless overridden by product-specific branding.", "properties": { "hangtag_reference": { "description": "Reference to the hangtag to be attached to each product", "type": "string", "example": "HANGTAG001" }, "imprint_reference": { "description": "Reference to the imprint to be applied to each product", "type": "string", "example": "IMPRINT001" }, "label_reference": { "description": "Reference to the label to be attached to each product", "type": "string", "example": "LABEL001" }, "product_packaging_reference": { "description": "Reference to the product packaging (e.g., polybag) to be used for each product", "type": "string", "example": "BAG001" } }, "type": "object" }, "packins": { "description": "Legacy packin structure (deprecated, use packaging_branding and default_product_branding instead)", "properties": { "first_packin_reference": { "description": "Reference to the first packin", "type": "string" }, "second_packin_reference": { "description": "Reference to the second packin", "type": "string" }, "order_packaging_reference": { "description": "Reference to the order packaging", "type": "string" }, "sticker_reference": { "description": "Reference to the sticker", "type": "string" }, "hangtag_reference": { "description": "Reference to the hangtag", "type": "string" }, "imprint_reference": { "description": "Reference to the imprint", "type": "string" }, "label_reference": { "description": "Reference to the label", "type": "string" }, "product_packaging_reference": { "description": "Reference to the product packaging", "type": "string" } }, "type": "object" }, "fulfillment_mode_key": { "description": "Choose a special fulfilment mode for this order", "type": "string", "example": "24h-express" }, "billing_method_reference": { "description": "Reference of billing method used for this order", "type": "string", "example": "F80D66CF" }, "external_reference": { "description": "Your internal reference for the order", "type": "string", "example": "your internal order reference" }, "check_unique_external_reference": { "description": "Ensures that the provided external reference is unique within the account. Defaults to true when `external_reference` is provided. Only orders with an order_status_id below 90 are taken into account, so a reference used by a canceled or payment-failed order becomes available again. On a collision the request is rejected.", "type": "boolean", "example": true }, "documents": { "description": "Optional document references for the order", "properties": { "delivery_receipt": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "properties": { "media_reference": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "AABBCC" }, "external_reference": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "123" } }, "type": "object" }, "merchant_invoice": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "properties": { "media_reference": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "AABBCC" }, "external_reference": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "123" } }, "type": "object" }, "return_label": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "properties": { "external_reference": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "ABCDEFG" }, "carrier_key": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "DHL" } }, "type": "object" }, "shipping-label": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "properties": { "media_reference": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "AABBCC" }, "shipping_handle": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "DHL_STANDARD" }, "tracking_number": { "description": "Get available fulfillment modes\n\nGet a list of all fulfillment modes which can be used for this order. This endpoint can be used to collect\nthe available options in a checkout process.", "type": "string", "example": "00314212423423" } }, "type": "object" } }, "type": "object" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/FulfillmentMode" } } }, "type": "object" } }, "422": { "description": "Validation failed, details in response body" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert die Fulfillment-Modi, die f\u00fcr eine konkrete Bestellung m\u00f6glich sind, z. B. ob Express geht.", "x-questions-de": [ "Ist Express f\u00fcr meine Bestellung m\u00f6glich?", "Welche Fulfillment-Modi kann ich f\u00fcr diese Bestellung w\u00e4hlen?", "Wie pr\u00fcfe ich vor dem Bestellen die verf\u00fcgbaren Optionen?" ] } }, "/orders/{order_reference}/repay": { "post": { "tags": [ "Order-API" ], "summary": "Retry payment", "description": "Set the order payment method to the current user's payment method and retry credit card capture.", "parameters": [ { "name": "order_reference", "in": "path", "description": "The unique reference identifier of the order", "required": true, "type": "string" } ], "responses": { "204": { "description": "Success, order has been paid." }, "400": { "description": "Payment failed (either duplicate payment or an error occured)." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-order" ] } ], "x-summary-de": "Versucht die Zahlung einer Bestellung mit der aktuellen Zahlungsmethode des Nutzers erneut.", "x-questions-de": [ "Wie bezahle ich eine Bestellung mit fehlgeschlagener Zahlung nochmal?", "Die Zahlung ist fehlgeschlagen, wie versuche ich es erneut?", "Wie wiederhole ich die Kreditkartenabbuchung per API?" ] } }, "/orders/{order_reference}/cancel": { "post": { "tags": [ "Order-API" ], "summary": "Cancel order", "description": "Set the order status to canceled.", "parameters": [ { "name": "order_reference", "in": "path", "description": "The unique reference identifier of the order", "required": true, "type": "string" } ], "responses": { "204": { "description": "Success, order has been canceled." }, "404": { "description": "Order not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-order" ] } ], "x-summary-de": "Storniert eine Bestellung.", "x-questions-de": [ "Wie storniere ich eine Bestellung per API?", "Wie breche ich eine Order ab?", "Kann ich eine Bestellung \u00fcber die API stornieren?" ] } }, "/orders/{order_reference}/comments": { "post": { "tags": [ "Order-API" ], "summary": "Add order comment", "description": "Creates a new comment for a given order. Expects the comment text.", "parameters": [ { "name": "order_reference", "in": "path", "description": "The unique reference identifier of the order", "required": true, "type": "string" }, { "name": "body", "in": "body", "required": true, "schema": { "properties": { "comment": { "description": "Add order comment\n\nCreates a new comment for a given order. Expects the comment text.", "type": "string", "example": "Customer requested express shipping" } }, "type": "object" } } ], "responses": { "200": { "description": "Success" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-order" ] } ], "x-summary-de": "F\u00fcgt einer Bestellung einen Kommentar hinzu.", "x-questions-de": [ "Wie hinterlege ich einen Kommentar an einer Bestellung?", "Wie schicke ich eine Notiz zu einer Order per API?", "Kann ich dem Support \u00fcber die API einen Hinweis zur Bestellung geben?" ] } }, "/orders/{order_reference}/invoice": { "get": { "tags": [ "Order-API" ], "summary": "Retrieve order invoice", "description": "Fetches and returns the invoice for a given order as a PDF file.", "parameters": [ { "name": "order_reference", "in": "path", "description": "Unique identifier of the order for which to retrieve the invoice", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success, invoice is returned as a PDF file.", "schema": { "type": "file" } }, "404": { "description": "Order not found or invoice not available." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-order" ] } ], "x-summary-de": "Liefert die Rechnung einer Bestellung als PDF.", "x-questions-de": [ "Wie lade ich die Rechnung einer Bestellung herunter?", "Wo bekomme ich die Rechnung als PDF per API?", "Wie rufe ich die Rechnung zu einer Order ab?" ] } }, "/orderproduct/{reference}/customize": { "put": { "tags": [ "Order-API" ], "summary": "Customize OrderProduct", "description": "Customize an existing OrderProduct for the currently authenticated user.", "parameters": [ { "name": "design_reference", "in": "query", "description": "Reference of design", "type": "string" }, { "name": "processingarea_type_id", "in": "query", "description": "Processingarea to be customized. 1 = front, 2 = back", "type": "integer" }, { "name": "width", "in": "query", "description": "Width of design in millimeter", "type": "integer" }, { "name": "offset_top", "in": "query", "description": "Offset to collar in millimeter", "type": "integer" }, { "name": "offset_center", "in": "query", "description": "x-shift to centerline in millimeter", "type": "integer" } ], "responses": { "204": { "description": "Success, orderProduct customized" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Passt ein Produkt innerhalb einer Bestellung individuell an.", "x-questions-de": [ "Wie \u00e4ndere ich den Druck eines Produkts in einer Bestellung?", "Wie personalisiere ich eine Bestellposition?", "Kann ich ein bestelltes Produkt nachtr\u00e4glich anpassen?" ] } }, "/orderproduct/{reference}": { "put": { "tags": [ "Order-API" ], "summary": "Update OrderProduct", "description": "Update an existing OrderProducts size or/and color for the currently authenticated user.", "parameters": [ { "name": "color_id", "in": "query", "description": "ID for new color", "type": "integer" }, { "name": "size_id", "in": "query", "description": "ID for new size", "type": "integer" }, { "name": "replacement_requested", "in": "query", "description": "Use replacement product in case current Product is not available", "type": "boolean" } ], "responses": { "204": { "description": "Success, orderProduct updated" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "\u00c4ndert Gr\u00f6\u00dfe oder Farbe eines Produkts in einer bestehenden Bestellung.", "x-questions-de": [ "Wie \u00e4ndere ich die Gr\u00f6\u00dfe in einer Bestellung?", "Wie tausche ich die Farbe eines bestellten Produkts?", "Kann ich eine Bestellposition per API \u00e4ndern?" ] }, "delete": { "tags": [ "Order-API" ], "summary": "Delete OrderProduct", "description": "Delete an existing OrderProducts for the currently authenticated user.", "responses": { "204": { "description": "Success, orderProduct deleted" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-project" ] } ], "x-summary-de": "Entfernt ein Produkt aus einer bestehenden Bestellung.", "x-questions-de": [ "Wie entferne ich ein Produkt aus einer Bestellung?", "Wie l\u00f6sche ich eine Bestellposition per API?", "Kann ich einen Artikel aus einer Order herausnehmen?" ] } }, "/stock/base-products": { "get": { "tags": [ "Stock-API" ], "summary": "Get stock of base products", "description": "Returns the stock of all base product variants available to you, as an object keyed by base_product_sku (as returned by the Catalog-API). Pass `skus` to restrict the result to a comma separated list of SKUs. Unknown SKUs are omitted from the result.", "parameters": [ { "name": "skus", "in": "query", "description": "Comma separated list of base product SKUs", "required": false, "type": "string", "x-example": "SK-1234-M,SK-1234-L" } ], "responses": { "200": { "description": "Success", "schema": { "description": "Stock per base product SKU", "type": "object", "additionalProperties": { "$ref": "#/definitions/Stock" } } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [] } ], "x-summary-de": "Liefert den Lagerbestand aller Basisprodukt-Varianten oder einer Liste von Basisprodukt-SKUs, als Objekt mit der SKU als Schl\u00fcssel.", "x-questions-de": [ "Wie frage ich den Bestand aller Basisprodukte ab?", "Wie bekomme ich den Lagerbestand f\u00fcr eine Basisprodukt-SKU?", "Ist ein bestimmtes Textil auf Lager?", "Wie frage ich Best\u00e4nde f\u00fcr mehrere SKUs auf einmal ab?" ] } }, "/stock/products": { "get": { "tags": [ "Stock-API" ], "summary": "Get stock of your products", "description": "Returns the stock of all your product variants as an object keyed by the variant's integration_sku, plus the stock of your warehouse products keyed by their reference (WV-...). Pass `skus` to restrict the result to a comma separated list of integration SKUs and warehouse references. Unknown SKUs are omitted from the result.", "parameters": [ { "name": "skus", "in": "query", "description": "Comma separated list of integration SKUs and warehouse references", "required": false, "type": "string", "x-example": "c48211.a3f9e1,WV-8F3K2Q" } ], "responses": { "200": { "description": "Success", "schema": { "description": "Stock per integration SKU or warehouse reference", "type": "object", "additionalProperties": { "$ref": "#/definitions/ProductStock" } } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-project" ] } ], "x-summary-de": "Liefert den Lagerbestand aller eigenen Produktvarianten und Warehousing-Produkte oder einer Liste von SKUs, als Objekt mit der integration_sku bzw. Warehousing-Referenz als Schl\u00fcssel.", "x-questions-de": [ "Wie frage ich den Bestand meiner Produkte ab?", "Wie bekomme ich den Lagerbestand f\u00fcr eine integration_sku?", "Wie synchronisiere ich Best\u00e4nde in meinen Shop?", "Wie frage ich den Bestand meiner eingelagerten Warehousing-Produkte ab?" ] } }, "/user": { "get": { "tags": [ "User-API" ], "summary": "Get user information", "description": "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", "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/User" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert die Daten des angemeldeten Nutzers.", "x-questions-de": [ "Wie rufe ich meine Account-Daten per API ab?", "Wie bekomme ich die Daten des angemeldeten Nutzers?", "Wie pr\u00fcfe ich, mit welchem Account der API-Key verbunden ist?" ] }, "post": { "tags": [ "User-API" ], "summary": "Update user information", "description": "Update (some) fields of the currently authenticated user profile.", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "firstname", "lastname", "street", "postcode", "city", "country", "is_business" ], "properties": { "firstname": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "lastname": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "street": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "postcode": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "city": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "country": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "company_name": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "phone": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "string" }, "is_business": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "boolean" }, "fulfillment_mode_key": { "description": "Update user information\n\nUpdate (some) fields of the currently authenticated user profile.", "type": "boolean" } }, "type": "object" } } ], "responses": { "204": { "description": "User information updated." }, "422": { "description": "Validation of inputs failed." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "\u00c4ndert einzelne Felder des Nutzerprofils.", "x-questions-de": [ "Wie \u00e4ndere ich meine Account-Daten per API?", "Wie aktualisiere ich mein Profil?", "Kann ich die Rechnungsadresse \u00fcber die API \u00e4ndern?" ] } }, "/user/delivery-receipt-logo": { "post": { "tags": [ "Branding-API" ], "summary": "Upload delivery receipt logo", "description": "Upload a logo to your user account which is printed on the delivery receipt for your customers to increase the branding of your fulfillment\n\nThe file needs to be a png with 900px x 385px (width x height).\n\nThe endpoint returns an empty array with exit code 200.", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "Design file", "type": "file" } ], "responses": { "200": { "description": "Success, delivery receipt logo was uploaded" }, "422": { "description": "Error, image file does not meet requirements" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "L\u00e4dt ein Logo hoch, das auf den Lieferschein gedruckt wird.", "x-questions-de": [ "Wie bringe ich mein Logo auf den Lieferschein?", "Wie lade ich ein Lieferschein-Logo per API hoch?", "Kann ich den Lieferschein mit meinem Branding versehen?" ] } }, "/user/delivery-receipt-logo/{integration_id}": { "delete": { "tags": [ "Branding-API" ], "summary": "Delete a delivery receipt logo", "description": "The endpoint returns an empty array with exit code 200.", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "integration_id", "in": "path", "description": "Unique integration identifier", "type": "string" } ], "responses": { "200": { "description": "Success, delivery receipt logo was deleted" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "L\u00f6scht ein Lieferschein-Logo.", "x-questions-de": [ "Wie entferne ich das Logo vom Lieferschein?", "Wie l\u00f6sche ich ein Lieferschein-Logo per API?", "Wie setze ich den Lieferschein auf neutral zur\u00fcck?" ] } }, "/user/sticker": { "post": { "tags": [ "Branding-API" ], "summary": "Upload sticker logo", "description": "Upload a sticker to your user account which is printed on packaging for your customers to increase the branding of your fulfillment\n\nThe file needs to be a png with 560px x 560px (width x height).\n\nThe endpoint returns an empty array with exit code 200.", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "file", "in": "formData", "description": "Design file", "type": "file" }, { "name": "assign", "in": "formData", "description": "Whether to assign this sticker as the default for the user or integration (defaults to true)", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Success, sticker was uploaded" }, "422": { "description": "Error, image file does not meet requirements" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "L\u00e4dt ein Sticker-Logo hoch, das auf die Verpackung gedruckt wird.", "x-questions-de": [ "Wie bringe ich mein Logo auf die Versandverpackung?", "Wie lade ich einen Sticker per API hoch?", "Kann ich Pakete mit meinem Branding bekleben lassen?" ] } }, "/user/sticker/{integration_id}": { "delete": { "tags": [ "Branding-API" ], "summary": "Delete sticker logo", "description": "The endpoint returns an empty array with exit code 200.", "consumes": [ "multipart/form-data" ], "parameters": [ { "name": "integration_id", "in": "path", "description": "Unique integration identifier", "type": "string" } ], "responses": { "200": { "description": "Success, sticker was deleted" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "L\u00f6scht ein Sticker-Logo.", "x-questions-de": [ "Wie entferne ich meinen Sticker?", "Wie l\u00f6sche ich das Verpackungs-Logo per API?", "Wie schalte ich den Branding-Sticker ab?" ] } }, "/user/sender-address": { "post": { "tags": [ "User-API" ], "summary": "Update sender address", "description": "Update sender address fields of currently authenticated user.", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "sender_firstname", "sender_lastname", "sender_street", "sender_postcode", "sender_city", "sender_country" ], "properties": { "sender_company_name": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string", "maxLength": 40 }, "sender_firstname": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string", "maxLength": 20 }, "sender_lastname": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string", "maxLength": 20 }, "sender_street": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string", "maxLength": 35 }, "sender_postcode": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string", "maxLength": 9, "minLength": 3 }, "sender_city": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string", "maxLength": 30 }, "sender_country": { "description": "Update sender address\n\nUpdate sender address fields of currently authenticated user.", "type": "string" } }, "type": "object" } } ], "responses": { "204": { "description": "User information updated." }, "422": { "description": "Validation of inputs failed." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "\u00c4ndert die Absenderadresse des Nutzers, die auf Sendungen steht.", "x-questions-de": [ "Wie \u00e4ndere ich die Absenderadresse auf den Paketen?", "Wie setze ich eine eigene Absenderadresse per API?", "Welche Adresse steht als Absender auf meinen Sendungen?" ] } }, "/user/gpsr-address": { "post": { "tags": [ "User-API" ], "summary": "Update GPSR Addresses", "description": "Updates the GPSR manufacturer and representative address fields for the authenticated user.\n * If the country requires a representative address (VAT_TYPE_WORLD), both addresses must be provided.", "parameters": [ { "name": "body", "in": "body", "description": "GPSR Address details", "required": true, "schema": { "required": [ "gpsr_manufacturer_company_name", "gpsr_manufacturer_street", "gpsr_manufacturer_postcode", "gpsr_manufacturer_city", "gpsr_manufacturer_email", "gpsr_manufacturer_country" ], "properties": { "gpsr_manufacturer_company_name": { "description": "Update GPSR Addresses\n\nUpdates the GPSR manufacturer and representative address fields for the currently authenticated user.\nThis endpoint validates and saves the required address information based on the user's country and VAT rules.", "type": "string", "maxLength": 30 }, "gpsr_manufacturer_street": { "description": "Update GPSR Addresses\n\nUpdates the GPSR manufacturer and representative address fields for the currently authenticated user.\nThis endpoint validates and saves the required address information based on the user's country and VAT rules.", "type": "string", "maxLength": 35 }, "gpsr_manufacturer_postcode": { "description": "Update GPSR Addresses\n\nUpdates the GPSR manufacturer and representative address fields for the currently authenticated user.\nThis endpoint validates and saves the required address information based on the user's country and VAT rules.", "type": "string" }, "gpsr_manufacturer_city": { "description": "Update GPSR Addresses\n\nUpdates the GPSR manufacturer and representative address fields for the currently authenticated user.\nThis endpoint validates and saves the required address information based on the user's country and VAT rules.", "type": "string", "maxLength": 30 }, "gpsr_manufacturer_email": { "description": "Update GPSR Addresses\n\nUpdates the GPSR manufacturer and representative address fields for the currently authenticated user.\nThis endpoint validates and saves the required address information based on the user's country and VAT rules.", "type": "string", "format": "email" }, "gpsr_manufacturer_country": { "description": "Update GPSR Addresses\n\nUpdates the GPSR manufacturer and representative address fields for the currently authenticated user.\nThis endpoint validates and saves the required address information based on the user's country and VAT rules.", "type": "string" }, "gpsr_representative_company_name": { "description": "Required if manufacturer is located outside EU", "type": "string", "maxLength": 30 }, "gpsr_representative_street": { "description": "Required if manufacturer is located outside EU", "type": "string", "maxLength": 35 }, "gpsr_representative_postcode": { "description": "Required if manufacturer is located outside EU", "type": "string" }, "gpsr_representative_city": { "description": "Required if manufacturer is located outside EU", "type": "string", "maxLength": 30 }, "gpsr_representative_email": { "description": "Required if manufacturer is located outside EU", "type": "string", "format": "email" }, "gpsr_representative_country": { "description": "Required if manufacturer is located outside EU", "type": "string" } }, "type": "object" } } ], "responses": { "204": { "description": "GPSR address information updated successfully." }, "422": { "description": "Validation failed. Check the input data for errors." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "Hinterlegt die GPSR-Adressen von Hersteller und, bei Sitz au\u00dferhalb der EU, Vertreter.", "x-questions-de": [ "Wie hinterlege ich die GPSR-Herstellerangaben?", "Brauche ich einen EU-Vertreter f\u00fcr die Produktsicherheit?", "Wie setze ich die GPSR-Adressen per API?" ] } }, "/user/advanced": { "post": { "tags": [ "User-API" ], "summary": "Update user advanced", "description": "Update advanced user settings.", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "locale": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "accounting_email": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "customs_email": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "receives_mail_order_placed": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "receives_mail_order_shipped": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "use_tracking_de": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "use_tracking_eu": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "use_tracking_world": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "add_delivery_receipt": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "use_custom_product_name": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "boolean" }, "delivery_receipt_note": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_first_packin_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_second_packin_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_hangtag_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_imprint_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_label_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_product_packaging_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" }, "default_order_packaging_reference": { "description": "Update user advanced\n\nUpdate advanced user settings.", "type": "string" } }, "type": "object" } } ], "responses": { "204": { "description": "User information updated." }, "422": { "description": "Validation of inputs failed." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "\u00c4ndert erweiterte Account-Einstellungen des Nutzers.", "x-questions-de": [ "Wie \u00e4ndere ich erweiterte Einstellungen meines Accounts?", "Wo stelle ich Produktions- und Versandoptionen per API ein?", "Wie aktualisiere ich die Advanced Settings?" ] } }, "/user/packin": { "put": { "tags": [ "Branding-API" ], "summary": "Update user packin", "description": "Update an existing packin (packaging insert) name for the authenticated user.", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "reference", "name" ], "properties": { "reference": { "description": "Unique packin reference identifier", "type": "string" }, "name": { "description": "New name for the packin", "type": "string" } }, "type": "object" } } ], "responses": { "204": { "description": "Packin updated successfully" }, "404": { "description": "Packin not found" }, "422": { "description": "Validation failed - name is required" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "\u00c4ndert den Namen einer Beilage (Packin).", "x-questions-de": [ "Wie benenne ich eine Packin-Beilage um?", "Wie \u00e4ndere ich eine Paketbeilage per API?", "Kann ich den Namen eines Hangtags \u00e4ndern?" ] }, "post": { "tags": [ "Branding-API" ], "summary": "Create user packin", "description": "Create a new custom packin (packaging insert) for the user account.\nPackings include items like hangtags, labels, stickers, and custom packaging materials.", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "name", "type" ], "properties": { "name": { "description": "Name of the packin", "type": "string" }, "type": { "description": "Type of packin", "type": "string", "enum": [ "packin", "hangtag", "imprint", "label", "sticker" ] }, "position_key": { "description": "Position key for placement", "type": "string" }, "size_id": { "description": "Size identifier", "type": "integer" }, "color_ids": { "description": "Color identifiers", "type": "string" }, "weight": { "description": "Weight in grams (required for packin, hangtag types)", "type": "integer", "maximum": 30, "minimum": 1 }, "width": { "description": "Width in mm (varies by type: packin/hangtag 1-150mm, imprint 50-100mm, label 15-80mm)", "type": "integer" }, "height": { "description": "Height in mm (varies by type: packin/hangtag 1-200mm, imprint 20-80mm, label 10-35mm)", "type": "integer" }, "depth": { "description": "Depth in mm", "type": "integer", "minimum": 0 }, "inventory": { "description": "Inventory quantity", "type": "integer" }, "preview_media_id": { "description": "Preview media object ID", "type": "integer" }, "production_file_media_id": { "description": "Production file media object ID", "type": "integer" }, "admin_packin_price_net": { "description": "Custom price (only for users with extended API access)", "type": "number" } }, "type": "object" } } ], "responses": { "200": { "description": "Packin created successfully", "schema": { "$ref": "#/definitions/UserPackin" } }, "400": { "description": "Bad request - Unknown packin type" }, "422": { "description": "Validation failed" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "Legt eine eigene Beilage (Packin) an, z. B. Hangtag, Label oder Flyer.", "x-questions-de": [ "Wie lege ich eine eigene Paketbeilage an?", "Wie erstelle ich einen Hangtag per API?", "Wie f\u00fcge ich Flyer oder Labels zu meinen Sendungen hinzu?" ] }, "delete": { "tags": [ "Branding-API" ], "summary": "Delete user packin", "description": "Delete an existing packin (packaging insert) for the authenticated user.\nOnly inactive packings can be deleted - warehoused (active) packings must be handled by customer support.", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "reference" ], "properties": { "reference": { "description": "Unique packin reference identifier", "type": "string" } }, "type": "object" } } ], "responses": { "204": { "description": "Packin deleted successfully" }, "403": { "description": "Cannot delete active/warehoused packin - contact customer support" }, "404": { "description": "Packin not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "L\u00f6scht eine eigene Beilage (Packin); nur inaktive Beilagen k\u00f6nnen gel\u00f6scht werden.", "x-questions-de": [ "Wie l\u00f6sche ich eine Paketbeilage?", "Warum kann ich meine Beilage nicht l\u00f6schen?", "Wie entferne ich einen Hangtag per API?" ] } }, "/user/packin/{reference}": { "get": { "tags": [ "Branding-API" ], "summary": "Get single user packin", "description": "Retrieve details of a specific packin (packaging insert) by reference for the authenticated user.", "parameters": [ { "name": "reference", "in": "path", "description": "Unique packin reference identifier", "required": true, "type": "string" } ], "responses": { "200": { "description": "Packin details retrieved successfully", "schema": { "$ref": "#/definitions/UserPackin" } }, "404": { "description": "Packin not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert eine einzelne Beilage (Packin) anhand ihrer Referenz.", "x-questions-de": [ "Wie rufe ich eine bestimmte Beilage ab?", "Wie bekomme ich die Details eines Hangtags?", "Wie frage ich ein Packin per Referenz ab?" ] } }, "/user/packings": { "get": { "tags": [ "Branding-API" ], "summary": "Get user packings", "description": "Retrieve all packings (packaging inserts) available to the authenticated user.\nThis includes both user-created packings and global packings available to all users.", "responses": { "200": { "description": "List of user packings retrieved successfully", "schema": { "type": "array", "items": { "$ref": "#/definitions/UserPackin" } } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert alle Beilagen und Verpackungen, die dem Nutzer zur Verf\u00fcgung stehen.", "x-questions-de": [ "Welche Beilagen und Verpackungen kann ich nutzen?", "Wie liste ich meine Packins per API auf?", "Wo finde ich die Referenzen f\u00fcr Hangtags und Verpackungen?" ] } }, "/user/packings/prices": { "get": { "tags": [ "Branding-API" ], "summary": "Get packin prices", "description": "Retrieve current pricing information for different types of packings.\nPrices are returned with and without VAT for cost calculation purposes.", "responses": { "200": { "description": "Packin pricing information retrieved successfully", "schema": { "properties": { "stocking": { "description": "Stocking cost pricing", "type": "object" }, "hangtag": { "description": "Hangtag pricing", "type": "object" }, "packin": { "description": "Packin pricing", "type": "object" }, "imprint": { "description": "Imprint pricing", "type": "object" }, "label": { "description": "Label pricing", "type": "object" }, "sticker": { "description": "Sticker pricing", "type": "object" } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert die aktuellen Preise der Beilagen und Verpackungen mit und ohne MwSt.", "x-questions-de": [ "Was kosten Beilagen und Verpackungen?", "Wie frage ich die Preise f\u00fcr Hangtags per API ab?", "Wie teuer ist eine eigene Paketbeilage?" ] } }, "/inbound/{reference}": { "get": { "tags": [ "Warehousing-API" ], "summary": "Get InboundShipping", "description": "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 ", "parameters": [ { "name": "reference", "in": "query", "description": "Reference of the Variant to be updated", "type": "string" }, { "name": "include", "in": "query", "description": "Which linked entities you want to include into the response, separated by comma. Available includes are Items", "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseInboundShipment" } }, "404": { "description": "WarehouseInboundShipment not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert eine Warehousing-Anlieferung (Inbound) anhand ihrer Referenz.", "x-questions-de": [ "Wie rufe ich eine Anlieferung ins Lager ab?", "Wie sehe ich den Status meiner Warenanlieferung?", "Wie frage ich eine Inbound-Sendung per API ab?" ] }, "delete": { "tags": [ "Warehousing-API" ], "summary": "Delete InboundShipping", "description": "Deletes WarehouseInboundShipment", "parameters": [ { "name": "reference", "in": "query", "description": "Reference of the InboundShipment to be deleted", "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseInboundShipment" } }, "404": { "description": "WarehouseInboundShipment not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "L\u00f6scht eine Warehousing-Anlieferung (Inbound).", "x-questions-de": [ "Wie l\u00f6sche ich eine Anlieferung?", "Wie storniere ich eine Inbound-Sendung?", "Kann ich eine angemeldete Warenlieferung entfernen?" ] } }, "/inbound/{reference}/perform": { "post": { "tags": [ "Warehousing-API" ], "summary": "Perform solution for inbound shipment", "description": "Execute a solution for an inbound shipment. The solution can be paid via wallet balance or direct debit billing method.", "parameters": [ { "name": "reference", "in": "path", "description": "Reference of the inbound shipment", "required": true, "type": "string", "example": "IS-123456" }, { "name": "body", "in": "body", "required": true, "schema": { "required": [ "solution", "billing_method" ], "properties": { "solution": { "description": "Solution key to execute for the inbound shipment. Available options: ship-again, discard, store, bulk-store", "type": "string", "enum": [ "ship-again", "discard", "store", "bulk-store" ], "example": "discard" }, "billing_method": { "description": "Reference of the billing method to use for payment", "type": "string", "example": "F80D66CF" }, "address": { "description": "Optional address information for the solution", "properties": { "company": { "description": "Company name", "type": "string", "maxLength": 40, "example": "ACME Corp" }, "firstname": { "description": "First name", "type": "string", "maxLength": 20, "example": "John" }, "lastname": { "description": "Last name", "type": "string", "maxLength": 20, "example": "Doe" }, "care_of": { "description": "Care of", "type": "string", "maxLength": 35, "example": "Reception" }, "street": { "description": "Street address", "type": "string", "maxLength": 35, "example": "123 Main St" }, "postcode": { "description": "Postal code", "type": "string", "maxLength": 9, "minLength": 3, "example": "12345" }, "city": { "description": "City", "type": "string", "maxLength": 30, "example": "New York" }, "country": { "description": "Country code (ISO 2-letter)", "type": "string", "maxLength": 2, "minLength": 2, "example": "US" } }, "type": "object" } }, "type": "object" } } ], "responses": { "200": { "description": "Success, solution has been executed" }, "401": { "description": "Unauthorized (no credentials or not eligible)" }, "404": { "description": "Inbound shipment not found" }, "422": { "description": "Validation failed or payment method issues", "schema": { "properties": { "message": { "description": "Perform solution for inbound shipment\n\nExecute a solution for an inbound shipment. This endpoint allows you to process\na solution for handling an inbound shipment issue. The solution can be paid\nvia wallet balance or direct debit billing method.", "type": "string", "example": "No billingMethod for given reference found." } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "F\u00fchrt eine L\u00f6sung f\u00fcr eine problematische Anlieferung aus; bezahlt wird per Wallet oder Lastschrift.", "x-questions-de": [ "Wie l\u00f6se ich ein Problem mit meiner Anlieferung?", "Wie bezahle ich die Kl\u00e4rung einer Inbound-Sendung?", "Was tun, wenn meine Warenanlieferung fehlerhaft war?" ] } }, "/verifications": { "get": { "tags": [ "User-API" ], "summary": "Get user verifications", "description": "Retrieve all verification records for the currently authenticated user.", "parameters": [ { "name": "include", "in": "query", "description": "Comma-separated values to include additional resources", "type": "string" } ], "responses": { "200": { "description": "Successful retrieval of user verification data." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert die Verifizierungen des Nutzers.", "x-questions-de": [ "Wie sehe ich den Stand meiner Verifizierung?", "Wie rufe ich meine Verifizierungen per API ab?", "Ist mein Account verifiziert?" ] } }, "/verifications/create": { "post": { "tags": [ "User-API" ], "summary": "Create a new user verification", "description": "Allows the creation of a new verification record for the authenticated user.", "parameters": [ { "name": "body", "in": "body", "schema": { "required": [ "type", "identifier", "country_iso" ], "properties": { "type": { "description": "Create a new user verification\n\nAllows the creation of a new verification record for the authenticated user.", "type": "string", "enum": [ "vat", "tax", "lucid" ] }, "identifier": { "description": "Create a new user verification\n\nAllows the creation of a new verification record for the authenticated user.", "type": "string", "example": "ATU1234567" }, "country_iso": { "description": "Create a new user verification\n\nAllows the creation of a new verification record for the authenticated user.", "type": "string", "example": "AT" }, "fiscal_representation": { "description": "Create a new user verification\n\nAllows the creation of a new verification record for the authenticated user.", "type": "string" } }, "type": "object" } } ], "responses": { "201": { "description": "Verification record created successfully." }, "422": { "description": "Validation of inputs failed." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-user" ] } ], "x-summary-de": "Legt eine neue Verifizierung f\u00fcr den Nutzer an.", "x-questions-de": [ "Wie starte ich eine Verifizierung per API?", "Wie verifiziere ich meinen Account?", "Wie lege ich eine neue Verifizierung an?" ] } }, "/webhooks": { "get": { "tags": [ "Webhook-API" ], "summary": "List webhooks", "description": "Returns a list of webhooks with pagination and optional filtering. The following events are available: Order (.created, .updated, .shipped, .canceled, .clarification, .creation-failed), Design (.created, .updated, .rendering-failed, .deleted), Product (.created, .updated, .deleted), OrderProductItem.updated, OrderWarehouseProductItem.updated, GeneratedMedia.rendered, UserInboundShipping.created", "operationId": "indexUserWebhooks", "produces": [ "application/json" ], "parameters": [ { "name": "items", "in": "query", "description": "Number of items per page", "required": false, "type": "integer", "default": 10 }, { "name": "sort_col", "in": "query", "description": "Column to sort by", "required": false, "type": "string", "default": "created_at" }, { "name": "sort_dir", "in": "query", "description": "Sort direction (asc or desc)", "required": false, "type": "string", "default": "asc" }, { "name": "resource", "in": "query", "description": "Filter by resource. See WebhookTypes objects for available options.", "required": false, "type": "string" }, { "name": "action", "in": "query", "description": "Filter by action. See WebhookTypes objects for available options.", "required": false, "type": "string" }, { "name": "is_active", "in": "query", "description": "Filter by active status", "required": false, "type": "boolean" }, { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include in the response. Available resources: type, calls", "required": false, "type": "string" }, { "name": "loaded_webhook_calls", "in": "query", "description": "Number of loaded webhook calls when the calls include is used", "required": false, "type": "integer", "default": 10 } ], "responses": { "200": { "description": "Successful operation", "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/definitions/UserWebhook" } }, "meta": { "properties": { "pagination": { "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } }, "401": { "description": "Unauthorized" }, "400": { "description": "Bad request" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-webhook" ] } ], "x-summary-de": "Liefert die Webhooks des Nutzers, filterbar und seitenweise, und nennt die verf\u00fcgbaren Ereignisse.", "x-questions-de": [ "Wie liste ich meine Webhooks auf?", "Welche Webhook-Ereignisse gibt es?", "Wie sehe ich, welche Webhooks registriert sind?" ] }, "post": { "tags": [ "Webhook-API" ], "summary": "Create a new webhook", "description": "Create a new webhook based on the provided data", "operationId": "createUserWebhook", "consumes": [ "multipart/form-data" ], "produces": [ "application/json" ], "parameters": [ { "name": "resource", "in": "formData", "description": "Resource for which this webhook should be registered. Required together with action if no types array is passed.", "required": false, "type": "string" }, { "name": "action", "in": "formData", "description": "Action for which this webhook should be registered. Required together with resource if no types array is passed.", "required": false, "type": "string" }, { "name": "types", "in": "formData", "description": "Array of webhook type keys as an alternative to providing resource and action.", "required": false, "type": "array", "items": { "type": "string" } }, { "name": "url", "in": "formData", "description": "URL", "required": true, "type": "string" }, { "name": "secret", "in": "formData", "description": "Secret used to sign webhook calls. The raw JSON body is hashed with HMAC-SHA256 and transmitted as a lowercase hex string. Generated automatically when omitted.", "required": false, "type": "string" }, { "name": "signature_header", "in": "formData", "description": "Name of the request header that carries the signature. Defaults to `signature` when omitted.", "required": false, "type": "string" }, { "name": "is_active", "in": "formData", "description": "Indicates if the webhook is active.", "required": false, "type": "boolean" } ], "responses": { "201": { "description": "webhook created successfully", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/Webhook" } }, "meta": { "description": "Meta information", "properties": { "pagination": { "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } }, "400": { "description": "Invalid input data" }, "401": { "description": "Unauthorized" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-webhook" ] } ], "x-summary-de": "Registriert einen neuen Webhook f\u00fcr Ereignisse wie neue oder versendete Bestellungen.", "x-questions-de": [ "Wie lege ich einen Webhook an?", "Wie werde ich bei Status\u00e4nderungen einer Bestellung benachrichtigt?", "Wie registriere ich eine URL f\u00fcr Webhooks?" ] } }, "/webhooks/{id}": { "get": { "tags": [ "Webhook-API" ], "summary": "Get a single webhook by ID", "description": "Retrieve a single webhook by its reference ID.", "parameters": [ { "name": "id", "in": "path", "description": "The reference ID of the webhook.", "required": true, "type": "string" }, { "name": "include", "in": "query", "description": "Comma-separated list of related resources to include in the response. Available resources: type, calls", "required": false, "type": "string" } ], "responses": { "200": { "description": "webhook retrieved successfully.", "schema": { "$ref": "#/definitions/Webhook" } }, "404": { "description": "webhook not found." }, "401": { "description": "Unauthorized." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-webhook" ] } ], "x-summary-de": "Liefert einen einzelnen Webhook anhand seiner Referenz.", "x-questions-de": [ "Wie rufe ich einen bestimmten Webhook ab?", "Wie sehe ich die Einstellungen eines Webhooks?", "Wie frage ich einen Webhook per ID ab?" ] }, "put": { "tags": [ "Webhook-API" ], "summary": "Update a webhook", "description": "Updates the specified webhook with the provided information.", "operationId": "updateUserWebhook", "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "description": "webhook reference", "required": true, "type": "string" }, { "name": "url", "in": "formData", "description": "URL for the webhook.", "required": true, "type": "string", "format": "url" }, { "name": "secret", "in": "formData", "description": "Secret used to sign webhook calls. The raw JSON body is hashed with HMAC-SHA256 and transmitted as a lowercase hex string.", "required": false, "type": "string" }, { "name": "signature_header", "in": "formData", "description": "Name of the request header that carries the signature. Defaults to `signature` when omitted.", "required": false, "type": "string" }, { "name": "is_active", "in": "formData", "description": "Whether the webhook is active.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Successful operation", "schema": { "$ref": "#/definitions/UserWebhook" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiError" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-webhook" ] } ], "x-summary-de": "\u00c4ndert einen Webhook, z. B. URL, Secret oder Aktivstatus.", "x-questions-de": [ "Wie \u00e4ndere ich die URL eines Webhooks?", "Wie aktiviere ich einen deaktivierten Webhook wieder?", "Wie \u00e4ndere ich das Secret eines Webhooks?" ] }, "delete": { "tags": [ "Webhook-API" ], "summary": "Delete a webhook", "description": "Delete a webhook by its reference.", "operationId": "deleteUserWebhook", "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "description": "Reference of the webhook to delete.", "required": true, "type": "string" } ], "responses": { "204": { "description": "webhook successfully deleted." }, "401": { "description": "Unauthorized. Access token is missing or invalid." }, "403": { "description": "Forbidden. The user does not have the necessary permissions." }, "404": { "description": "Not Found. The specified webhook could not be found." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-webhook" ] } ], "x-summary-de": "L\u00f6scht einen Webhook.", "x-questions-de": [ "Wie l\u00f6sche ich einen Webhook?", "Wie melde ich einen Webhook ab?", "Wie entferne ich eine Webhook-URL?" ] } }, "/webhooks/": { "put": { "tags": [ "Webhook-API" ], "summary": "Bulk Update webhook with same URL", "description": "Updates the specified webhooks for the given URL with the provided information.", "operationId": "updateUserWebhook", "produces": [ "application/json" ], "parameters": [ { "name": "url", "in": "formData", "description": "URL for the webhooks.", "required": true, "type": "string", "format": "url" }, { "name": "secret", "in": "formData", "description": "Secret used to sign webhook calls. The raw JSON body is hashed with HMAC-SHA256 and transmitted as a lowercase hex string.", "required": false, "type": "string" }, { "name": "signature_header", "in": "formData", "description": "Name of the request header that carries the signature. Defaults to `signature` when omitted.", "required": false, "type": "string" }, { "name": "is_active", "in": "formData", "description": "Whether the updated webhooks are active.", "required": false, "type": "boolean" }, { "name": "drop_unlisted", "in": "formData", "description": "Remove all webhooks for this URL, which are not part of the listed types.", "required": false, "type": "boolean" } ], "responses": { "200": { "description": "Successful operation", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/UserWebhook" } } }, "type": "object" } }, "400": { "description": "Bad Request", "schema": { "$ref": "#/definitions/ApiError" } }, "401": { "description": "Unauthorized", "schema": { "$ref": "#/definitions/ApiError" } }, "404": { "description": "Not Found", "schema": { "$ref": "#/definitions/ApiError" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-webhook" ] } ], "x-summary-de": "\u00c4ndert alle Webhooks mit derselben URL auf einmal.", "x-questions-de": [ "Wie \u00e4ndere ich mehrere Webhooks gleichzeitig?", "Wie aktualisiere ich alle Webhooks einer URL?", "Wie ziehe ich alle Webhooks auf eine neue Adresse um?" ] } }, "/webhooks/{id}/test": { "post": { "tags": [ "Webhook-API" ], "summary": "Test a webook", "description": "Test a webhook for a given resource.", "operationId": "testUserWebhook", "produces": [ "application/json" ], "parameters": [ { "name": "id", "in": "path", "description": "Reference of the webhook to delete.", "required": true, "type": "string" }, { "name": "resource_id", "in": "formData", "description": "Reference of the resource used to create thhe test webhook.", "required": true, "type": "string" } ], "responses": { "204": { "description": "test webhook successfully send." }, "401": { "description": "Unauthorized. Access token is missing or invalid." }, "403": { "description": "Forbidden. The user does not have the necessary permissions." }, "404": { "description": "Not Found. The specified webhook could not be found." } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "write-webhook" ] } ], "x-summary-de": "Sendet einen Testaufruf eines Webhooks f\u00fcr eine angegebene Ressource.", "x-questions-de": [ "Wie teste ich einen Webhook?", "Wie l\u00f6se ich einen Webhook testweise aus?", "Wie pr\u00fcfe ich, ob mein Server Webhooks empf\u00e4ngt?" ] } }, "/webhook-types": { "get": { "tags": [ "Webhook-API" ], "summary": "Get all User Webhook Types", "description": "Retrieve a list of all available User Webhook Types", "operationId": "getTypes", "produces": [ "application/json" ], "responses": { "200": { "description": "A list of User Webhook Types", "schema": { "type": "array", "items": { "$ref": "#/definitions/WebhookType" } } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-webhook" ] } ], "x-summary-de": "Liefert alle verf\u00fcgbaren Webhook-Typen.", "x-questions-de": [ "Welche Webhook-Typen gibt es?", "F\u00fcr welche Ereignisse kann ich Webhooks registrieren?", "Wie frage ich die Webhook-Typen per API ab?" ] } }, "/warehousing/inventory": { "get": { "tags": [ "Warehousing-API" ], "summary": "Get WarehouseProductVariant", "description": "Returns the list of WarehouseProductVariants assiciated with the particular User.", "parameters": [ { "name": "include", "in": "query", "description": "Which linked entities you want to include into the response, separated by comma. Available includes are Image and Product", "type": "string", "default": "Image" }, { "name": "search", "in": "query", "description": "Search in in variants by the name", "type": "string", "default": "" }, { "name": "page", "in": "query", "description": "Current page", "type": "integer", "default": 1 }, { "name": "items", "in": "query", "description": "Number of items per page", "type": "integer", "default": 12 }, { "name": "sort", "in": "query", "description": "Column used to sort the results. You can sort by: name, reference, created_at, updated_at", "type": "string", "default": "name" }, { "name": "order", "in": "query", "description": "Direction for sorting", "type": "string", "default": "ASC" }, { "name": "type", "in": "query", "description": "Type of the products to query. Options are warehouse, return and all.", "type": "string", "default": "warehouse" } ], "responses": { "200": { "description": "Success", "schema": { "properties": { "data": { "description": "Returned items", "type": "array", "items": { "$ref": "#/definitions/WarehouseProductVariant" } }, "meta": { "description": "Meta information", "properties": { "pagination": { "description": "Get WarehouseProductVariant", "$ref": "#/definitions/Pagination" } }, "type": "object" } }, "type": "object" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert den Lagerbestand der Warehousing-Produktvarianten des Nutzers.", "x-questions-de": [ "Wie frage ich meinen Lagerbestand per API ab?", "Wie viele Artikel habe ich im Warehousing?", "Wie bekomme ich den Bestand meiner eingelagerten Produkte?" ] } }, "/warehousing/products/{reference}": { "get": { "tags": [ "Warehousing-API" ], "summary": "Get WarehouseProduct", "description": "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 ", "parameters": [ { "name": "reference", "in": "query", "description": "Reference of the Variant to be updated", "type": "string" }, { "name": "include", "in": "query", "description": "Which linked entities you want to include into the response, separated by comma. Available includes are Variant and Variants", "type": "string", "default": "Variants" } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseProduct" } }, "404": { "description": "WarehouseProduct not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Liefert ein Warehousing-Produkt anhand seiner Referenz.", "x-questions-de": [ "Wie rufe ich ein eingelagertes Produkt ab?", "Wie sehe ich die Varianten eines Warehousing-Produkts?", "Wie frage ich ein Warehouse-Produkt per Referenz ab?" ] }, "put": { "tags": [ "Warehousing-API" ], "summary": "Update WarehouseProduct", "description": "Updates WarehouseProduct with default Variant and associated Variants", "parameters": [ { "name": "reference", "in": "query", "description": "Reference of the WarehouseProduct to be updated", "type": "string" }, { "name": "body", "in": "body", "schema": { "properties": { "name": { "description": "Project name", "type": "string", "example": "My cool warehouse product" }, "description": { "description": "Project description", "type": "string", "example": "My cool warehouse product's description" }, "size": { "description": "Size of the default product's variant", "type": "string", "example": "S" }, "color": { "description": "Color of the default product's variant", "type": "string", "example": "white" }, "hs_code": { "description": "HS Code of default product's variant", "type": "string", "example": "DE123456" }, "country_of_origin": { "description": "Country of Origin of default product's variant", "type": "string", "example": "DE" }, "item_value": { "description": "Item value in cents of default product's variant", "type": "integer", "example": "52000" }, "net_sales_price": { "description": "Net sales price in cents of default product's variant", "type": "integer", "example": "1250" }, "depth_cm": { "description": "Depth in cm of default product's variant", "type": "integer", "example": "30" }, "width_cm": { "description": "Width in cm of default product's variant", "type": "integer", "example": "30" }, "height_cm": { "description": "Height in cm of default product's variant", "type": "integer", "example": "30" }, "weight_gram": { "description": "Weight in grams of default product's variant", "type": "integer", "example": "30" }, "needs_box_shipping": { "description": "Indicates whether the default product's variant should be shipping in a box", "type": "boolean", "example": "false" }, "min_stock_quantity": { "description": "Minimal stock quantity of default product's variant", "type": "integer", "example": "100" }, "image": { "description": "WarehouseProduct variant image", "type": "object", "$ref": "#/definitions/Media" }, "variants": { "description": "The array of variants of the WarehouseProduct, excluding default one", "type": "array", "items": { "$ref": "#/definitions/WarehouseProductVariant" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseProduct" } }, "404": { "description": "WarehouseProduct not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "\u00c4ndert ein Warehousing-Produkt samt Standard- und weiteren Varianten.", "x-questions-de": [ "Wie \u00e4ndere ich ein Warehousing-Produkt?", "Wie aktualisiere ich die Varianten eines eingelagerten Produkts?", "Wie bearbeite ich ein Warehouse-Produkt per API?" ] } }, "/warehousing/products": { "post": { "tags": [ "Warehousing-API" ], "summary": "Create WarehouseProduct", "description": "Creates WarehouseProduct with default Variant and associated Variants", "parameters": [ { "name": "body", "in": "body", "schema": { "properties": { "name": { "description": "Project name", "type": "string", "example": "My cool warehouse product" }, "description": { "description": "Project description", "type": "string", "example": "My cool warehouse product's description" }, "size": { "description": "Size of the default product's variant", "type": "string", "example": "S" }, "color": { "description": "Color of the default product's variant", "type": "string", "example": "white" }, "hs_code": { "description": "HS Code of default product's variant", "type": "string", "example": "DE123456" }, "country_of_origin": { "description": "Country of Origin of default product's variant", "type": "string", "example": "DE" }, "item_value": { "description": "Item value in cents of default product's variant", "type": "integer", "example": "52000" }, "net_sales_price": { "description": "Net sales price in cents of default product's variant", "type": "integer", "example": "1250" }, "depth_cm": { "description": "Depth in cm of default product's variant", "type": "integer", "example": "30" }, "width_cm": { "description": "Width in cm of default product's variant", "type": "integer", "example": "30" }, "height_cm": { "description": "Height in cm of default product's variant", "type": "integer", "example": "30" }, "weight_gram": { "description": "Weight in grams of default product's variant", "type": "integer", "example": "30" }, "needs_box_shipping": { "description": "Indicates whether the default product's variant should be shipping in a box", "type": "boolean", "example": "false" }, "min_stock_quantity": { "description": "Minimal stock quantity of default product's variant", "type": "integer", "example": "100" }, "image": { "description": "WarehouseProduct image", "type": "object", "$ref": "#/definitions/Media" }, "variants": { "description": "The array of variants of the WarehouseProduct, excluding default one", "type": "array", "items": { "$ref": "#/definitions/WarehouseProductVariant" } } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseProduct" } } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "Legt ein Warehousing-Produkt mit Standard- und weiteren Varianten an.", "x-questions-de": [ "Wie lege ich ein Produkt f\u00fcr die Einlagerung an?", "Wie erstelle ich ein Warehousing-Produkt per API?", "Wie melde ich eigene Ware f\u00fcr das Lager an?" ] } }, "/warehousing/products/{product_reference}/variants/{reference}": { "put": { "tags": [ "Warehousing-API" ], "summary": "Update WarehouseProductVariant", "description": "Updates WarehouseProductVariant", "parameters": [ { "name": "product_reference", "in": "path", "description": "Reference of the WarehouseProduct to which the updated Variant belongs to", "type": "string" }, { "name": "reference", "in": "path", "description": "Reference of the Variant to be updated", "type": "string" }, { "name": "body", "in": "body", "schema": { "properties": { "size": { "description": "Size of the product's variant", "type": "string", "example": "S" }, "color": { "description": "Color of the product's variant", "type": "string", "example": "white" }, "hs_code": { "description": "HS Code of product's variant", "type": "string", "example": "DE123456" }, "country_of_origin": { "description": "Country of Origin of product's variant", "type": "string", "example": "DE" }, "item_value": { "description": "Item value in cents of product's variant", "type": "integer", "example": "52000" }, "net_sales_price": { "description": "Net sales price in cents of product's variant", "type": "integer", "example": "1250" }, "depth_cm": { "description": "Depth in cm of product's variant", "type": "integer", "example": "30" }, "width_cm": { "description": "Width in cm of product's variant", "type": "integer", "example": "30" }, "height_cm": { "description": "Height in cm of product's variant", "type": "integer", "example": "30" }, "weight_gram": { "description": "Weight in grams of product's variant", "type": "integer", "example": "30" }, "needs_box_shipping": { "description": "Indicates whether the product's variant should be shipping in a box", "type": "boolean", "example": "false" }, "min_stock_quantity": { "description": "Minimal stock quantity of product's variant", "type": "integer", "example": "100" }, "image": { "description": "WarehouseProduct variant image", "type": "object", "$ref": "#/definitions/Media" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseProductVariant" } }, "404": { "description": "WarehouseProductVariant not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "\u00c4ndert eine Variante eines Warehousing-Produkts.", "x-questions-de": [ "Wie \u00e4ndere ich eine Variante eines Lagerprodukts?", "Wie aktualisiere ich Gr\u00f6\u00dfe oder Farbe einer Warehouse-Variante?", "Wie bearbeite ich eine Warehousing-Variante?" ] }, "delete": { "tags": [ "Warehousing-API" ], "summary": "Delete WarehouseProductVariant", "description": "Deletes WarehouseProductVariant", "parameters": [ { "name": "product_reference", "in": "query", "description": "Reference of the WarehouseProduct to which the deleted Variant belongs to", "type": "string" }, { "name": "reference", "in": "query", "description": "Reference of the Variant to be deleted", "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseProductVariant" } }, "404": { "description": "WarehouseProductVariant not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "L\u00f6scht eine Variante eines Warehousing-Produkts.", "x-questions-de": [ "Wie l\u00f6sche ich eine Variante eines Lagerprodukts?", "Wie entferne ich eine Warehouse-Variante?", "Kann ich eine Warehousing-Variante per API l\u00f6schen?" ] } }, "/warehousing/variants/{reference}": { "put": { "tags": [ "Warehousing-API" ], "summary": "Update WarehouseProductVariant by Reference", "description": "Updates WarehouseProductVariant", "parameters": [ { "name": "reference", "in": "path", "description": "Reference of the Variant to be updated", "required": true, "type": "string", "x-example": "WV-HGE123446" }, { "name": "body", "in": "body", "schema": { "properties": { "name": { "description": "Project name", "type": "string", "example": "My cool warehouse product variant" }, "description": { "description": "Project description", "type": "string", "example": "My cool warehouse product variant's description" }, "size": { "description": "Size of the product's variant", "type": "string", "example": "S" }, "color": { "description": "Color of the product's variant", "type": "string", "example": "white" }, "hs_code": { "description": "HS Code of product's variant", "type": "string", "example": "DE123456" }, "country_of_origin": { "description": "Country of Origin of product's variant", "type": "string", "example": "DE" }, "item_value": { "description": "Item value in cents of product's variant", "type": "integer", "example": "52000" }, "net_sales_price": { "description": "Net sales price in cents of product's variant", "type": "integer", "example": "1250" }, "depth_cm": { "description": "Depth in cm of product's variant", "type": "integer", "example": "30" }, "width_cm": { "description": "Width in cm of product's variant", "type": "integer", "example": "30" }, "height_cm": { "description": "Height in cm of product's variant", "type": "integer", "example": "30" }, "weight_gram": { "description": "Weight in grams of product's variant", "type": "integer", "example": "30" }, "needs_box_shipping": { "description": "Indicates whether the product's variant should be shipping in a box", "type": "boolean", "example": "false" }, "min_stock_quantity": { "description": "Minimal stock quantity of product's variant", "type": "integer", "example": "100" }, "image": { "description": "WarehouseProduct variant image", "type": "object", "$ref": "#/definitions/Media" } }, "type": "object" } } ], "responses": { "200": { "description": "Success", "schema": { "type": "object", "$ref": "#/definitions/WarehouseProductVariant" } }, "404": { "description": "WarehouseProductVariant not found" } }, "security": [ { "cockpit_apikey": [] }, { "cockpit_oauth": [ "read-user" ] } ], "x-summary-de": "\u00c4ndert eine Warehousing-Variante direkt \u00fcber ihre Referenz.", "x-questions-de": [ "Wie \u00e4ndere ich eine Warehouse-Variante \u00fcber ihre Referenz?", "Wie aktualisiere ich eine Lagervariante per API?", "Wie bearbeite ich eine Variante ohne Produktreferenz?" ] } }, "/oauth/authorize": { "get": { "tags": [ "oauth" ], "summary": "Obtain authorization from user", "description": "As part of the OAuth2 authorization-code flow, users have to be directed to this endpoint, with the query parameters filled in. If applicable, the user will then be prompted to log into their account and confirm that their data may be used by a third party client. For security reasons, the redirect URL has to be registered beforehand, the client ID and client secrets are also issued during registration.", "parameters": [ { "name": "response_type", "in": "query", "description": "Response type", "required": true, "type": "string", "enum": [ "code" ] }, { "name": "redirect_url", "in": "query", "description": "Redirect URL. Must match registered redirect URL.", "required": true, "type": "string" }, { "name": "client_id", "in": "query", "description": "Client ID (from registration)", "required": true, "type": "string" }, { "name": "client_secret", "in": "query", "description": "Client Secret (from registration)", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success, body contains prompt for confirmation." }, "302": { "description": "Success, authorization has been previously granted, redirect to callback." }, "401": { "description": "Error, invalid client (client ID and/or secret is invalid)." } }, "x-summary-de": "Erster Schritt des OAuth2-Ablaufs: Der Nutzer wird hierher geleitet, um einer App den Zugriff zu erlauben.", "x-questions-de": [ "Wie funktioniert die OAuth-Anmeldung f\u00fcr meine App?", "Wie bekomme ich die Zustimmung eines Nutzers per OAuth2?", "Wie verbinde ich meine Anwendung per OAuth mit dem Cockpit?" ] } }, "/oauth/token": { "post": { "tags": [ "oauth" ], "summary": "Request access token", "description": "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.", "parameters": [ { "name": "grant_type", "in": "formData", "description": "Grant type", "required": true, "type": "string", "enum": [ "authorization_code" ] }, { "name": "code", "in": "formData", "description": "Code received in callback from /oauth/authorize", "required": true, "type": "string" }, { "name": "client_id", "in": "formData", "description": "Client ID (from registration)", "required": true, "type": "string" }, { "name": "client_secret", "in": "formData", "description": "Client Secret (from registration)", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success, token issued.", "schema": { "properties": { "access_token": { "description": "Valid access token.", "type": "string", "example": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjVjZj..." }, "refresh_token": { "description": "Refresh token, can be used to obtain a new access token after expiration.", "type": "string", "example": "tYI1iHjH7lGBLlBi+VD6uYYCn3pZo8Do/BSmcgzwTOuZ+f7v/z..." }, "expires_in": { "description": "Remaining lifetime of the access token (in seconds).", "type": "integer", "example": 31536000 }, "token_type": { "description": "Token type, will be 'Bearer'.", "type": "string", "example": "Bearer" } }, "type": "object" } }, "400": { "description": "Error.", "schema": { "$ref": "#/definitions/OAuthServerException" } }, "401": { "description": "Error, invalid client (client ID or secret are wrong).", "schema": { "$ref": "#/definitions/OAuthServerException" } } }, "x-summary-de": "Zweiter Schritt des OAuth2-Ablaufs: tauscht den Autorisierungscode gegen ein Access-Token.", "x-questions-de": [ "Wie bekomme ich ein OAuth Access-Token?", "Wie tausche ich den Authorization Code gegen ein Token?", "Wie erneuere ich ein abgelaufenes OAuth-Token?" ] } } }, "definitions": { "ProductStock": { "allOf": [ { "properties": { "base_product_sku": { "description": "SKU of the base product variant, null for warehouse products", "type": "string", "example": "SK-1234-M" } } }, { "$ref": "#/definitions/Stock" } ] }, "UserWebhook": { "properties": { "id": { "type": "integer", "example": 1 }, "url": { "type": "string", "example": "https://example.com/webhook" }, "is_active": { "type": "boolean", "example": true }, "secret": { "type": "string", "example": "webhookSecret123" }, "signature_header": { "description": "Name of the request header that carries the signature, `signature` by default", "type": "string", "example": "signature" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "ApiError": { "properties": { "message": { "type": "string", "example": "Error message description" }, "errors": { "type": "object", "example": { "field": [ "The field is invalid" ] } }, "status_code": { "type": "integer", "example": 400 } }, "type": "object" }, "Payment": { "properties": { "id": { "description": "Unique transaction identifier", "type": "string", "example": "d1364568-4b15-4706-89f1-2452efe1261d" }, "status": { "description": "Payment type", "type": "string", "example": "invoice" }, "status_title": { "description": "Payment description", "type": "string", "example": "Erstattung" }, "payment_reference": { "description": "Payment reference", "type": "string", "example": "Kreditkarte" }, "order": { "description": "Order", "$ref": "#/definitions/Order" }, "net_amount": { "description": "Net price", "$ref": "#/definitions/Money" }, "gross_amount": { "description": "Gross price", "$ref": "#/definitions/Money" }, "vat_amount": { "description": "VAT amount", "type": "integer", "$ref": "#/definitions/Money" }, "vat_rate": { "description": "VAT rate in percent", "type": "float", "example": 19 }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "CampaignIntegrationProduct": { "properties": { "integration_id": { "description": "The cockpit internal id of the used user integration", "type": "integer", "example": 111 }, "integration_product_id": { "description": "The identifier used by the integration application", "type": "string", "example": "9286211826" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "ProjectPrint": { "properties": { "area": { "description": "Processing site", "type": "string", "example": "front" }, "position": { "description": "Processing position", "type": "string", "example": "center" }, "method": { "description": "Processing method", "type": "string", "example": "print" }, "height": { "description": "Design height in millimeters", "type": "integer", "example": 300 }, "width": { "description": "Design width in millimeters", "type": "integer", "example": 200 }, "offset_top": { "description": "Vertical offset from top in millimeters", "type": "integer", "example": 50 }, "offset_center": { "description": "Horizontal offset from center in millimeters", "type": "integer", "example": 0 }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" }, "design": { "$ref": "#/definitions/Design" } }, "type": "object" }, "CampaignProductColor": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 123 }, "color": { "description": "Color name", "type": "string", "example": "Black" }, "color_hex": { "description": "Hexadecimal RGB color value", "type": "string", "example": "#000000" }, "is_colored": { "description": "Is this a non trivial (b/w) color?", "type": "boolean", "example": true }, "sales_price": { "description": "The price ypu specifiet for the product", "$ref": "#/definitions/Money" }, "sort_position": { "description": "Numerical index used for sorting", "type": "integer", "example": 1 }, "sizes": { "description": "Available sizes", "type": "array", "items": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 67 }, "size": { "description": "Size abbreviation", "type": "string", "example": "XL" }, "is_onlocalstock": { "description": "Is the item available on local stock?", "type": "boolean", "example": true }, "is_available": { "description": "Is item available in general, e.g. from supplier stock?", "type": "boolean", "example": true }, "sort_position": { "description": "Numerical index used for sorting", "type": "integer", "example": 1 }, "shirtigo_price": { "description": "Your price for the product", "$ref": "#/definitions/Money" } }, "type": "object" } } }, "type": "object" }, "CampaignProductIntegrationSync": { "properties": { "integration_name": { "description": "Name of the integration application", "type": "string", "example": "shopify" }, "integration_id": { "description": "The cockpit internal id of the used user integration", "type": "integer", "example": 111 }, "integration_product_id": { "description": "The identifier used by the integration application", "type": "string", "example": "9286211826" }, "is_syncing": { "description": "Is the product available?", "type": "boolean", "example": true }, "is_successful": { "description": "Has the product been rendered?", "type": "boolean", "example": true }, "in_queue": { "description": "Is the current sync-process still in queue?", "type": "boolean", "example": true }, "error": { "description": "Error message", "type": "string", "example": "Invalid or missing auth." }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "CampaignProduct": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 123 }, "project": { "description": "Project reference", "type": "string", "example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, "project_name": { "description": "Project name", "type": "string", "example": "Projekt 123" }, "name": { "description": "Product name", "type": "string", "example": "Base Product Name XY" }, "custom_name": { "description": "User defined product name", "type": "string", "example": "My cool product" }, "description": { "description": "Short description in HTML format", "type": "string" }, "tags": { "description": "List of tags for this design", "type": "array", "items": { "type": "string" } }, "price": { "description": "Net price", "$ref": "#/definitions/Money" }, "shirtigo_price": { "description": "Your purchase price for the first color/size variant", "$ref": "#/definitions/Money" }, "seedshirt_price": { "description": "Your purchase price for the product when selling the product via a seedshirt instant store", "$ref": "#/definitions/Money" }, "sort_position": { "description": "Numerical identifier", "type": "integer", "example": 0 }, "colors": { "description": "List of available colors", "type": "array", "items": { "$ref": "#/definitions/CampaignProductColor" } }, "is_available": { "description": "Is the product available?", "type": "boolean", "example": true }, "is_rendered": { "description": "Has the product been rendered?", "type": "boolean", "example": true }, "has_express": { "description": "Is the product available for express processing?", "type": "boolean", "example": false }, "images": { "description": "Product images", "type": "array", "items": { "$ref": "#/definitions/UtilProductImage" } }, "brandings": { "description": "Product branding options", "type": "array", "items": { "$ref": "#/definitions/UserPackin" } }, "base_product": { "description": "Base product", "$ref": "#/definitions/Product" }, "active_integration_syncs": { "description": "List of currently active synchronizations with integrations", "type": "array", "items": { "$ref": "#/definitions/CampaignProductIntegrationSync" } }, "integration_sync_log": { "description": "History of synchronizations with integrations for this product", "type": "array", "items": { "$ref": "#/definitions/CampaignProductIntegrationSync" } }, "integration_products": { "description": "List of integration products (e.g. products in shopify) for this products", "type": "array", "items": { "$ref": "#/definitions/CampaignIntegrationProduct" } }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "UtilProductImage": { "properties": { "id": { "description": "id of the image object", "type": "integer", "example": "1222" }, "color": { "description": "Color name", "type": "string", "example": "Red" }, "area": { "description": "Processing area name", "type": "string", "example": "front" }, "urls": { "description": "Product name", "properties": { "small": { "description": "URL for small preview image.", "type": "string", "example": "http://www.example.com/my-orders/small.png" }, "large": { "description": "URL for large preview image.", "type": "string", "example": "http://www.example.com/my-orders/large.png" } }, "type": "object" } }, "type": "object" }, "Project": { "required": [ "reference", "name", "type" ], "properties": { "reference": { "description": "Unique identifier of this project", "type": "string", "example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, "name": { "description": "Project name", "type": "string", "example": "My cool project" }, "type": { "description": "Type", "type": "string", "example": "ondemand" }, "products_count": { "description": "Number of products", "type": "integer", "readOnly": true, "example": 3 }, "is_published": { "description": "Has the project been published?", "type": "boolean", "readOnly": true, "example": true }, "is_syncing": { "description": "Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently syncing.", "type": "array", "items": { "type": "array", "items": { "type": "boolean" }, "example": { "12": true } }, "readOnly": true }, "is_queueing": { "description": "Array with a list of all CampaignProductIntegrationSyncs of this campaign and its status, if it is currently in queue.", "type": "array", "items": { "type": "array", "items": { "type": "boolean" }, "example": { "12": true } }, "readOnly": true }, "status": { "description": "Project status", "type": "string", "example": "Finalisiert" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" }, "created_at": { "description": "Timestamp of initial creation", "type": "string", "example": "2017-01-01 12:34:56" }, "processings": { "description": "Processings associated with this project", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProjectPrint" } } }, "type": "object" } }, "type": "object" }, "ProjectWithProducts": { "allOf": [ { "$ref": "#/definitions/Project" }, { "properties": { "products": { "description": "Products associated with this Project", "type": "array", "items": { "$ref": "#/definitions/Product" } } } } ] }, "Coupon": { "properties": { "coupon_code": { "description": "The identifier on the promo coupon", "type": "string", "example": "Shirt-coupon-XYZ" }, "coupon_type": { "description": "The type of the coupon (discount, free shipping, etc.)", "type": "string", "example": "discount" }, "discount_type": { "description": "The type of discount, either percentage or euro", "type": "string", "example": "euro" }, "discount_percent": { "description": "The granted discount in percent on the cart value without handling and shipping (filled for discount type percentage)", "type": "integer", "example": 10 }, "discount_netto": { "description": "The granted discount without sales taxes in euro cent (filled for discount type euro)", "$ref": "#/definitions/Money" }, "discount_brutto": { "description": "The gross granted discount in euro cent (filled for discount type euro)", "type": "integer", "$ref": "#/definitions/Money" }, "is_active": { "description": "Activation status of coupon", "type": "boolean", "example": true }, "min_order_value": { "description": "Minimal total value in euro cents for an order to make this coupon applicable", "$ref": "#/definitions/Money" }, "is_expired": { "description": "Flag to indicate if the coupon is expired", "type": "boolean", "example": false }, "expiration_date": { "description": "Timestamp for the validity of the coupon code", "type": "string", "example": "2017-01-01 12:34:56" }, "n_activations": { "description": "Number of usages for this coupon", "type": "integer", "example": "1" }, "remaining_activations": { "description": "Number of remaining usages for this coupon", "type": "integer", "example": "1" }, "new_user_only": { "description": "Flag to indicate if the coupon is for new users only", "type": "integer", "example": "1" }, "rate_limit_exceeded": { "description": "Flag to indicate if the coupon was used too often in the last hour.", "type": "integer", "example": "1" }, "has_orders": { "description": "Flag to indicate if orders for user exist.", "type": "integer", "example": "1" } }, "type": "object" }, "Country": { "properties": { "iso": { "description": "Two-letter identifier according to ISO 3166-1", "type": "string", "example": "DE" }, "name": { "description": "Country name", "type": "string", "example": "Germany" } }, "type": "object" }, "Design": { "properties": { "reference": { "description": "Unique identifier of this design", "type": "string", "example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, "filename": { "description": "Design file name", "type": "string", "example": "ABCDE" }, "name": { "description": "Design Name", "type": "string", "example": "My cool design" }, "width": { "description": "Width of the design file in pixels", "type": "integer", "example": 5000 }, "height": { "description": "Height of the design file in pixels", "type": "integer", "example": 3000 }, "filetype": { "description": "Extension of the design file name", "type": "string", "example": "png" }, "tags": { "description": "List of tags for this design", "type": "array", "items": { "type": "string" }, "example": "summer-collection" }, "processingmethod_key": { "description": "Indicates for which processingmethod the design can be used", "type": "string", "example": "dtg" }, "colors": { "description": "Total number of colors in the color palette", "type": "integer", "example": 5 }, "palette": { "description": "List of hex-codes of representative colors", "type": "array", "items": { "type": "string" }, "example": [ "A20061", "FFBC42", "1C838A", "021618", "A3AAAB" ] }, "complementary_color": { "description": "Complementary color", "type": "string", "example": "" }, "preview": { "description": "URL to preview image", "type": "string", "example": "https://example.com/product_prev.png" }, "original_file": { "description": "URL to full resolution image", "type": "string", "example": "https://example.com/product.png" }, "is_processed": { "description": "Has the design been rendered?", "type": "boolean", "example": true }, "is_dark": { "description": "Is this a design with dark colors?", "type": "boolean", "example": true }, "is_editable": { "description": "Indicates if design colors can be updated", "type": "boolean", "example": true }, "is_ai_generated": { "description": "Indicated if design has been generated by AI", "type": "boolean", "example": true }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "FulfillmentMode": { "properties": { "key": { "description": "A unique key to identify a fulfillment mode", "type": "string", "example": "24h-express" }, "name": { "description": "The name of the fulfillment mode", "type": "string", "example": "24h Express" }, "description": { "description": "A description of the fulfillment conditions for this mode", "type": "string", "example": "The order is produced and handed to the carrier within 24h" }, "is_per_order": { "description": "Flag to indicate if the surcharge for this mode is per order or per item", "type": "boolean", "example": "true" }, "price_net": { "description": "The net price, either per order or per item, dependent in the is_per_order_setting", "type": "string", "$ref": "#/definitions/Money" }, "fulfillment_days": { "description": "The number of fulfillment days for this fulfillment mode", "type": "string", "example": "1" }, "sort_weight": { "description": "Country name", "type": "string", "example": "22" } }, "type": "object" }, "GeneratedMedia": { "required": [ "reference", "prompt", "user_prompt", "created_at" ], "properties": { "reference": { "type": "string" }, "prompt": { "type": "string" }, "user_prompt": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "variations": { "type": "array", "items": { "$ref": "#/definitions/GeneratedMediaVariation" } }, "mediaStyle": { "type": "object", "$ref": "#/definitions/MediaStyle" } } }, "GeneratedMediaVariation": { "required": [ "reference", "url", "resolution", "status", "response_prompt", "has_design" ], "properties": { "reference": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "resolution": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "processing", "done", "failed" ] }, "response_prompt": { "type": "string" }, "has_design": { "type": "boolean" }, "safety_system_fail": { "type": "boolean" } } }, "MediaStyle": { "required": [ "id", "name", "description", "key", "url" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "key": { "type": "string" }, "url": { "type": "string" } } }, "Media": { "properties": { "reference": { "description": "Reference", "type": "string", "example": "A12345" }, "url": { "description": "Media url", "type": "string", "example": "https://example.com/image.png" }, "filename": { "description": "The basename of the file", "type": "string", "example": "image.png" } } }, "RenderingTaskImage": { "required": [ "reference", "mockup_id", "base_product_id", "base_product_color_id", "base_product_variants", "mockup_url", "resolution", "extension", "status", "error_message" ], "properties": { "reference": { "description": "Unique identifier of the image", "type": "string" }, "mockup_id": { "description": "Identifier for the associated mockup", "type": "integer" }, "base_product_id": { "description": "Identifier for the base product", "type": "integer" }, "base_product_color_id": { "description": "Identifier for the color of the base product", "type": "integer" }, "base_product_variants": { "description": "Serialized array of variants for the base product", "type": "string" }, "mockup_url": { "description": "URL to the mockup image if available; null if not available. Please note that rendered mockups will be deleted after 24 hours.", "type": "string" }, "resolution": { "description": "Resolution of the generated image in pixels", "type": "integer" }, "extension": { "description": "File extension type of the generated image", "type": "string" }, "status": { "description": "Current status of the image, e.g., 'pending', 'done', 'failed'", "type": "string" }, "error_message": { "description": "Error message if the status is 'failed', otherwise null", "type": "string" } } }, "RenderingTask": { "required": [ "reference", "external_reference", "status", "created_at" ], "properties": { "reference": { "description": "Unique identifier of the task", "type": "string" }, "external_reference": { "description": "An external reference to link back to client-side identifiers", "type": "string" }, "status": { "description": "Overall status of the task, derived from the status of its images. Can be 'pending', 'completed', or 'failed' based on the states of the images.", "type": "string" }, "created_at": { "description": "Timestamp of when the generated media was created", "type": "string", "format": "date-time" }, "RenderingTaskImage": { "description": "List of images associated with the task", "type": "array", "items": { "$ref": "#/definitions/GeneratedMediaVariation" } } } }, "NewsPost": { "required": [ "id", "name", "description", "key" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "key": { "type": "string" } } }, "OrderComment": { "properties": { "id": { "description": "ID of the order comment", "type": "integer" }, "comment": { "description": "Text of the order comment", "type": "string", "example": "Great communication with customer" }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "OrderPackin": { "properties": { "id": { "description": "Packin id", "type": "integer" }, "amount": { "description": "Number of items", "type": "integer", "example": 1 }, "name": { "description": "Packin name", "type": "string", "example": "Greeting card" }, "type": { "description": "Packin type (hangtag or packin)", "type": "string", "example": "hangtag" }, "net_total_price": { "description": "Total price (net_unit_price*amount)", "example": 75, "$ref": "#/definitions/Money" }, "net_unit_price": { "description": "Net unit price", "$ref": "#/definitions/Money" } }, "type": "object" }, "OrderPayment": { "properties": { "id": { "description": "Unique transaction identifier", "type": "string", "example": "d1364568-4b15-4706-89f1-2452efe1261d" }, "status": { "description": "Payment status", "type": "string", "example": "paid" }, "status_details": { "description": "Payment error description (if there is any)", "type": "string", "example": "An error occured." }, "type": { "description": "Payment type", "type": "string", "example": "creditcard" }, "net_amount": { "description": "Net price", "type": "integer", "$ref": "#/definitions/Money" }, "gross_amount": { "description": "Gross price", "type": "integer", "$ref": "#/definitions/Money" }, "vat_amount": { "description": "VAT amount", "type": "integer", "$ref": "#/definitions/Money" }, "vat_rate": { "description": "VAT rate in percent", "type": "float", "example": 19 }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "OrderProductItem": { "properties": { "reference": { "description": "Product reference", "type": "string", "example": "OP-12345678" }, "preview_image_url": { "description": "Preview image url", "type": "string", "example": "url" }, "status_name": { "description": "Item Status name", "type": "string", "example": "Print (DTG)" }, "status_key": { "description": "Color name", "type": "string", "example": "dtg" }, "status_description": { "description": "Status description", "type": "string", "example": "Product is being printed." }, "status_group": { "description": "Status group", "type": "string", "example": "processing" }, "availability": { "description": "availability", "type": "string", "example": "stock" } }, "type": "object" }, "OrderProduct": { "properties": { "id": { "description": "Product id", "type": "integer" }, "amount": { "description": "Number of items", "type": "integer", "example": 1 }, "base_product_sku": { "description": "SKU of the base product variant", "type": "string", "example": "STTW172C7271X" }, "sku": { "description": "SKU of the customized product variant", "type": "string", "example": "STTW172C7271X" }, "name": { "description": "Product name", "type": "string", "example": "Base product XY" }, "color": { "description": "Color name", "type": "string", "example": "Black" }, "size": { "description": "Size name", "type": "string", "example": "XL" }, "images": { "description": "Available image URLs", "type": "array", "items": { "$ref": "#/definitions/UtilProductImage" } }, "net_total_price": { "description": "Total price (net_unit_price*amount)", "example": 1375, "$ref": "#/definitions/Money" }, "net_unit_price": { "description": "Net unit price", "$ref": "#/definitions/Money" }, "campaign_reference": { "description": "Reference of the campaign", "type": "string", "example": "F7S33M2" }, "campaign_name": { "description": "Name of the campaign", "type": "string", "example": "Example Project" }, "campaign_product_id": { "description": "ID of the campaign product", "type": "int", "example": "123" } }, "type": "object" }, "OrderRelation": { "properties": { "reference": { "description": "Unique identifier of this order", "type": "string", "example": "ABCDXY1" }, "net_price": { "description": "Total net price of this order", "$ref": "#/definitions/Money" }, "gross_price": { "description": "Total gross price of this order", "$ref": "#/definitions/Money" }, "vat_rate": { "description": "VAT rate in percent", "type": "float", "example": 19 }, "vat_amount": { "description": "VAT amount", "$ref": "#/definitions/Money" }, "status": { "description": "Human readable order status", "type": "string", "example": "Bestellung offen" }, "status_key": { "description": "Number of products", "type": "string", "example": "" }, "total_items": { "description": "Total number of items in the order", "type": "integer", "example": 5 }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "OrderShipping": { "properties": { "type": { "description": "Shipping type", "type": "string", "example": "delivery" }, "cost": { "description": "Shipping price", "type": "string", "$ref": "#/definitions/Money" }, "is_shipped": { "description": "Has the order been shipped yet?", "type": "boolean", "example": false }, "country_code": { "description": "Two letter country code", "type": "string", "example": "DE" }, "tracking_code": { "description": "Carrier tracking code", "type": "string" }, "tracking_url": { "description": "Carrier tracking URL", "type": "string" }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "OrderStatusEntry": { "properties": { "key": { "description": "Order status key", "type": "string" }, "status": { "description": "Human readable status", "type": "string" }, "description": { "description": "Verbose status description", "type": "integer" }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "Order": { "properties": { "reference": { "description": "Unique identifier of this order", "type": "string", "example": "ABCDXY1" }, "net_price": { "description": "Total net price of this order", "$ref": "#/definitions/Money" }, "gross_price": { "description": "Total gross price of this order", "$ref": "#/definitions/Money" }, "vat_rate": { "description": "VAT rate in percent", "type": "float", "example": 19 }, "vat_amount": { "description": "VAT amount", "$ref": "#/definitions/Money" }, "status": { "description": "Human readable order status", "type": "string", "example": "Bestellung offen" }, "status_key": { "description": "Number of products", "type": "string", "example": "" }, "invoice": { "description": "URL to download the invoice", "type": "string" }, "invoice_reference": { "description": "Invoice reference", "type": "string" }, "fulfillment": { "description": "Fulfillment details or `false` if no details are available", "properties": { "reference": {}, "status": {}, "type": {} }, "type": "object" }, "delivery": { "description": "Delivery address", "$ref": "#/definitions/OrderAddress" }, "sender": { "description": "Sender address", "$ref": "#/definitions/OrderAddress" }, "bill": { "description": "Billing address", "$ref": "#/definitions/OrderAddress" }, "gpsr-manufacturer": { "description": "Manufacturer's address for GPSR compliance", "$ref": "#/definitions/OrderAddress" }, "gpsr-representative": { "description": "Representative's address for GPSR compliance", "$ref": "#/definitions/OrderAddress" }, "total_items": { "description": "Total number of items in the order", "type": "integer", "example": 5 }, "add_delivery_receipt": { "description": "Indicates if delivery receipt is added to order", "type": "boolean", "example": true }, "delivery_receipt_logo_reference": { "description": "Media reference for the logo added to delivery_receipt", "type": "string", "example": "A456HJ" }, "delivery_receipt_note": { "description": "Custom note on delivery receipt", "type": "string", "example": "Use voucher XYZ and get a 10% discount for your next order" }, "use_custom_product_name": { "description": "Use custom product name on delivery receipt", "type": "boolean", "example": true }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" }, "products": { "description": "Array of products in this order", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/OrderProduct" } } }, "type": "object" }, "packins": { "description": "Array of packins and hangtags in this order", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/OrderPackin" } } }, "type": "object" }, "payments": { "description": "Array of payments associated with this order", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/OrderPayment" } } }, "type": "object" }, "orderStatusEntries": { "description": "Array of status messages associated with this order", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/OrderStatusEntry" } } }, "type": "object" }, "shipping": { "description": "Details on the shipping method, status and tracking (only present if order is being or has been shipped)", "$ref": "#/definitions/OrderShipping" }, "shippings": { "description": "Shipments with assigned line items (partial deliveries)", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/OrderShipping" } } }, "type": "object" }, "documents": { "description": "Document references for the order", "properties": { "delivery-receipt": { "properties": { "media_reference": { "type": "string", "example": "AABBCC" }, "external_reference": { "type": "string", "example": "123" } }, "type": "object" }, "merchant-invoice": { "properties": { "media_reference": { "type": "string", "example": "AABBCC" }, "external_reference": { "type": "string", "example": "123" } }, "type": "object" }, "return-label": { "properties": { "external_reference": { "type": "string", "example": "ABCDEFG" }, "carrier_key": { "type": "string", "example": "DHL" } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "OrderAddress": { "description": "Address", "properties": { "type": { "description": "address type (delivery, sender, bill, gpsr-manufacturer, gpsr-representative", "type": "string", "example": "delivery" }, "title": { "description": "(Academic) title", "type": "string", "example": "Dr." }, "company": { "description": "Company name", "type": "string", "example": "Shirtigo GmbH" }, "firstname": { "description": "First name", "type": "string", "example": "Max" }, "lastname": { "description": "Last name", "type": "string", "example": "Mustermann" }, "care_of": { "description": "Care of (c/o)", "type": "string", "example": "Gift for Mrs. Doe" }, "street": { "description": "Street and number", "type": "string", "example": "Musterstra\u00dfe 12" }, "postcode": { "description": "ZIP/area code", "type": "string", "example": "12345" }, "city": { "description": "City", "type": "string", "example": "K\u00f6ln" }, "country": { "description": "A country iso-code (ISO 3166-1 alpha2) as listed in the /delivery-countries endpoint", "type": "string", "example": "DE" }, "email": { "description": "Contact email", "type": "string", "example": "info@company.com" }, "validation_error": { "description": "Parsed DHL preflight validation errors (null when valid or not checked)", "type": "array", "items": { "properties": { "code": { "type": "string", "example": "FIELD_ERROR" }, "message": { "type": "string", "example": "Invalid postal code" }, "field": { "type": "string", "example": "consignee.postalCode" }, "severity": { "type": "string", "example": "error" } }, "type": "object" } } }, "type": "object" }, "OrderWarehouseProductItem": { "properties": { "reference": { "description": "Product Reference", "type": "string" }, "sku": { "description": "SKU of ordered warehouseProductVariant", "type": "string", "example": "WP-12345" } }, "type": "object" }, "OrderWarehouseProduct": { "properties": { "reference": { "description": "Product Reference", "type": "string" }, "amount": { "description": "Number of items", "type": "integer", "example": 1 }, "name": { "description": "Product name", "type": "string", "example": "Base product XY" }, "sku": { "description": "SKU of ordered warehouseProductVariant", "type": "string", "example": "WP-12345" }, "net_total_price": { "description": "Total price (net_unit_price*amount)", "example": 1375, "$ref": "#/definitions/Money" }, "net_unit_price": { "description": "Net unit price", "$ref": "#/definitions/Money" } }, "type": "object" }, "Plan": { "properties": { "key": { "description": "A unique key to identify a plan", "type": "string", "example": "warehousing" }, "name": { "description": "The name of the plan", "type": "string", "example": "Warehousing" }, "description": { "description": "The description of the plan", "type": "string", "example": "Warehousing" }, "type": { "description": "The type of the plan", "type": "string", "example": "warehousing" }, "invoice_period": { "description": "number of month in interval", "type": "integer", "example": "1" }, "invoice_interval": { "description": "runtime of plan", "type": "string", "example": "month" }, "price_net": { "description": "The net price for the plan and the given priode", "type": "integer", "$ref": "#/definitions/Money" }, "sort_weight": { "description": "sort weight of the plan", "type": "integer", "example": "1" } }, "type": "object" }, "ProcessingMethod": { "properties": { "key": { "type": "string", "example": "dtg" }, "name": { "type": "string", "example": "Kornit DTG" }, "description": { "type": "string", "example": "High-quality digital printing method" }, "type": { "type": "string", "example": "print" }, "sort_weight": { "type": "integer", "example": 1 } }, "type": "object" }, "ProductColor": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 123 }, "color": { "description": "Color name", "type": "string", "example": "Black" }, "color_hex": { "description": "Hexadecimal RGB color value", "type": "string", "example": "#000000" }, "color_hex_contrast": { "description": "Hexadecimal RGB value of the second color of two-tone colors, e.g. the collar of a ringer shirt, null for single colors", "type": "string", "example": "#FFFFFF" }, "is_colored": { "description": "Is this a non trivial (b/w) color?", "type": "boolean", "example": true }, "is_heathered": { "description": "Indicates if the fabric is heathered", "type": "boolean", "example": false }, "sizes": { "description": "Available sizes", "type": "array", "items": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 67 }, "size": { "description": "Size abbreviation", "type": "string", "example": "XL" }, "base_product_sku": { "description": "Our unique SKU for this base product variant. Recommended for use.", "type": "string", "example": "STTU169_Black_XXL" }, "brand_product_sku": { "description": "Brand-specific SKU for this base product variant. Can also be used as base_product_sku in POST /orders.", "type": "string", "example": "STTU169C0022X" }, "is_onlocalstock": { "description": "Is the item available on local stock?", "type": "boolean", "example": true }, "is_discontinued": { "description": "Indicates if the product is discontinued", "type": "boolean", "example": false }, "sort_position": { "description": "Numerical index used for sorting", "type": "integer", "example": 1 }, "weight_gram": { "description": "Weight in gram", "type": "integer", "example": 10 }, "stock": { "description": "Stock information for the product variant", "properties": { "local_stock": { "description": "Amount available in local stock", "type": "integer", "example": 100 }, "wholesale_stock": { "description": "Amount available in wholesale stock", "type": "integer", "example": 200 }, "wholesale_delivery_duration": { "description": "Estimated delivery duration from wholesaler in days", "type": "integer", "example": 7 }, "inbound_date": { "description": "Expected date when out-of-stock items will be replenished", "type": "string", "format": "date", "example": "2024-02-15" }, "replacement_stock": { "description": "Information about replacement stock if applicable", "type": "object" } }, "type": "object" }, "print_dimensions": { "description": "Print dimensions for the product", "type": "array", "items": { "properties": { "processingarea_id": { "description": "Numerical identifier for the print area", "type": "integer", "example": 1 }, "processingarea_name": { "description": "Name of the print area (e.g., 'front', 'back')", "type": "string" }, "width_in_mm": { "description": "Width of the print area in millimeters", "type": "integer", "example": 300 }, "height_in_mm": { "description": "Height of the print area in millimeters", "type": "integer", "example": 400 }, "distance_printarea_top_to_collar_mm": { "description": "Distance from the top of the processingarea to the collar in millimeters", "type": "integer", "example": 50 } }, "type": "object" } } }, "type": "object" } } }, "type": "object" }, "ProductDimensions": { "properties": { "size": { "description": "Product size name", "type": "string", "example": "XL" }, "width": { "description": "Width in mm", "type": "integer", "example": 200 }, "height": { "description": "Height in mm", "type": "integer", "example": 500 } }, "type": "object" }, "ProductManufacturer": { "properties": { "id": { "description": "Numerical identifier", "type": "integer", "example": 123 }, "name": { "description": "Manufacturer name", "type": "string", "example": "Musterfirma" } }, "type": "object" }, "ProductProcessingArea": { "properties": { "position_id": { "description": "Numerical identifier", "type": "integer", "example": 1 }, "position_name": { "description": "Name of the printarea", "type": "string", "example": "front" }, "is_printable": { "description": "Flag to indicate if this area is available for printing.", "type": "boolean", "example": true }, "width_in_mm": { "description": "Width of the printarea in millimeters", "type": "integer", "example": 100 }, "height_in_mm": { "description": "Height of the printarea in millimeters", "type": "integer", "example": 100 }, "width": { "description": "Width of the printarea in pixels", "type": "integer", "example": 2000 }, "height": { "description": "Height of the printarea in pixels", "type": "integer", "example": 2000 }, "processing_method": { "description": "The processing method for this area definition", "properties": { "data": { "$ref": "#/definitions/ProcessingMethod" } }, "type": "object" }, "offset_x_center_mm": { "description": "Offset in mm for the area in x compared to a centered position", "type": "integer", "example": 0 }, "offset_y_collar_mm": { "description": "Offset in mm between the collar and the top of the area", "type": "integer", "example": 20 }, "printable_area_margin_from_top": { "description": "Distance between top and processable area top", "type": "integer", "example": 0 } }, "type": "object" }, "ProductProcessingPosition": { "properties": { "name": { "description": "Name of the position (translated)", "type": "string", "example": "Chest Left" }, "key": { "description": "Unique key to identify the position", "type": "string", "example": "chest-left" }, "description": { "description": "Description of the position", "type": "string", "example": "A printarea placed on the left side of the chest" }, "rel_position_x": { "description": "Relative horizontal position within the processing area in percent, where 0 represents the center of the coordinate system.", "type": "int", "example": 0 }, "rel_position_y": { "description": "Relative vertical position within the processing area in percent", "type": "int", "example": 15 }, "width_in_mm": { "description": "Width of the position in millimeters", "type": "integer", "example": 100 }, "height_in_mm": { "description": "Height of the position in millimeters", "type": "integer", "example": 100 } }, "type": "object" }, "ProductImage": { "properties": { "id": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "integer", "example": 1 }, "url": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "string", "example": "https://example.com/images/product.jpg" }, "type": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "string", "example": "main" }, "sort_weight": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "integer", "example": 1 }, "created_at": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "string", "format": "date-time" }, "updated_at": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "string", "format": "date-time" } }, "type": "object" }, "ProductPrice": { "properties": { "amount": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "integer", "example": 2999 }, "currency": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "string", "example": "EUR" }, "formatted": { "description": "Product Transformer\n\nDefault Includes (automatically included in all responses):\n- manufacturer: Product manufacturer information\n- colors: Available product colors with sizes and stock information\n- processing_areas: Available areas for customization (front, back, sleeves, etc.)\n- dimensions: Product measurements for different sizes\n- mockups: Product mockup templates for design preview\n\nAvailable Optional Includes:\n- To include additional data, use the ?include parameter in the API request\n- Example: /api/products?include=colors.sizes,mockups.productMockupType\n\nNested Includes:\n- mockups.productMockupType: Include mockup type information with each mockup\n- colors.*: Additional color variant information", "type": "string", "example": "29,99 \u20ac" } }, "type": "object" }, "ProductMockup": { "properties": { "id": { "description": "Unique identifier of the mockup", "type": "integer", "example": 1 }, "name": { "description": "Name of the mockup", "type": "string", "example": "Front View" }, "is_creator_editable": { "description": "Indicates if this mockup can be edited in the creator", "type": "boolean", "example": true }, "processingarea_key": { "description": "Key of the processing area this mockup belongs to", "type": "string", "example": "front" }, "width_px": { "description": "Width of the processing area in pixels", "type": "integer", "example": 2400 }, "height_px": { "description": "Height of the processing area in pixels", "type": "integer", "example": 3200 }, "offset_x_center_px": { "description": "Horizontal offset from center in pixels", "type": "integer", "example": 1200 }, "offset_y_top_px": { "description": "Vertical offset from top in pixels", "type": "integer", "example": 800 }, "px_to_mm": { "description": "Conversion factor from pixels to millimeters", "type": "number", "format": "float", "example": 0.1 }, "is_default": { "description": "Indicates if this is the default mockup for this processing area", "type": "boolean", "example": true }, "thumbnail_url": { "description": "URL of the mockup thumbnail image", "type": "string", "example": "https://example.com/mockups/thumbnail.jpg" }, "image_url": { "description": "URL of the full mockup image", "type": "string", "example": "https://example.com/mockups/image.jpg" }, "cutout_mask_url": { "description": "URL of the cutout mask image (nullable)", "type": "string", "example": "https://example.com/mockups/mask.png" }, "svg_url": { "description": "URL of the SVG template (nullable)", "type": "string", "example": "https://example.com/mockups/template.svg" }, "is_legacy": { "description": "Indicates if this mockup uses legacy rendering method", "type": "boolean", "example": false }, "mockup_group_id": { "description": "ID of the mockup group this mockup belongs to (nullable)", "type": "integer", "example": 5 }, "productMockupType": { "description": "Mockup type information (included by default)", "type": "object" } }, "type": "object" }, "Product": { "properties": { "id": { "description": "Numeric identifier of this product", "type": "integer", "example": 1 }, "name": { "description": "Product name", "type": "string", "example": "Base product XY" }, "original_name": { "description": "brand product name", "type": "string", "example": "T-Shirt" }, "shipping_category": { "description": "Numeric identifier of the shipping category", "type": "integer", "example": 1 }, "category_id": { "description": "Numerical identifier of the product category", "type": "integer", "example": 5 }, "category": { "description": "Name of the product category", "type": "string", "example": "Unisex-Shirts" }, "short_description": { "description": "Brief description of the product", "type": "string" }, "description": { "description": "Detailed description of the product", "type": "string" }, "one_line_description": { "description": "One-line description of the product", "type": "string" }, "designer_note": { "description": "special notes for designing the product", "type": "string" }, "material": { "description": "Material composition of the product", "type": "string" }, "hs_code": { "description": "Harmonized System code for international shipping", "type": "string" }, "thumbnail_image": { "description": "URL of the product's thumbnail image", "type": "string" }, "sizechart_image": { "description": "URL of the product size chart image", "type": "string" }, "is_active": { "description": "Indicates whether the product is active and available for orders", "type": "boolean" }, "product_category_id": { "description": "Numeric identifier for the specific product category", "type": "integer" }, "can_use_hangtag": { "description": "Indicates whether the product can use a hangtag", "type": "boolean" }, "can_use_imprint": { "description": "Indicates whether the product can use an imprint", "type": "boolean" }, "can_use_sewing_label": { "description": "Indicates whether the product can use a sewing label", "type": "boolean" }, "can_be_warehoused": { "description": "Indicates whether the product can be warehoused", "type": "boolean" }, "is_organic": { "description": "Indicates whether the product is made of organic materials", "type": "boolean" }, "recommended_sales_price": { "description": "Recommended sales price for the product", "type": "object" }, "manufacturer": { "description": "Manufacturer information (included by default)", "$ref": "#/definitions/ProductManufacturer" }, "images": { "description": "Product images", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductImage" } } }, "type": "object" }, "colors": { "description": "Color information (included by default)", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductColor" } } }, "type": "object" }, "processing_areas": { "description": "Available processing areas for customization (included by default)", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductProcessingArea" } } }, "type": "object" }, "dimensions": { "description": "Product dimensions for different sizes (included by default)", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductDimensions" } } }, "type": "object" }, "mockups": { "description": "Product mockup templates for design preview (included by default)", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductMockup" } } }, "type": "object" }, "price": { "description": "Pricing information", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductPrice" } } }, "type": "object" }, "sales_price": { "description": "Pricing information on sales", "properties": { "data": { "description": "Returned Items", "type": "array", "items": { "$ref": "#/definitions/ProductPrice" } } }, "type": "object" } }, "type": "object" }, "ProvisionalProduct": { "properties": { "name": { "description": "Product name", "type": "string", "example": "Base product XY" }, "description": { "description": "Short description", "type": "string" }, "colors": { "description": "List of available colors", "type": "array", "items": { "$ref": "#/definitions/ProductColor" } }, "price": { "description": "Net price", "$ref": "#/definitions/Money" }, "base_product": { "description": "Base product", "$ref": "#/definitions/Product" } }, "type": "object" }, "ShipmentStatus": { "properties": { "key": { "description": "ShipmentStatus key", "type": "string", "example": "preparation" }, "status_group": { "description": "ShipmentStatus status group", "type": "string", "example": "PRE_TRANSIT" }, "name": { "description": "Name of the ShipmentStatus", "type": "string", "example": "Preparation" }, "description": { "description": "Description of the ShipmentStatus", "type": "string", "example": "The package is in preparation" } }, "type": "object" }, "Stock": { "properties": { "local_stock": { "description": "Stock in our own warehouse, available for immediate production. Null if no stock information is available.", "type": "integer", "example": 40 }, "wholesale_stock": { "description": "Stock available at the wholesaler. Null for warehouse products or if no stock information is available.", "type": "integer", "example": 1000 }, "wholesale_delivery_duration": { "description": "Additional delivery days if the item has to be ordered from the wholesaler. Null for warehouse products.", "type": "string", "example": "2-3" }, "inbound_date": { "description": "Expected date the item is available again, only set while the wholesaler is out of stock.", "type": "string", "format": "date", "example": "2026-10-20" } }, "type": "object" }, "UserBillingMethodReferenceAccount": { "properties": { "bank_owner": { "description": "Billing method reference", "type": "ABC123" }, "bank_iban": { "description": "The amount in cents used to auto recharge wallet", "type": "integer", "example": "10000" }, "bank_bic": { "description": "billing method type", "type": "string", "example": "stripe, prepayment, wallet" } }, "type": "object" }, "UserBillingMethod": { "properties": { "reference": { "description": "Billing method reference", "type": "ABC123" }, "recharge_amount": { "description": "The amount in cents used to auto recharge wallet", "type": "integer", "example": "10000" }, "gateway": { "description": "billing method type", "type": "string", "example": "stripe, prepayment, wallet" }, "last4": { "description": "last 4 digits of credit card", "type": "string", "example": "4242" }, "provider": { "description": "credit card provider", "type": "string", "example": "visa" }, "exp_month": { "description": "month credit card will expire", "type": "string", "example": "12" }, "exp_year": { "description": "year credit card will expire", "type": "string", "example": "2023" }, "is_active": { "description": "indicates if billing method is the primary billing method for the user account", "type": "boolean", "example": true } }, "type": "object" }, "UserCreditBalance": { "properties": { "credit_balance": { "description": "The credit balance of the user", "type": "integer", "example": 100 }, "image_generation": { "description": "Details about the user's daily image generation limit", "properties": { "daily_limit": { "type": "integer", "example": 10 }, "remaining": { "type": "integer", "example": 5 } }, "type": "object" }, "image_optimizations": { "description": "Details about the user's daily image optimization limit", "properties": { "daily_limit": { "type": "integer", "example": 10 }, "remaining": { "type": "integer", "example": 5 } }, "type": "object" } }, "type": "object" }, "UserInboundShippingItemStatus": { "properties": { "id": { "description": "Status Id", "type": "integer", "example": 8 }, "name": { "description": "Status name", "type": "string", "example": "Failed" }, "description": { "description": "Status description", "type": "string", "example": "Failed" }, "key": { "description": "Status key", "type": "string", "example": "failed" }, "group": { "description": "Status group", "type": "string", "example": "done" } }, "type": "object" }, "RejectionType": { "properties": { "id": { "type": "integer", "example": 1 }, "name": { "type": "string", "example": "Wrong Size" }, "description": { "type": "string", "example": "The item size does not match the specification" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserInboundShippingItem": { "properties": { "reference": { "description": "Inbound shipping item reference", "type": "string", "example": "FC0459" }, "amount": { "description": "Amount of the inbound shipping item", "type": "integer", "example": 10 }, "should_store": { "description": "Flag indicating if the item should be stored", "type": "boolean", "example": true }, "created_at": { "description": "Timestamp when the inbound shipping item was created", "type": "string", "example": "2023-03-25T12:34:56" }, "updated_at": { "description": "Timestamp when the inbound shipping item was last updated", "type": "string", "example": "2023-03-25T12:34:56" }, "warehouse_product_variant": { "description": "warehouse_product_variant", "$ref": "#/definitions/WarehouseProductVariant" }, "user_packin": { "description": "user_packin", "$ref": "#/definitions/UserPackin" }, "order_product_item": { "description": "order_product_item", "$ref": "#/definitions/OrderProductItem" }, "order_warehouse_product_item": { "description": "order_warehouse_product_item", "$ref": "#/definitions/OrderWarehouseProductItem" }, "rejection_type": { "description": "rejection_type", "$ref": "#/definitions/RejectionType" }, "status": { "description": "status", "$ref": "#/definitions/UserInboundShippingItemStatus" } }, "type": "object" }, "UserInboundShippingReason": { "properties": { "key": { "description": "Reason key", "type": "string", "example": "no-pickup" }, "group": { "description": "Reason group", "type": "string", "example": "shipping-issue" }, "name": { "description": "Localized name", "type": "string", "example": "Package not picked up" }, "description": { "description": "Localized description", "type": "string", "example": "The order was not collected by the customer." }, "user_action_required": { "description": "Indicates if user action is required", "type": "boolean", "example": true }, "item_check_required": { "description": "Indicates if item check is required", "type": "boolean", "example": false }, "max_open_days": { "description": "Maximum number of open days", "type": "integer", "example": 14 } }, "type": "object" }, "UserInboundShippingRejectionType": { "properties": { "id": { "description": "Rejection type Id", "type": "integer", "example": 1 }, "key": { "description": "Rejection type key", "type": "string", "example": "print-damaged" }, "name": { "description": "Rejection type name", "type": "string", "example": "print damaged" }, "description": { "description": "Rejection type description", "type": "string", "example": "The print on this product is damaged." } }, "type": "object" }, "UserInboundShippingSolution": { "required": [ "id", "key", "name", "description", "created_at", "updated_at" ], "properties": { "id": { "type": "integer", "format": "int64", "example": 1 }, "key": { "type": "string", "example": "ship-again" }, "name": { "type": "string", "example": "Ship again" }, "description": { "type": "string", "example": "The order is send to the customer again and the shipping costs are charged to you." }, "has_shipping_fee": { "type": "boolean", "example": true }, "can_use_solution": { "type": "boolean", "example": true }, "created_at": { "type": "string", "format": "date-time", "example": "2023-03-25T12:34:56.789Z" }, "updated_at": { "type": "string", "format": "date-time", "example": "2023-03-25T12:34:56.789Z" }, "reasons": { "description": "List of reasons", "type": "array", "items": { "$ref": "#/definitions/UserInboundShippingReason" } } } }, "UserInboundShippingStatus": { "properties": { "id": { "description": "User inbound shipping status id", "type": "integer", "example": "1" }, "name": { "description": "User inbound shipping statuss name", "type": "string", "example": "Return received" }, "key": { "description": "User inbound shipping status key", "type": "string", "example": "pending" }, "description": { "description": "User inbound shipping status description", "type": "string", "example": "Return received" } }, "type": "object" }, "UserInboundShipping": { "properties": { "reference": { "description": "Inbound shipping reference", "type": "string", "example": "ABC123" }, "name": { "description": "Inbound shipping name", "type": "string", "example": "Sample shipment" }, "carrier": { "description": "Carrier for the inbound shipping", "type": "string", "example": "DHL" }, "tracking_number": { "description": "Tracking number for the inbound shipping", "type": "string", "example": "1234567890" }, "url": { "description": "URL for the inbound shipping details PDF", "type": "string", "example": "https://example.com/inbound/shipment" }, "count": { "description": "Total number of items in the inbound shipping", "type": "integer", "example": 25 }, "created_at": { "description": "Timestamp when the inbound shipping was created", "type": "string", "example": "2023-03-25T12:34:56" }, "updated_at": { "description": "Timestamp when the inbound shipping was last updated", "type": "string", "example": "2023-03-25T12:34:56" }, "deleted_at": { "description": "Timestamp when the inbound shipping was deleted (null if not deleted)", "type": "string", "example": "2023-03-25T12:34:56" }, "shipmentStatus": { "description": "shipmentStatus", "$ref": "#/definitions/ShipmentStatus" }, "userInboundShippingStatus": { "description": "userInboundShippingStatus", "$ref": "#/definitions/UserInboundShippingStatus" }, "reason": { "description": "reason", "$ref": "#/definitions/UserInboundShippingReason" }, "solution": { "description": "solution", "$ref": "#/definitions/UserInboundShippingSolution" }, "items": { "description": "List of items", "type": "array", "items": { "$ref": "#/definitions/UserInboundShippingItem" } }, "order": { "description": "order", "$ref": "#/definitions/Order" }, "billingOrder": { "description": "billingOrder", "$ref": "#/definitions/Order" } }, "type": "object" }, "UserIntegration": { "properties": { "id": { "description": "The internal cockpit id of the used user integration", "type": "integer", "example": 111 }, "app": { "description": "Name of the integration application", "type": "string", "example": "shopify" }, "name": { "description": "The name of the integration, i.e. the shop URL", "type": "string", "example": "my-cool-shirtstore.myshopify.com" }, "reference": { "description": "Reference of the integration", "type": "uuid", "example": "154e3f69-c081-4e20-8706-d1c7477e15c8" }, "expires_in": { "description": "Date of expire", "type": "string", "example": "2018-01-01 12:34:56" }, "sales_channel": { "description": "Integration sales channel", "type": "string", "example": "Storefront" }, "image_type": { "description": "Type of image transfered to external shop", "type": "string", "example": "png" }, "image_quality": { "description": "Quality of image transfered to external shop", "type": "string", "example": "high" }, "fulfillment_mode_key": { "description": "The fulfillment mode used when orders are placed via this integration", "type": "string", "example": "24h-express" }, "is_token_revoked": { "description": "Flag if the access token has been revoked and needs to be updated", "type": "boolean", "example": true }, "is_pull_orders": { "description": "Flag if manually reimporting of orders is enabled.", "type": "boolean", "example": true }, "is_auto_pull_orders": { "description": "Flag if automatically reimporting of orders is enabled.", "type": "boolean", "example": "true" }, "default_first_packin_reference": { "description": "Default first packin added to orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_second_packin_reference": { "description": "Default second packin added to orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_hangtag_reference": { "description": "Default hangtag added to all textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_imprint_reference": { "description": "Default imprinted added to all tagless textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_label_reference": { "description": "Default label added to all textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_product_packaging_reference": { "description": "Default packaging used for all textil products of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_order_packaging_reference": { "description": "Default packging used for all orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "default_sticker_reference": { "description": "Default sticker applied to packaging of orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "add_delivery_receipt": { "description": "Indicates if delivery receipt is added to orders received via this intergrations", "type": "boolean", "example": true }, "total_branding_count": { "description": "The count of non-null branding fields in the integration", "type": "boolean", "example": true }, "delivery_receipt_note": { "description": "Custom note on delivery receipt", "type": "string", "example": "Use voucher XYZ and get a 10% discount for your next order" }, "default_delivery_receipt_logo_reference": { "description": "Default delivery receipt logo used for orders received via this intergrations (optional)", "type": "string", "example": "ABC123" }, "delivery_receipt_logo": { "description": "Url to custom logo added to delivery slip for orders received via this intergrations (optional)", "type": "string", "example": "https://example.com/custom_logo.png" }, "use_custom_product_name": { "description": "Indicates if custom product name is used on delivery receipt", "type": "boolean", "example": true }, "sticker_logo": { "description": "Url to custom sticker logo for orders received via this intergrations (optional)", "type": "string", "example": "https://example.com/custom_logo.png" }, "is_auto_onhold": { "description": "Indicates if order is automatically pushed to production (default = false)", "type": "boolean", "example": true }, "is_refresh_token_expired": { "description": "Indicates if the (OAuth-)refresh-token is expired. Currently only used for ebay. (default = false)", "type": "boolean", "example": false } }, "type": "object" }, "UserPackin": { "properties": { "reference": { "description": "Packin reference", "type": "ABC123" }, "name": { "description": "Packin name", "type": "string", "example": "Greetings card" }, "type": { "description": "Packin type (packin or hangtag)", "type": "string", "example": "packin" }, "position": { "description": "Position of Label", "type": "string", "example": "seam-left" }, "size_id": { "description": "Product size ID for which imprint will be applied", "type": "integer", "example": "3" }, "color_ids": { "description": "Array of product color ids for which imprint or label will be applied", "type": "string", "example": "['147','157']" }, "weight_gram": { "description": "Weight of one single packin in gram", "type": "integer", "example": "10" }, "width_mm": { "description": "Width of the packin in millimeter", "type": "integer", "example": "100" }, "height_mm": { "description": "Height of the packin in millimeter", "type": "integer", "example": "100" }, "initial_inventory": { "description": "Initial stock level of packin", "type": "integer", "example": "1000" }, "inventory": { "description": "Actual stock level of packin", "type": "integer", "example": "1000" }, "preview_path": { "description": "Path to packin preview", "type": "string", "example": "https://s3.amazon.com/preview.png" }, "is_active": { "description": "Packins receives status is_active, when article is checked and warehoused", "type": "boolean", "example": true }, "stocking_costs": { "description": "Daily costs for stocking packin", "example": 50, "$ref": "#/definitions/Money" }, "item_costs": { "description": "Costs for adding one packin to an order", "example": 75, "$ref": "#/definitions/Money" } }, "type": "object" }, "UserPayment": { "properties": { "reference": { "description": "payment reference", "type": "string", "example": "UPD7FF829231CB" }, "type": { "description": "payment type", "type": "string", "example": "paypal" }, "status": { "description": "payment status", "type": "string", "example": "paid" }, "amount": { "description": "payment amount", "type": "integer", "example": "10000" }, "billing_method_reference": { "description": "reference of the associated billing method", "type": "string", "example": "E60C9604" }, "is_auto_recharged": { "description": "indicates if payment was trigger by user or via auto-recharge", "type": "boolean", "example": "1" } }, "type": "object" }, "UserReturnPortal": { "properties": { "name": { "description": "The name of the return portal", "type": "string", "example": "Best Shirts" }, "reference": { "description": "reference of the return portal", "type": "string", "example": "" }, "subdomain": { "description": "subdomain of the return portal", "type": "string", "example": "bestshirts" }, "url": { "description": "url of the return portal", "type": "string", "example": "bestshirts.myreturns.online" }, "legal_imprint_url": { "description": "url to the shop imprint", "type": "string", "example": "https://www.bestshirts.xyz/imprint" }, "legal_privacy_url": { "description": "url to the privacy policy", "type": "string", "example": "https://www.bestshirts.xyz/privacy" }, "is_active": { "description": "indicates if return portal is active", "type": "boolean", "example": true }, "accept_complaints_only": { "description": "indicates if return portal accepts complaints only and no withdrawals", "type": "boolean", "example": true }, "accept_personalized_items": { "description": "indicates if customer can return personalized items", "type": "boolean", "example": true }, "allow_refund_for_personalized_items": { "description": "indicates if customer can select refund as solution of persoanlized items or just a exchange", "type": "boolean", "example": true }, "allow_exchange": { "description": "Indicates whether a product can be exchanged for another colour or size", "type": "boolean", "example": true }, "withdrawal_period_days": { "description": "Indicates how many days after shipment a product can be returned", "type": "integer", "example": 14 }, "complaint_period_days": { "description": "Indicates how many days after shipment a product can be complained", "type": "integer", "example": 60 }, "mobile_logo_url": { "description": "url of the logo of the mobile viewport", "type": "string", "example": "https://www.bestshirts.xyz/mobile_logo.png" }, "desktop_logo_url": { "description": "url of the logo of the desktop viewport", "type": "string", "example": "https://www.bestshirts.xyz/desktop_logo.png" }, "primary_color_hex": { "description": "hex code for the primary css color", "type": "string", "example": "000000" }, "secondary_color_hex": { "description": "hex code for the secondary css color", "type": "string", "example": "FF0000" } }, "type": "object" }, "UserShop": { "properties": { "id": { "description": "The internal cockpit id of the one-click-shop", "type": "integer", "example": 111 }, "app": { "description": "Name of the integration application", "type": "string", "example": "one-click-shop" }, "name": { "description": "The name of the one-click-shop", "type": "string", "example": "My One-Click-Shop" }, "url": { "description": "The unique url identifier of the one-click-shop", "type": "string", "example": "my-shop" }, "seedshirt_url": { "description": "The public url of the one-click-shop", "type": "string", "example": "www.seedshirt.de/shop/my-shop" }, "seedshirt_account_url": { "description": "The url of the one-click-shop admin interface", "type": "string", "example": "www.seedshirt.de/account/shops/my-shop" } }, "type": "object" }, "UserSubscription": { "properties": { "name": { "description": "The name of the plan", "type": "string", "example": "Warehousing" }, "valid_from": { "description": "The date from which is subscription is valid", "type": "string", "example": "2022-09-01 08:00:00" }, "valid_until": { "description": "The date until which the subscription is valid", "type": "string", "example": "2022-09-01 08:00:00" }, "is_canceled": { "description": "indicates if subscription was canceled", "type": "boolean", "example": "1" }, "is_renewed": { "description": "indicates if subscription was renewed", "type": "boolean", "example": "1" }, "is_valid": { "description": "indicates if subscription is still valid", "type": "boolean", "example": "1" } }, "type": "object" }, "UserGroup": { "properties": { "id": { "description": "Numerical group identifier", "type": "integer", "example": 1 }, "type": { "description": "Group name", "type": "string", "example": "premium" }, "cockpit_discount": { "description": "Discount in percent", "type": "integer", "example": 20 }, "quantity": { "description": "Required number of sold products", "type": "integer", "example": 1000 }, "created_at": { "description": "Timestamp of creation", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" } }, "type": "object" }, "User": { "required": [ "firstname", "lastname", "street", "postcode", "city", "country" ], "properties": { "email": { "description": "Email address", "type": "string", "example": "mustermann@example.com" }, "firstname": { "description": "First name(s)", "type": "string", "example": "Max" }, "lastname": { "description": "Last name", "type": "string", "example": "Mustermann" }, "display_name": { "description": "Display name, e.g. first + last name", "type": "string", "example": "Max Mustermann" }, "user_group": { "$ref": "#/definitions/UserGroup" }, "is_business": { "description": "Is a business customer", "type": "boolean", "example": true }, "title": { "description": "(Academical) title", "type": "string", "example": "Dr." }, "company_name": { "description": "Company name", "type": "string", "example": "Shirtigo GmbH" }, "street": { "description": "Street and number, used for billing", "type": "string", "example": "Musterstra\u00dfe 12" }, "postcode": { "description": "ZIP code, used for billing", "type": "string", "example": "12345" }, "city": { "description": "City, used for billing", "type": "string", "example": "K\u00f6ln" }, "country": { "description": "Country, used for billing", "type": "string", "example": "Deutschland" }, "phone": { "description": "Phone nubmer", "type": "string", "example": "004930123456" }, "sender_title": { "type": "string" }, "sender_company_name": { "type": "string" }, "sender_firstname": { "type": "string" }, "sender_lastname": { "type": "string" }, "sender_street": { "type": "string" }, "sender_postcode": { "type": "string" }, "sender_city": { "type": "string" }, "sender_state": { "type": "string" }, "sender_country": { "type": "string" }, "sender_type": { "type": "string", "enum": [ "full", "company", "legacy" ] }, "fulfillment_key": { "description": "The desired fulfillment mode", "type": "string", "example": "24h-express" }, "is_billing_valid": { "description": "Have billing options been filled out?", "type": "boolean", "example": true }, "has_orders": { "description": "Does user have orders?", "type": "boolean", "example": true }, "integration_count": { "description": "Number of active integrations", "type": "number", "example": 2 }, "is_auto_onhold": { "description": "Indicates if order is automatically pushed to production (default = false)", "type": "boolean", "example": true }, "integrations": { "description": "List of integrations (connected applications) for this user", "type": "array", "items": { "$ref": "#/definitions/UserIntegration" } }, "updated_at": { "description": "Timestamp of last update", "type": "string", "example": "2017-01-01 12:34:56" }, "add_delivery_receipt": { "description": "Indicates if delivery receipt is added to orders received via this intergrations", "type": "boolean", "example": true }, "delivery_receipt_note": { "description": "Custom note on delivery receipt", "type": "string", "example": "Use voucher XYZ and get a 10% discount for your next order" }, "default_delivery_receipt_logo_reference": { "description": "Default delivery receipt logo used for orders placed via dashboard", "type": "string", "example": "ABC123" }, "delivery_receipt_logo": { "description": "Url to custom logo added to delivery slip and shipping lable for orders placed via dashboard", "type": "string", "example": "https://example.com/custom_logo.png" }, "use_custom_product_name": { "description": "Indicates if custom product name is used on delivery receipt", "type": "boolean", "example": true }, "default_first_packin_reference": { "description": "Default first packin added to orders placed via dashboard (optional)", "type": "string", "example": "ABC123" }, "default_second_packin_reference": { "description": "Default second packin added to orders placed via dashboard (optional)", "type": "string", "example": "ABC123" }, "default_hangtag_reference": { "description": "Default hangtag added to all textil products of orders placed via dashboard (optional)", "type": "string", "example": "ABC123" }, "sticker_logo": { "description": "Url to custom sticker logo for orders placed via dashboard (optional)", "type": "string", "example": "https://example.com/custom_logo.png" } }, "type": "object" }, "Webhook": { "properties": { "id": { "description": "Unique identifier for the User Webhook", "type": "string", "example": "ABC123DEF5" }, "user_webhook_type_key": { "description": "Key for the associated User Webhook Type", "type": "string", "example": "Order.created" }, "url": { "description": "URL for the User Webhook", "type": "string", "example": "https://example.com/webhook" }, "secret": { "description": "Secret used to sign webhook calls. The raw JSON body is hashed with HMAC-SHA256 and transmitted as a lowercase hex string.", "type": "string", "example": "mysecretkey" }, "signature_header": { "description": "Name of the request header that carries the signature, `signature` by default", "type": "string", "example": "signature" }, "is_active": { "description": "Indicates if the User Webhook is active", "type": "boolean", "example": true }, "created_at": { "description": "Creation timestamp of the User Webhook", "type": "string", "example": "2023-01-01T00:00:00" }, "updated_at": { "description": "Update timestamp of the User Webhook", "type": "string", "example": "2023-01-02T00:00:00" } }, "type": "object" }, "WebhookType": { "properties": { "id": { "description": "Unique identifier for the webhook type", "type": "integer", "format": "int32" }, "key": { "description": "Key for the webhook type", "type": "string" }, "resource": { "description": "Resource for the webhook type", "type": "string", "example": "Order" }, "action": { "description": "Action for the webhook type", "type": "string", "example": "created" }, "max_tries": { "description": "Maximum number of tries for the webhook type", "type": "integer", "format": "int32", "example": "5" }, "name": { "description": "Name of the webhook type", "type": "string", "example": "Order created" }, "description": { "description": "Description of the webhook type", "type": "string", "example": "Triggered when a new Order was created." } }, "type": "object" }, "WarehouseInboundShipment": { "properties": { "id": { "description": "id", "type": "1" }, "reference": { "description": "Reference", "type": "string", "example": "A1234567" }, "name": { "description": "Name of the Warehouse inbound shipment", "type": "string", "example": "Warehouse inbound shipment" }, "carrier": { "description": "Carrier's name", "type": "string", "example": "DHL" }, "tracking_number": { "description": "Shipment tracking number", "type": "string", "example": "AA123345567BB" }, "url": { "description": "Inbound shipment URL", "type": "string", "example": "https://dhl.com/tracking" }, "count": { "description": "Count of the items in the shipment", "type": "string", "example": 5 }, "created_at": { "description": "Timestamp when the record was created", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp when the record was updated", "type": "string", "example": "2017-01-01 12:34:56" }, "deleted_at": { "description": "Timestamp when the record was deleted", "type": "string", "example": "2017-01-01 12:34:56" } } }, "WarehouseProduct": { "properties": { "id": { "description": "id", "type": "1" }, "reference": { "description": "Reference", "type": "string", "example": "A12345" }, "name": { "description": "Name of the Warehouse product", "type": "string", "example": "Warehouse product name" }, "description": { "description": "Description of the Warehouse product", "type": "string", "example": "Warehouse product description" }, "hs_code": { "description": "HS code of the item", "type": "string", "example": "A123123" }, "country_of_origin": { "description": "The name the country of origin", "type": "string", "example": "DE" }, "color_id": { "description": "ID of the color of the item", "type": "string", "example": "1" }, "item_value": { "description": "Value of the item", "type": "integer", "example": 300 }, "net_sales_price": { "description": "Net sales price of the item", "type": "integer", "example": 25 }, "width_cm": { "description": "Width of the item in cm", "type": "integer", "example": 20 }, "height_cm": { "description": "Height of the item in cm", "type": "integer", "example": 20 }, "depth_cm": { "description": "Depth of the item in cm", "type": "integer", "example": 30 }, "weight_gram": { "description": "Weight of the item in gramm", "type": "integer", "example": 500 }, "needs_box_shipping": { "description": "Boolean if the item needs extra package for shipping", "type": "boolean", "example": true }, "min_stock_quantity": { "description": "Minimum stock quantity of the item", "type": "integer", "example": 100 }, "created_at": { "description": "Timestamp when the record was created", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp when the record was updated", "type": "string", "example": "2017-01-01 12:34:56" }, "deleted_at": { "description": "Timestamp when the record was deleted", "type": "string", "example": "2017-01-01 12:34:56" } } }, "WarehouseProductVariant": { "properties": { "id": { "description": "id", "type": "1" }, "reference": { "description": "Reference", "type": "string", "example": "A12345" }, "product_reference": { "description": "Warehouse Product reference", "type": "string", "example": "A12345" }, "name": { "description": "Name of the Warehouse product variant", "type": "string", "example": "Warehouse product variant name" }, "description": { "description": "Description of the Warehouse product variant", "type": "string", "example": "Warehouse product variant description" }, "color_id": { "description": "ID of the color of the item", "type": "string", "example": "1" }, "size_id": { "description": "ID of the size of the item", "type": "string", "example": "1" }, "color": { "description": "Name of the color of the item", "type": "string", "example": "Red" }, "size": { "description": "Name of the size of the item", "type": "string", "example": "XL" }, "width_cm": { "description": "Width of the item in cm", "type": "integer", "example": 20 }, "height_cm": { "description": "Height of the item in cm", "type": "integer", "example": 20 }, "depth_cm": { "description": "Depth of the item in cm", "type": "integer", "example": 30 }, "weight_gram": { "description": "Weight of the item in gramm", "type": "integer", "example": 500 }, "item_value": { "description": "Value of the item", "type": "integer", "example": 300 }, "net_sales_price": { "description": "Net sales price of the item", "type": "integer", "example": 25 }, "shirtigo_price": { "description": "Shirtigo sales price of the item", "type": "integer", "example": 20 }, "min_stock_quantity": { "description": "Minimum stock quantity of the item", "type": "integer", "example": 100 }, "needs_box_shipping": { "description": "Boolean if the item needs extra package for shipping", "type": "boolean", "example": true }, "country_of_origin": { "description": "The name the country of origin", "type": "string", "example": "DE" }, "hs_code": { "description": "HS code of the item", "type": "string", "example": "A123123" }, "created_at": { "description": "Timestamp when the record was created", "type": "string", "example": "2017-01-01 12:34:56" }, "updated_at": { "description": "Timestamp when the record was updated", "type": "string", "example": "2017-01-01 12:34:56" }, "deleted_at": { "description": "Timestamp when the record was deleted", "type": "string", "example": "2017-01-01 12:34:56" }, "is_stored": { "description": "Boolean if the item is stored", "type": "boolean", "example": true }, "is_approved": { "description": "Boolean if the item is approved", "type": "boolean", "example": true }, "is_rejected": { "description": "Boolean if the item is rejected to store", "type": "boolean", "example": "false" }, "stock_amount": { "description": "Current stock amount of the item", "type": "integer", "example": 100 } } }, "Money": { "properties": { "amount": { "description": "Price in cents", "type": "integer", "example": 999 }, "currency_symbol": { "description": "Currency symbol", "type": "string", "example": "\u20ac" }, "currency_code": { "description": "Three letter ISO 4217 code", "type": "string", "example": "EUR" }, "currency_factor": { "description": "Number of cents in one unit of currency", "type": "integer", "example": 100 } }, "type": "object" }, "MoneyVatInclude": { "properties": { "vat_rate": { "description": "Value added tax (VAT) rate in percent as an integer", "type": "float", "example": 19 } } }, "MoneyWithVat": { "type": "object", "allOf": [ { "$ref": "#/definitions/Money" }, { "$ref": "#/definitions/MoneyVatInclude" } ] }, "OAuthServerException": { "required": [ "error", "message" ], "properties": { "error": { "description": "Machine readable error type.", "type": "string" }, "message": { "description": "Human readable error message.", "type": "string" }, "hint": { "description": "A helper hint.", "type": "string" } }, "type": "object" }, "Pagination": { "description": "Pagination information", "properties": { "total": { "description": "Total number of items", "type": "integer", "example": 32 }, "count": { "description": "Number of items on current page", "type": "integer", "example": 10 }, "per_page": { "description": "Default number of items per page", "type": "integer", "example": 10 }, "current_page": { "description": "Index of current page", "type": "integer", "example": 2 }, "total_pages": { "description": "Total number of pages", "type": "integer", "example": 4 }, "links": { "description": "URLs of adjacent pages", "properties": { "previous": { "description": "URL of previous page", "type": "string" }, "next": { "description": "URL of next page", "type": "string" } } } }, "type": "object" } }, "parameters": { "base-product-id": { "name": "base-product-id", "in": "path", "description": "Numerical base product identifier", "required": true, "type": "integer", "x-example": 25 }, "project-reference": { "name": "project-reference", "in": "path", "description": "Unique project identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, "product-id": { "name": "product-id", "in": "path", "description": "Numerical product identifier", "required": true, "type": "integer", "x-example": 25 }, "UpdateProductColors": { "name": "UpdateProductColors", "in": "body", "schema": { "required": [ "processings" ], "properties": { "processings": { "description": "List of processings to add / update", "type": "array", "items": { "properties": { "processingarea_type": { "description": "Processing area type. Not required when only prices are adjusted", "type": "string", "example": "front" }, "processingposition": { "description": "Processing position", "type": "string", "default": "chest-center", "example": "chest-center" }, "processingmethod": { "description": "Processing method", "type": "string", "default": "dtg", "example": "dtg" }, "design_reference": { "description": "Design for the customization. This parameter if new colors are added and the referenceColor option is not used.", "type": "string", "example": "310ef229-2254-4f4f-9041-a8e02674ff36" }, "offset_top": { "description": "Vertical offset from top in millimeters. This parameter if new colors are added and the referenceColor option is not used.", "type": "integer", "default": 0, "example": 50 }, "offset_center": { "description": "Horizontal offset from center in millimeters. This parameter if new colors are added and the referenceColor option is not used.", "type": "integer", "default": 0, "example": 0 }, "width": { "description": "Design width in millimeters. This parameter if new colors are added and the referenceColor option is not used.", "type": "string", "example": 200 }, "is_customizable": { "description": "inidicated if order products can be customized after order was placed", "type": "boolean", "default": "false", "example": "false" }, "force_position": { "description": "true uses the offsets exactly as given for every size. false (default, recommended) adjusts the position per garment size automatically.", "type": "boolean", "default": false, "example": false }, "colors": { "description": "List of baseProduct colors which should be assigned to this processing", "type": "array", "items": { "properties": { "colorId": { "description": "Numeric identifier of baseProduct color", "type": "integer", "example": 608 }, "referenceColorId": { "description": "A reference color, where all processing info is taken from and used as the basis for the added colors.", "type": "integer", "example": 2195 }, "price": { "description": "Your sales price for this product color in cents", "type": "integer", "example": 2195 }, "sortPosition": { "description": "sort position for this color", "type": "integer", "example": 1 } } } } }, "type": "object" } } }, "type": "object" } }, "design-reference": { "name": "design-reference", "in": "path", "description": "Unique design identifier", "required": true, "type": "string", "x-example": "9e7aba40-3bce-4639-9caa-9a9a0397cbff" }, "integration_id": { "name": "integration_id", "in": "path", "description": "ID of the integration", "required": true, "type": "integer" }, "order_reference": { "name": "order_reference", "in": "path", "description": "The unique reference identifier of the order", "required": true, "type": "string" } }, "securityDefinitions": { "cockpit_apikey": { "type": "apiKey", "description": "This API supports access via an API key. A key can be obtained from the integrations dashboard. The key must be presented in the 'Authorization' header, e.g. 'Authorization: Bearer [key]'.", "name": "Authorization", "in": "header" }, "cockpit_oauth": { "type": "oauth2", "description": "This API supports OAuth2 with the authorization-code flow. A detailed tutorial on this topic can be found [here](https://www.digitalocean.com/community/tutorials/an-introduction-to-oauth-2). Note that the endpoint is `/oauth/`, not `/api/oauth/` as indicated here in the documentation.", "flow": "accessCode", "authorizationUrl": "/oauth/authorize", "tokenUrl": "/oauth/token", "scopes": { "read-user": "Read user information", "write-user": "Modify user information", "read-design": "Read existing designs", "write-design": "Create and modify designs", "read-project": "Read existing projects and products", "write-project": "Create and modify projects and products", "read-order": "Read past orders", "write-order": "Place new orders", "read-stats": "Read selling statistics" } } }, "tags": [ { "name": "oauth", "description": "This section contains endpoints related to the OAuth2 implementation.", "x-displayName": "Authorization" }, { "name": "Catalog-API", "description": "Endpoints in this section retrieve baseProducts available for creating customized products.", "x-displayName": "Catalog-API" }, { "name": "Order-API", "description": "Endpoints in this section retrieve information about issued orders.", "x-displayName": "Order-API" }, { "name": "Design-API", "description": "Endpoints in this section manipulate (create, view, modify) designs by the currently logged in user.", "x-displayName": "Design-API" }, { "name": "Project-API", "description": "Endpoints in this section manipulate (create, view, modify) projects of the currently logged in user.", "x-displayName": "Project-API" }, { "name": "Product-API", "description": "Endpoints in this section retrieve customized products available to the currently logged in user.", "x-displayName": "Product-API" }, { "name": "Stock-API", "description": "Endpoints in this section retrieve stock levels of base products, customized products and warehouse products.", "x-displayName": "Stock-API" }, { "name": "Product-API", "description": "Endpoints in this section retrieve customized products available to the currently logged in user.", "x-displayName": "Product-API" }, { "name": "Warehousing-API", "description": "Endpoints in this section manipulate (create, view, modify) objects related to warehousing.", "x-displayName": "Warehousing-API" }, { "name": "User-API", "description": "Endpoints in this section manipulate (create, view, modify) the user object.", "x-displayName": "User-API" }, { "name": "Branding-API", "description": "Endpoints in this section manipulate (create, view, modify) the packin/ branding object.", "x-displayName": "Branding-API" }, { "name": "Image-API", "description": "Endpoints in this section are used for mockup and design generation.", "x-displayName": "Image-API" }, { "name": "Webhook-API", "description": "Endpoints in this section manipulate (create, view, modify) webhooks of the currently logged in user.\n Every webhook request is signed: the JSON body is hashed with HMAC-SHA256 using the `secret` of the webhook.\n The signature is sent as a **lowercase hex** string of 64 characters, without any prefix, and is **not** base64 encoded.\n It is calculated over the **raw request body** exactly as transmitted, so verify it against the raw body before parsing the JSON.\n The header carrying the signature is the `signature_header` of the webhook, which defaults to `signature`.\n Note that retries send a modified body (new `webhook_call_id`, new `created_at` and an additional `parent_call_id`), so the signature has to be verified against the body of each individual request.\n Any response outside of the range 200 to 299 counts as a failed delivery. After the number of attempts given by `max_tries` of the webhook type, the webhook is deactivated automatically.", "x-displayName": "Webhook-API" }, { "name": "Integration-API", "description": "Endpoints in this section control data about integrations to 3rd party applications for fullfilments.\n Integrations may only be updated or deleted via API while the initial installation of integrations is performed in the user dashboard", "x-displayName": "Integration-API" }, { "name": "other", "description": "This section contains miscellaneous endpoints.", "x-displayName": "Others" } ] }