Create Pricesheet Pricing

POST 
/pricesheets/:lookupKey/:lookupValue/pricing

Use this endpoint to define pricing for an existing price sheet. The price sheet can be identified by it's lookup key. It is required to provide either categories or products or both.

Use cases

A common use case for this endpoint is when you want to give discounts on all products in a certain category or set a specific price from your ERP system for a product. You can decide to assign a price sheet to only one or multiple users. You can also create a price sheet in advance, create the pricing and have it be ready to assign to a user or usergroup at any given moment i.e. when a sales team decides to.

If you want to give a discount of 20% of sales price on all products in a given category you can use the SP type pricing for a category. The discount will apply on all products that belong in that category.

Another common use case is to set a specific price for a product. This is usually used when your ERP system is responsible for the complex price calculations or simply your sales team agreed on a specific price for a product.

Request

Path Parameters

lookupKey stringrequired

Lookup key. Read more about price sheet lookup keys

lookupValue stringrequired

The value of the key (id or code)

application/json

Body

categories

object[]

Array [

id number

pricing

object

amount number

quantity number

type string

validFrom string

validTo string

]

products

object[]

Array [

id number

pricing

object

amount number

price number

quantity number

type string

validFrom string

validTo string

]

Responses

200

Create Pricesheet Pricing / Create Pricesheet Pricing - 200 (invalid category)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

data

object[]

Array [

action string

key number

lookupKey string

success boolean

]

messages string[]
total number

Example (from schema)

{
  "data": [
    {
      "action": "create",
      "key": 1779,
      "lookupKey": "id",
      "success": true
    },
    {
      "action": "create",
      "key": 40364,
      "lookupKey": "id",
      "success": true
    },
    {
      "action": "create",
      "key": 40362,
      "lookupKey": "id",
      "success": true
    }
  ],
  "messages": [
    "completed"
  ],
  "total": 3
}

Create Pricesheet Pricing

{
  "data": [
    {
      "action": "create",
      "key": 1779,
      "lookupKey": "id",
      "success": true
    },
    {
      "action": "create",
      "key": 40364,
      "lookupKey": "id",
      "success": true
    },
    {
      "action": "create",
      "key": 40362,
      "lookupKey": "id",
      "success": true
    }
  ],
  "messages": [
    "completed"
  ],
  "total": 3
}

Create Pricesheet Pricing - 200 (invalid category)

{
  "data": [
    {
      "action": "create",
      "error": "category with id [17795] not found",
      "key": 17795,
      "lookupKey": "id",
      "success": false
    },
    {
      "action": "create",
      "key": 40364,
      "lookupKey": "id",
      "success": true
    },
    {
      "action": "create",
      "key": 40362,
      "lookupKey": "id",
      "success": true
    }
  ],
  "messages": [
    "completed"
  ],
  "total": 3
}

400

Create Pricesheet Pricing - 400 (invalid schema)

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [product] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Create Pricesheet Pricing - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#: extraneous key [product] is not permitted"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

404

Create Pricesheet Pricing - 404

Response Headers

• Alt-Svc

  string

• Via

  string

• alt-svc

  string

• content-length

  string

• date

  string

• return-format

  string

• server

  string

• x-request-id

  string

application/json

Schema

Schema

error

object

code number

messages string[]

moreInfo string

status number

type string

Example (from schema)

{
  "error": {
    "code": 12005,
    "messages": [
      "Parent resource [Pricesheets] with code [3A212] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/12005",
    "status": 404,
    "type": "ParentPricesheetsNotFound"
  }
}

Create Pricesheet Pricing - 404

{
  "error": {
    "code": 12005,
    "messages": [
      "Parent resource [Pricesheets] with code [3A212] not found"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/12005",
    "status": 404,
    "type": "ParentPricesheetsNotFound"
  }
}

Loading...