List of Products
: You may require a list of products in many situations, for example, when you need to simply display the catalog in your storefront, or to provide a third party service with a list of products available in your store.Single Product
: You may require a single product when you need more information of a particular product, for example when you need to show full listing data before to trigger purchase decision.id
: the unique product identifiertitle
: the title of the productdescription
: it provides commercial information about the product.price
: the price of the product. You can choose the currency it comes in.currency
: it can be USD, EUR or NOKimages
quantity
: the available stock. This field is updated each time you receive product information. It is an important field to validate at the moment of the purchase to check for possibles out of stock.supplier
: it contains an object with key user informationid
: The unique id identifier of the variant.title
: A combination of the variant options. For example: "Small-Blue".price
: The price of the variant. It usually is the same, but it may vary.quantity
: the available stock of the variant.catalogId
: the unique product ID.products
query gives the ability to filter the results. Use the optional filter argument. Some of the filters that are available here are:search: String
: search by name or part of the description.price: ...
: filter by base price:price: {lte: Float}
: price lower than or equal to a given value.price: {gte: Float}
: price greater than or equal to a given value.minimalPrice: ...
: filter by minimal variant price:minimalPrice: {lte: Float}
: price lower than or equal to a given value.minimalPrice: {gte: Float}
: price greater than or equal to a given value.stockAvailability
: ...: filter by available stock:stockAvailability
: IN_STOCK: only available products.stockAvailability
: OUT_OF_STOCK: only out-of-stock products.field
: the field to use for sorting the results from several predefined choices:DATE
: sort products by last update. MINIMAL_PRICE
: sort products by minimal variant price.NAME
: sort products by name.PRICE
: sort products by base price.PUBLICATION_DATE
: sort products by publication date.PUBLISHED
: sort products by publication status.RATING
: sort products by rating.TYPE
: sort products by product type.direction
: The direction for sorting items:ASC
: sort ascending.DESC
: sort descending.variants
field on the Product type:id
: the unique variant ID.name
: the name of the variant.pricing
field of products and variants to obtain pricing information.address
parameter in the pricing
field including a country code, for which the tax should be calculated. The address
parameter is available in Product.pricing
and ProductVariant.pricing
fields.Product.isAvailable
field:address
parameter is used to check the quantity in a warehouse that is connected with a shipping zone that includes the given address. If not provided, Outshifter will use a warehouse with the highest available quantity.isAvailable
field is True when:address
. If the argument is omitted, API will return the highest available quantity.MAX_CHECKOUT_LINE_QUANTITY
.quantityAvailable
and stocks, we will query both for the product variant:"quantityAvailable": 50
: customers only see maximum of 50 pcs available to buystocks
contain full list of stock quantities in every of the warehousesimages: Image
: the product's images come in an array. An optional width and height parameters specifies the desired size in pixels.url: String!
: the image's URL.alt: String
: the alternative text to include when displaying the image.order: Int
: the order of the .width: Int
: the width of the image to display.height: Int
: the height of the image to display.