Library

Introduction

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

• Retrieve all the available images from the library

• Retrieve an image from the library

• Add an image to the library

Endpoints

Show library

get

This API endpoint retrieves a list of all images from your library

Authorizations

BasicAuth

AuthorizationstringRequired

Responses

200

OK

application/json

401

Unauthorized

get

/library

HTTPcURLJavaScriptPython

GET /api/v1/library HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*

{
  "data": [
    {
      "image_id": "APO12345678",
      "file_name": "image-1000x1000",
      "width": 1000,
      "height": 1000,
      "size": "10",
      "image_url": "https://example.com/images/image.png"
    }
  ]
}

Show an image from the library

get

This API endpoint retrieves an images from your library

Authorizations

BasicAuth

AuthorizationstringRequired

Path parameters

imagestringRequired

The ID of the image.

Responses

200

OK

application/json

401

Unauthorized

404

Not found.

get

/library/{image}

HTTPcURLJavaScriptPython

GET /api/v1/library/{image} HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*

{
  "data": {
    "image_id": "APO12345678",
    "file_name": "image name",
    "width": 1000,
    "height": 1000,
    "size": "10",
    "image_url": "https://example.com/images/image.png"
  }
}

Post a new image to the library

post

This API endpoint allows you to upload a new image to your library

Authorizations

BasicAuth

AuthorizationstringRequired

Header parameters

Acceptstring · enumRequired

Media type(s) that is/are acceptable for the response

Default: application/jsonPossible values:

Body

application/json

file_namestringRequired

urlstringRequired

Responses

200

OK

application/json

401

Unauthorized

post

/library

HTTPcURLJavaScriptPython

POST /api/v1/library HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: application/json
Content-Type: application/json
Content-Length: 71

{
  "file_name": "image name",
  "url": "https://example.com/images/image.png"
}

{
  "data": {
    "image_id": "APO12345678",
    "file_name": "image name",
    "upload_date": "2025-01-01 00:00:00"
  }
}