Products · solidus-sdk

Allows you to interact with products and related endpoints.

For more information on how products work, see the Solidus Developer's Guide

Get All Products

[GET] /api/products

paginated

Retrieves a list of available products.

Usage

import { Solidus } from 'solidus-sdk'

const instance = new Solidus({ href: 'https://mysolidus.app' })

instance.product().all()

Retrieve paginated results

import { Solidus } from 'solidus-sdk'

const instance = new Solidus({ href: 'https://mysolidus.app' })

instance.product().all({ per_page: 50, page: 3 })

Retrieve a list of products by their id (comma separated string).

import { Solidus } from 'solidus-sdk'

const instance = new Solidus({ href: 'https://mysolidus.app' })

instance.product().all({ ids: [1,2,3,4,5].join(',')})

Helpful Links

Create Product

[POST] /api/products

admin

Creates a new product.

This should be used along side the new() method to learn attributes can be saved to the product and which are required.

Note: The values sent to this method should be wrapped inside a product property. See examples for more details.

Usage

import { Solidus } from 'solidus-sdk'

const instance = new Solidus({ href: 'https://mysolidus.app' })

instance.product().create({ product })

Helpful Links

Learn How to Create a Product

[GET] /api/products/new

This endpoint returns information about what attributes are accepted by the API and which are required when creating a new product.

You can use this endpoint to help you build a form that allows users to create new products.

Usage

import { Solidus } from 'solidus-sdk'

const instance = new Solidus({ href: 'https://mysolidus.app' })

instance.product().new()

Helpful Links

Source

Learn How to Edit a Product

[GET] /api/products/:id/edit

admin

This endpoint returns information about what attributes are accepted by the API and which are required when editing an existing product.

You can use this endpoint to help you build a form that allows users to edit products.

Usage

import { Solidus } from 'solidus-sdk'

const instance = new Solidus({ href: 'https://mysolidus.app' })

instance.product({ id }).edit()

get

[GET] /api/products/:id

update

[PATCH] /api/products/:id

delete

[PATCH] /api/products/:id

all

[GET] /api/products/:product.id/images

create

[POST] /api/products/:product.id/images

new

[GET] /api/products/:product.id/images/new

edit

[GET] /api/products/:product.id/images/:id/edit

get

[GET] /api/products/:product.id/images/:id

update

[PATCH] /api/products/:product.id/images/:id

delete

[DELETE] /api/products/:product.id/images/:id

all

[GET] /api/products/:product.id/variants

create

[POST] /api/products/:product.id/variants

new

[GET] /api/products/:product.id/variants/new

edit

[GET] /api/products/:product.id/variants/:id/edit

get

[GET] /api/products/:product.id/variants/:id

update

[PATCH] /api/products/:product.id/variants/:id

delete

[DELETE] /api/products/:product.id/variants/:id

all

[GET] /api/products/:product.id/product_properties

create

[POST] /api/products/:product.id/product_properties

new

[GET] /api/products/:product.id/product_properties/new

edit

[GET] /api/products/:product.id/product_properties/:id/edit

be sure to follow the instructions found in the Contributing Guide.

get

[GET] /api/products/:product.id/product_properties/:id

be sure to follow the instructions found in the Contributing Guide.

update

[PATCH] /api/products/:product.id/product_properties/:id

delete

[DELETE] /api/products/:product.id/product_properties/:id