Return Supplier Products from provided ids
GET/api/v1/supplier_products/list
Return Supplier Products from provided ids
Request
Query Parameters
sort string
page int32
Default value: 1
Page offset to fetch.
per_page int32
Default value: 10
Number of results to return per page.
supplier_product_ids[] string[]required
Possible values: >= 1
IDs of the Products to return
Responses
- 200
Return all available Suppliers Products
- application/vnd.api+json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
required
id string
type string
attributes
object
description string
description-en string
description-fr string
description-de string
description-it string
description-es string
description-el string
image binary
is-available boolean
Possible values: [true
, false
]
max-fixed-quantity integer
max-open-quantity float
min-fixed-quantity integer
min-open-quantity float
name string
name-en string
name-fr string
name-de string
name-it string
name-es string
name-el string
price-per-unit-cents integer
Price of one unit in the package that the product is being sold in
selling-price-cents integer
Price of the product (per package sold)
price-in-cents integer
Price of the product for a specific business
sku-ref integer
specifications object
supplier-name string
supplier-id string
open-quantity float
fixed-quantity integer
quantity-type string
units string
from-custom-catalog boolean
Possible values: [true
, false
]
ordering-deadline integer
ordering-lead-time integer
meta
object
required
total-count numberrequired
total-pages numberrequired
{
"data": [
{
"id": "string",
"type": "string",
"attributes": {
"description": "string",
"description-en": "string",
"description-fr": "string",
"description-de": "string",
"description-it": "string",
"description-es": "string",
"description-el": "string",
"image": "string",
"is-available": true,
"max-fixed-quantity": 0,
"max-open-quantity": 0,
"min-fixed-quantity": 0,
"min-open-quantity": 0,
"name": "string",
"name-en": "string",
"name-fr": "string",
"name-de": "string",
"name-it": "string",
"name-es": "string",
"name-el": "string",
"price-per-unit-cents": 0,
"selling-price-cents": 0,
"price-in-cents": 0,
"sku-ref": 0,
"specifications": {},
"supplier-name": "string",
"supplier-id": "string",
"open-quantity": 0,
"fixed-quantity": 0,
"quantity-type": "string",
"units": "string",
"from-custom-catalog": true,
"ordering-deadline": 0,
"ordering-lead-time": 0
}
}
],
"meta": {
"total-count": 0,
"total-pages": 0
}
}
Loading...