Sign in
latestOpenAPI 3.0.22026-08-10312271.6 KB

c5159bc39a84

Articles

Create a single article

This resource could be used to create an article for your point of sale.

In order to get the available products that we offer, see the 'Product Types' section. There you can also find the necessary ids required to build the payload.

In the variants array, you can enable the sizes and colours of your product.

In the configuration array, you can place designs via url. The image must be in PNG format and under 10 MB. At this moment, the designs will be scaled as big as possible, keeping in mind the resolution of the chosen design and the limits of the print area.

Additionally, you can use a designId returned when uploading a design via Designs endpoint.

An image object must contain at least a url or a designId. If both are present, designId will be used.

The external id fields can be used for identifying articles and variants. They are optional, but if they are present they are validated as being not duplicates, in the article context

post/articles

Request body

titlestring required
descriptionstring required
externalIdstring

optional id that can be used for identifying the article - validated for UUID v4

Example request

{
  "variants": [
    {
      "d2cPrice": 21.56,
      "externalId": "20354d7a-e4fe-47af-8ff6-187bca92f3f9"
    }
  ],
  "configurations": [
    {
      "image": {
        "url": "https://link.to.image",
        "designId": "1231"
      },
      "hotspot": "MEDIUM_FRONT"
    }
  ],
  "externalId": "20354d7a-e4fe-47af-8ff6-187bca92f3f9"
}

Response

OK

number required

The unique identifier of the created article