Blueprints

Introduction

Through the endpoints included in the Blueprints section, you will be able to:

  • Retrieve all the available blueprints

  • Retrieve all the available blueprint variants

  • Retrieve all the available blueprint variant options

Endpoints

Show blueprints

get

This API endpoint retrieves a list of all available blueprints.

Authorizations
Responses
200
OK
application/json
get
GET /api/v1/blueprints HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": [
    {
      "id": 1,
      "name": "Canvas",
      "description": "A versatile design classic updated with HP latex inks...",
      "tags": [
        "canvas"
      ],
      "type": "PRINT",
      "images": [],
      "variants_count": 1
    },
    {
      "id": 2,
      "name": "Magic Mug",
      "description": "A quality ceramic photo mug with a twist...",
      "type": "PRINT",
      "tags": [],
      "images": [],
      "variants_count": 1
    }
  ]
}

Show blueprint's variants

get

This API endpoint retrieves a list of all available blueprint's variants.

Authorizations
Path parameters
blueprintstringRequired

The ID of the blueprint.

Responses
200
OK
application/json
get
GET /api/v1/blueprints/{blueprint}/variants HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": [
    {
      "id": 1,
      "name": "20x20 cm",
      "production": "Europe",
      "type": "PRINT",
      "trim": null,
      "design_area": {
        "width": 200,
        "height": 200
      },
      "printfile": {
        "width": 200,
        "height": 200
      },
      "description": null,
      "tags": [],
      "images": [],
      "price": 10,
      "price_details": {
        "currency": "EUR",
        "formatted": "10.00 €",
        "in_subunit": 1000
      }
    },
    {
      "id": 1,
      "name": "30x20 cm",
      "production": "Europe",
      "type": "PRINT",
      "trim": null,
      "design_area": {
        "width": 300,
        "height": 200
      },
      "printfile": {
        "width": 300,
        "height": 200
      },
      "description": null,
      "tags": [],
      "images": [],
      "price": 12,
      "price_details": {
        "currency": "EUR",
        "formatted": "12.00 €",
        "in_subunit": 1200
      }
    }
  ]
}

Show blueprint variant options

get

Retrieve options for a specific variant of a blueprint.

Authorizations
Path parameters
blueprintstringRequired

The ID of the blueprint.

variantstringRequired

The ID of the variant.

Responses
200
OK
application/json
get
GET /api/v1/blueprints/{blueprint}/variants/{variant}/options HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": {
    "id": 1,
    "name": "20x20 cm",
    "variants": [
      {
        "sku": "CVS0200201LWF2",
        "name": "White / 2 cm",
        "price": 10,
        "price_details": {
          "currency": "EUR",
          "formatted": "10.00 €",
          "in_subunit": 1000
        },
        "options": [
          {
            "id": 4,
            "Canvas border": "White",
            "price": 1,
            "price_details": {
              "currency": "EUR",
              "formatted": "1.00 €",
              "in_subunit": 100
            }
          },
          {
            "id": 6,
            "Stretcher frame": "2 cm",
            "price": 1,
            "price_details": {
              "currency": "EUR",
              "formatted": "1.00 €",
              "in_subunit": 100
            }
          }
        ],
        "print_areas": [
          {
            "position": "front",
            "width": 200,
            "height": 200,
            "dpi": 36,
            "type": "PRINT",
            "required": true
          }
        ]
      }
    ]
  }
}

Last updated