storeback-api 0.2.6

storeback-api is a test repo to poof of concept of PDP resource serving.

  • Contact: N/A
  • License: N/A

Resources

Product

Operations

Method and Path Description
GET /v1/products/:productId

Returns a product by ID or by handle.

The following API will return a product object sanitized of private information from shopify. It should be thought of as a serializer or alturnative interface to the public shopify information per a product.

Headers

No headers

Imports

No imports

Enums

No enums

Interfaces

No interfaces

Models

Product

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id long No -

An unsigned 64-bit integer that’s used as a unique identifier for the product. Each id is unique across the Shopify system. No two products will have the same id, even if they’re from different shops.

Example: 4185052971093

title string No -

The name of the product.

Example: Men's Merino Tri-Block Calf Sock Gift Box

handle string No -

A unique human-friendly string for the product. Automatically generated from the product’s title. Used by the Liquid templating language to refer to objects.

Example: mens-merino-tri-block-calf-sock-gift-box

description string No -

A description of the product.

Example: Purpose-built for running, working out and movement. Bombas Hex Tec construction for breathability and moisture-wicking. Proprietary cotton-poly blend yarns. With comfort innovations like strategic zone cushioning and airflow ventilation. Specially designed to help you move with grace and speed. Included is a Bombas Hex Tec Sock Bag, designed to keep your socks organized and away from the rest of your stuff or to just put some of your favorite belongings in after an intense workout.

description_html string No -

A description of the product. Supports HTML formatting.

Example: <meta charset="utf-8"><p>Purpose-built for running, working out and movement. Bombas Hex Tec construction for breathability and moisture-wicking. Proprietary cotton-poly blend yarns. With comfort innovations like strategic zone cushioning and airflow ventilation. Specially designed to help you move with grace and speed. </p><p>Included is a Bombas Hex Tec Sock Bag, designed to keep your socks organized and away from the rest of your stuff <span>or to just put some of your favorite belongings in</span><span> </span>after an intense workout. </p>

item_count integer No -

The number of units included. If it is > 1, then it is a pack.

Example: 8

product_type string No -

The product type

Example: socks

gender string No -

The marketed gender of the products

Example: womens

colors [Color] No -

sizes [Size] No -

images [object] No -

variants [Variant] No -

breadcrumbs [Breadcrumb] No -

details [Detail] No -

created_at string No -

The date and time (ISO 8601 format) when the product was created.

Example: 2012-08-24T14:01:47-04:00

updated_at string No -

The date and time (ISO 8601 format) when the product was last modified.

Example: 2012-08-24T14:01:47-04:00

Size

Example Json: Minimal | Full

Interfaces: None

A particular size options for a product

Field Type Required? Default Description
name string No -

The name of the option which this size was created from

Example: size

values [SizeValues] No -

SizeValues

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id string No -

The internal name of the size

Example: l

name string No -

The visual name of the size

Example: l

guidance string No -

Size related guidance for more specific examples for the user

Example: US Shoe Size 8-10½

Color

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id string No -

The slug id of the color

Example: white-charcoal-black

position integer No -

The order in which the color should be displayed

Example: 0

name string No -

The name of the color

Example: White charcoal black

fill string No -

A 80x80 url of an image of the swatch to use on FE

Example: https://assets.bombas.com/image/fetch/f_auto,q_auto/https://cdn.shopify.com/s/files/1/1119/5850/files/swatch_performance-running-white-charcoal-black_80x80.png

Variant

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id long No -

The unique numeric identifier for the product variant.

Example: 22838940926037

product_id long No -

The unique numeric identifier for the product.

Example: 2642653839445

sku string No -

A unique identifier for the product variant in the shop. Required in order to connect to a FulfillmentService.

Example: 843629142993

title string No -

The title of the product variant.

Example: white charcoal black / m

is_available boolean No -

If the variant is availabor not

Example: true

price Price No -

shipping Shipping No -

created_at string No -

The date and time (ISO 8601 format) when the product was created.

Example: 2012-08-24T14:01:47-04:00

updated_at string No -

The date and time (ISO 8601 format) when the product was last modified.

Example: 2012-08-24T14:01:47-04:00

sizes [Size] No -

Shipping

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
requires_shipping boolean No -

This property is deprecated. Use the requires_shipping property on the InventoryItem resource instead.

Example: true

grams integer No -

The weight of the product variant in grams.

Example: 510

weight integer No -

The weight of the product variant in the unit system specified with weight_unit.

Example: 18

weight_unit string No -

The unit of measurement that applies to the product variant’s weight. If you don’t specify a value for weight_unit, then the shop’s default unit of measurement is applied. Valid values: g, kg, oz, and lb.

Example: oz

Breadcrumb

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

The name of the breadcrumb section

Example: Womens

link string No -

Pieces of a collections page url to use for link

Example: /collections/womens

position integer No -

Order position

Example: 0

Image

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id integer No -

A unique numeric identifier for the product image.

Example: 8844696584277

position integer No -

The order of the product image in the list. The first product image is at position 1 and is the ‘main’ image for the product.

Example: 1

alt string No -

ALT text

Example: a pair of feet with socks on them, the socks are blue

src string No -

Specifies the location of the product image. This parameter supports URL filters that you can use to retrieve modified copies of the image. For example, add _small, to the filename to retrieve a scaled copy of the image at 100 x 100 px (for example, ipod-nano_small.png), or add _2048x2048 to retrieve a copy of the image constrained at 2048 x 2048 px resolution (for example, ipod-nano_2048x2048.png).

Example: https://cdn.shopify.com/s/files/1/1119/5850/products/white-charcoal-black-grid_278da800-8c13-407f-8607-28986dfc83f8.jpg?v=1571684501

Price

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
msrp string No -

The original price of the item before an adjustment or a sale.

Example: 100.00

price string No -

The price of the product variant.

Example: 100.00

isDiscounted boolean No -

true If the product is discounted

Example: false

percentOff string No -

percentOff which is a whole number as a string, based on the percentage price is off of msrp prices.

Detail

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
icon_handle string No -

the name used to generate the silhouette icon image for a product detail

Example: calf

title string No -

the title of the details / set of tech features

Example: Compression

tech [Tech] No -

Tech

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
title string No -

name of the tech feature

Example: Seamless Toe

handle string No -

a unique internal name used to identify the tech feature

Example: invisitoe

content string No -

the copy wrote for the tech feature

Example: We took the extra time to link the final seam on every pair of socks carefully by hand, creating a fully-smooth sock with no annoying bump.

Unions

No unions

Annotations

No annotations