Return all available Suppliers Products
GET/api/v1/supplier_products
Return all available Suppliers Products
Request
Query Parameters
sort string
custom_catalogs boolean
Possible values: [true, false]
business_id string
filter[supplier_id] string
filter[parent_category_name] string
Requires supplier_id. Mutually exclusive with filters: supplier_names, category_names
page int32
Default value: 1
Page offset to fetch.
per_page int32
Default value: 10
Number of results to return per page.
filter[product_names] string[]
filter[supplier_names] string[]
filter[category_names] string[]
Responses
- 200
Return all available Suppliers Products
- application/vnd.api+json
- Schema
- Example (from schema)
- Example
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]
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,
"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
}
}
{
"data": [
{
"id": "7be9bae0-5b9d-4216-8497-dcc03439ca4d",
"type": "supplier-products",
"attributes": {
"description": "Animi vero totam eveniet minima ut",
"description-en": "Animi vero totam eveniet minima ut",
"description-fr": null,
"description-de": null,
"description-it": null,
"description-es": null,
"description-el": null,
"image": {
"type": "string",
"format": "binary"
},
"is-available": true,
"name": "Bumbu Rum XO",
"name-en": "Bumbu Rum XO",
"name-fr": null,
"name-de": null,
"name-it": null,
"name-es": null,
"name-el": null,
"price-per-unit-cents": 3500,
"selling-price-cents": null,
"sku-ref": 1967,
"specifications": {
"specification_group_A": {
"specification_x": "value_x",
"specification_y": "value_y",
"specification_z": "value_z"
},
"specification_group_B": {
"specification_q": "value_q",
"specification_w": "value_w"
}
},
"supplier-name": "asperiores35",
"supplier-id": "9c7a98a0-218e-4cd5-8c49-ebff471829fd",
"open-quantity": null,
"fixed-quantity": 1,
"quantity-type": "fixed",
"units": "liter",
"from-custom-catalog": false,
"ordering-deadline": 54000,
"ordering-lead-time": 172800
}
}
],
"meta": {
"total-count": 4,
"total-pages": 4
}
}
Loading...