Update a price

PATCH 
/api/v1/supplier_products/:id/custom_prices/:custom_price_id

Update a price

Request

Path Parameters

id stringrequired

id of the product of which price you want to retrieve

custom_price_id stringrequired

application/vnd.api+json

Body

required

data

object

type string

Possible values: [custom_prices]

attributes

object

in_cents integer

Product Price in cents.

default boolean

Use 'true' if this should be the default Price used by Businesses that don't have a custom price. Otherwise use 'false'.

business_ids string[]

Complete list of IDs of businesses (business_ids) linked to this price. Don't use combined with 'add_business_ids' nor 'remove_business_ids'.

add_business_ids string[]

List of IDs of businesses (business_ids) to additionally link to this price. Preserves businesses already linked to this price.'

remove_business_ids string[]

List of IDs of businesses (business_ids) to dissociate from this price. Preserves businesses whose ID is not provided in the list.

custom_ref string

Can be used to assign Supplier's own ID to a Price

required

Responses

200

Update a price

application/vnd.api+json

Schema

Schema

data

object

required

id string

type string

attributes

object

in-cents integer

default boolean

supplier-product-id string

businesses array

custom-ref string

Example (from schema)

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "in-cents": 0,
      "default": true,
      "supplier-product-id": "string",
      "businesses": [
        null
      ],
      "custom-ref": "string"
    }
  }
}

Example

{
  "data": {
    "id": "c4b81084-9903-411c-a63d-7a19061df864",
    "type": "prices",
    "attributes": {
      "in-cents": 10000,
      "default": false,
      "supplier-product-id": "20ae7da2-fd68-4619-8a84-ce567d658e64",
      "businesses": [
        "214e7ec1-d740-45d9-a598-0f5367bc6bcb",
        "c2d53c04-4fcc-499c-ba0e-b4255605491d"
      ]
    }
  }
}

Loading...