Update a list of products

PATCH 
https://api.staging.powerapi.com/api/v1/supplier_products/list

Max. 1000 per request.

Request

application/vnd.api+json

Body

required

data

object

type string

Possible values: [supplier_products]

supplier_products

object[]

Max. 1000 per request.

Array [

id string

ID of Product to update

supplier_product_category string

Product category ID, must belong to the Supplier

attributes

object

name string

name_fr string

name_de string

name_it string

name_es string

name_el string

price_per_unit_cents int32

Price of one unit in the package that the product is being sold in

is_available boolean

If set to true the image attribute is required

sku_ref string

description string

description_fr string

description_de string

description_it string

description_es string

description_el string

units string

image binary

If is_available is set to true the image is required

selling_price_cents int32

Price of the product (per package sold)

default_price_cents int32

default price of the product, which can be replaced by a custom per-business one and act as a fallback value if there is no custom price

specifications object

Object containing Product specifications, the format should be

{
  "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"
  }
} ```

min_fixed_quantity integer

max_fixed_quantity integer

min_open_quantity float

max_open_quantity float

]

Responses

201

Upate a list of products

application/vnd.api+json

Schema

Schema

data

object[]

required

Array [

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

]

Example (from schema)

{
  "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
      }
    }
  ]
}

• curl
• python
• go
• nodejs
• ruby
• java
• powershell

• CURL

curl -L -X PATCH 'https://api.staging.powerapi.com/api/v1/supplier_products/list' \
-H 'Content-Type: application/vnd.api+json' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "data": {
    "type": "supplier_products",
    "supplier_products": [
      {
        "id": "string",
        "supplier_product_category": "string",
        "attributes": {
          "name": "string",
          "name_fr": "string",
          "name_de": "string",
          "name_it": "string",
          "name_es": "string",
          "name_el": "string",
          "price_per_unit_cents": 0,
          "is_available": true,
          "sku_ref": "string",
          "description": "string",
          "description_fr": "string",
          "description_de": "string",
          "description_it": "string",
          "description_es": "string",
          "description_el": "string",
          "units": "string",
          "image": "string",
          "selling_price_cents": 0,
          "default_price_cents": 0,
          "specifications": {},
          "min_fixed_quantity": 0,
          "max_fixed_quantity": 0,
          "min_open_quantity": 0,
          "max_open_quantity": 0
        }
      }
    ]
  }
}'

Request Collapse all

Base URL

https://api.staging.powerapi.com

Auth

Bearer Token

Body required

{
  "data": {
    "type": "supplier_products",
    "supplier_products": [
      {
        "id": "string",
        "supplier_product_category": "string",
        "attributes": {
          "name": "string",
          "name_fr": "string",
          "name_de": "string",
          "name_it": "string",
          "name_es": "string",
          "name_el": "string",
          "price_per_unit_cents": 0,
          "is_available": true,
          "sku_ref": "string",
          "description": "string",
          "description_fr": "string",
          "description_de": "string",
          "description_it": "string",
          "description_es": "string",
          "description_el": "string",
          "units": "string",
          "image": "string",
          "selling_price_cents": 0,
          "default_price_cents": 0,
          "specifications": {},
          "min_fixed_quantity": 0,
          "max_fixed_quantity": 0,
          "min_open_quantity": 0,
          "max_open_quantity": 0
        }
      }
    ]
  }
}

ResponseClear

Click the Send API Request button above and see the response here!