merchOne Documentation
  • Overview
  • REST API
  • API reference
    • Catalog
    • Orders
    • Shipping
  • Webhooks
  • Print files
Powered by GitBook
On this page
  1. API reference

Catalog

PreviousAPI referenceNextOrders

Last updated 1 month ago

Introduction

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

  • Retrieve all the available products

  • Get information about the products' variants

  • Retrieve information about the options available for a specific store (corresponding to a determined printing/fulfillment location i.e. North America or Europe)

Endpoints

Products

Product's variants

Variant's options

SKU's variant options

Show variant's options

get

This API endpoint retrieves a list of all available variant's options.The variant_id can be checked at /api/beta/products/{product_id}

Authorizations
Path parameters
variant_idinteger · int64Required

ID of the variant

Responses
200
Request completed successfully.
application/json
401
Unauthorized
422
Unprocessable entity
application/json
get
GET /api/beta/variants/{variant_id} HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": {
    "id": 30,
    "code": "QUAD-100X100-1",
    "variant_id": 30,
    "variant_code": "QUAD-100X100-1",
    "sku": "1001001",
    "name": "100x100 cm",
    "printfile": {
      "format_width": 1000,
      "format_height": 1000
    },
    "price": 29.8,
    "price_details": {
      "currency": "EUR",
      "formatted": "29.09 €",
      "in_subunit": 298
    },
    "shipping_countries": [
      276,
      826,
      246
    ],
    "options": {
      "1": {
        "name": "Canvas border",
        "description": null,
        "image": null,
        "is_required": true,
        "values": [
          {
            "id": 1,
            "name": "Mirrored",
            "sku": "",
            "image": null,
            "price": 0,
            "price_details": {
              "currency": "EUR",
              "formatted": "29.09 €",
              "in_subunit": 298
            }
          }
        ]
      }
    }
  }
}

Show SKU's variant options

get

This API endpoint retrieves a list of all available SKU's variant options.The variant_id can be checked at /api/beta/products/{product_id}

Authorizations
Path parameters
variant_idinteger · int64Required

ID of variant to return

Responses
200
Request completed successfully.
application/json
401
Unauthorized
422
Unprocessable entity
application/json
get
GET /api/beta/variants/{variant_id}/combinations HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": {
    "sku": "CVS0200201F2HCLMSB",
    "name": "20x20 cm, Canvas border: Mirrored,Stretcher frame: 2 cm,Frame: Floating Frame Black Matt,Hanger Set for Canvas: Hanger Set for Canvas",
    "price": 13.02,
    "price_details": {
      "currency": "EUR",
      "formatted": "13.02 €",
      "in_subunit": 1302
    },
    "options": [
      {
        "id": 1,
        "name": "Canvas border",
        "image": null,
        "description": "",
        "is_required": true,
        "value": {
          "id": 1,
          "name": "Mirrored",
          "image": {
            "id": 1228,
            "original": "https://euc-premiumprint-testing.s3.eu-central-1.amazonaws.com/images/image/dE/DU/dEDUgdRkTyh9EFtfirS3gfHvPmn466OJ4mQUqqYW.jpeg"
          },
          "price": 0.2,
          "price_details": {
            "currency": "EUR",
            "formatted": "0.20 €",
            "in_subunit": 20
          }
        }
      },
      {
        "id": 2,
        "name": "Stretcher frame",
        "image": null,
        "description": "",
        "is_required": true,
        "value": {
          "id": 6,
          "name": "2 cm",
          "image": {
            "id": 194,
            "original": "https://euc-premiumprint-testing.s3.eu-central-1.amazonaws.com/images/image/lK/jc/lKjcoc347fqYciukY9Aw8VSRajNNRr9v0H1W2Erd.jpeg"
          },
          "price": 2,
          "price_details": {
            "currency": "EUR",
            "formatted": "2.00 €",
            "in_subunit": 200
          }
        }
      },
      {
        "id": 5,
        "name": "Frame",
        "image": null,
        "description": "",
        "is_required": false,
        "value": {
          "id": 18,
          "name": "Floating Frame Black Matt",
          "image": {
            "id": 6581,
            "original": "https://euc-premiumprint-testing.s3.eu-central-1.amazonaws.com/images/image/tU/9N/tU9NxIOS0PJ0iqPrIcfZ3K69hvxQIsm7AlbxcKPN.jpg"
          },
          "price": 5.76,
          "price_details": {
            "currency": "EUR",
            "formatted": "5.76 €",
            "in_subunit": 576
          }
        }
      },
      {
        "id": 17,
        "name": "Hanger Set for Canvas",
        "image": null,
        "description": null,
        "is_required": false,
        "value": {
          "id": 38,
          "name": "Hanger Set for Canvas",
          "image": {
            "id": 6279,
            "original": "https://euc-premiumprint-testing.s3.eu-central-1.amazonaws.com/images/image/KV/MS/KVMSFrC87rFCTkrAYSD9psNDIsvlCDfrApT74TaM.jpg"
          },
          "price": 1.27,
          "price_details": {
            "currency": "EUR",
            "formatted": "1.27 €",
            "in_subunit": 127
          }
        }
      }
    ]
  }
}

Show products

get

This API endpoint retrieves a list of all available products.

Authorizations
Responses
200
Request completed successfully.
application/json
401
Unauthorized
get
GET /api/beta/products HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": [
    {
      "id": 2,
      "name": "Canvas",
      "variants": 64,
      "sku": "CVS",
      "dpi": 36,
      "type": "PRINT",
      "images": [
        {
          "id": 1,
          "original": "https://dummyimage.com/4000x3000/fff/000&text=api.merchone.com",
          "thumb": "https://dummyimage.com/400x300/fff/000&text=api.merchone.com"
        }
      ]
    },
    {
      "id": 4,
      "name": "Magic Mug",
      "variants": 5,
      "sku": "MGM",
      "dpi": 72,
      "type": "PRINT",
      "images": [
        {
          "id": 2,
          "original": "https://dummyimage.com/4000x3000/fff/000&text=api.merchone.com",
          "thumb": "https://dummyimage.com/400x300/fff/000&text=api.merchone.com"
        }
      ]
    }
  ]
}

Show product's variants

get

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

Authorizations
Path parameters
product_idinteger · int64Required

ID of product to return

Responses
200
Request completed successfully.
application/json
401
Unauthorized
422
Unprocessable entity
application/json
get
GET /api/beta/products/{product_id} HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
  "data": [
    {
      "id": 30,
      "code": "QUAD-100X100-1",
      "variant_id": 30,
      "variant_code": "QUAD-100X100-1",
      "sku": "1001001",
      "name": "100x100 cm",
      "printfile": {
        "format_width": 1000,
        "format_height": 1000
      },
      "price": 29.8,
      "price_details": {
        "currency": "EUR",
        "formatted": "29.09 €",
        "in_subunit": 298
      },
      "shipping_countries": [
        276,
        826,
        246
      ],
      "options": {
        "1": {
          "name": "Canvas border",
          "description": null,
          "image": null,
          "is_required": true,
          "values": [
            {
              "id": 1,
              "name": "Mirrored",
              "sku": "",
              "image": null,
              "price": 0,
              "price_details": {
                "currency": "EUR",
                "formatted": "29.09 €",
                "in_subunit": 298
              }
            }
          ]
        }
      }
    }
  ]
}
  • Introduction
  • Endpoints
  • Products
  • GETShow products
  • Product's variants
  • GETShow product's variants
  • Variant's options
  • GETShow variant's options
  • SKU's variant options
  • GETShow SKU's variant options