Design a logo
You can create a new designed logo here. The logo you use for designing must contain at least one text element.
Background processing
When you design a logo, this happens asynchronously and you have to use
Polling or Webhooks.
You will receive the new logo id in the header for later reference.
The current state of the asynchronous process is represented due following states:
| State | Meaning |
|---|---|
draft | The initial state of a new logo |
checking | Logo is processed automatically in background. For example images will be generated or downloaded. |
failed | Something went wrong during the checking process. The reason can be found in the failure_message attribute. For example an image could not be downloaded. |
completed | All automatic processes were successful. The logo is ready to use. |
It is not possible to use this logo before state completed.
How to Design
You can change the texts of the logo here — see the texts property of the request body and the Text Object (LogoTextInput).
AuthorizationbearerAuth
Authorization
bearerAuth API token as bearer token — you receive a test and a live token, there is no switch between them. See Setup → Authentication and Setup → Test mode.
In: header
Path Parameters
The ID of the resource.
Header Parameters
The API only responds with JSON — this header is mandatory on every request (see Setup → Headers).
"application/json"Value in
- "application/json"
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Design a logo — you can change the texts of the logo here. The logo you use for designing must contain at least one text element.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/logos/0/design" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "texts": [ { "name": "Text_1", "lines": [ "kurzer Text1" ] } ] }'Get a logo GET
Returns the logo with the `id` = **x**. ### Expanding relationships You can expand some resources to show more details. See: [Expanding Objects](/docs/checkout/2022-02-01/basic/expanding-objects) - **Expand production method** — You can show the content of the production method instead of the `id`: `/logos/1?expand=production_method`
List texts GET
The endpoint lists all available texts. Returns a collection of texts. ### Filtering You can filter your results as follows — see the `filter[...]` query parameters below: - List texts for specified id(s): `/texts?filter[id]=1`, `/texts?filter[id]=1,2,3` - List texts for specified collection name(s): `/texts?filter[collection_name]=ordered`, `/texts?filter[collection_name]=custom` See: [Pagination](/docs/checkout/2022-02-01/basic/pagination), [Filtering](/docs/checkout/2022-02-01/basic/filtering)