API Documentation

Introduction

This API allows you to interact with the product database. You can retrieve all products, find a product by its UPC, or search for a product by its name.

Product Object

The product object is a standardized format returned by the API endpoints. Here are the fields included in the product object:

id (string)

The unique identifier for the product.

upc1 (string)

The Universal Product Code of the product.

raw_product (string)

The name of the product.

raw_brand (string)

The brand name of the product.

category (string)

The category of the product.

sub_category (string)

The subcategory of the product.

pack_size (string)

The pack size of the product.

size (string)

The size of the product.

image_url (string)

The image of the product.

price (number)

The price of the product.

Get All Products

Returns a list of products

Method:GET

Endpoint:

api endpoint

Response Format

1[
2  {
3    "id": "230-EcomScribe-GroceryProducts",
4    "upc1": "3168930159865",
5    "raw_product": "7Up Cocktail Exotique - 330ml",
6    "raw_brand": "7 Up",
7    "category": "Alcohol",
8    "sub_category": "Ready To Drink",
9    "pack_size": null,
10    "size": null,
11    "image_url": "https://go-upc.s3.amazonaws.com/images/42962731.jpeg",
12    "price": "1.29"
13  },
14  ...
15]

Get Product by UPC

Returns a single product based on the provided UPC.

Method:GET

Parameters:

upc1 REQUIRED

Endpoint:

api endpoint

Response Format

1{
2  "id": "230-EcomScribe-GroceryProducts",
3  "upc1": "3168930159865",
4  "raw_product": "7Up Cocktail Exotique - 330ml",
5  "raw_brand": "7 Up",
6  "category": "Alcohol",
7  "sub_category": "Ready To Drink",
8  "pack_size": null,
9  "size": null,
10  "image_url": "https://go-upc.s3.amazonaws.com/images/42962731.jpeg",
11  "price": "1.29"
12}

Get Product by Name

Returns a single product based on the provided Name.

Method:GET

Parameters:

raw_product REQUIRED

Endpoint:

api endpoint

Response Format

1{
2  "id": "230-EcomScribe-GroceryProducts",
3  "upc1": "3168930159865",
4  "raw_product": "7Up Cocktail Exotique - 330ml",
5  "raw_brand": "7 Up",
6  "category": "Alcohol",
7  "sub_category": "Ready To Drink",
8  "pack_size": null,
9  "size": null,
10  "image_url": "https://go-upc.s3.amazonaws.com/images/42962731.jpeg",
11  "price": "1.29"
12}