Create Pricesheet

POST 
/pricesheets

Use this endpoint to create a price sheet. If a price sheet is successfully created, the response will include the price sheet id.

Fields

Name	Required
code	yes
shopId	no Defaults to first shop found
name	no
description	no

Request

application/json

Body

code string
description string
name number

Responses

201

Create Pricesheet - 200

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

code string

description string

id number

name string
messages string[]
total number

Example (from schema)

{
  "data": {
    "code": "3A21",
    "description": "",
    "id": 11,
    "name": "Pricesheet 3A21"
  },
  "messages": [
    "Pricesheet created"
  ],
  "total": 1
}

Create Pricesheet - 200

{
  "data": {
    "code": "3A21",
    "description": "",
    "id": 11,
    "name": "Pricesheet 3A21"
  },
  "messages": [
    "Pricesheet created"
  ],
  "total": 1
}

400

Create Pricesheet - 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": [
      "#/name: expected type: String, found: Integer"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Create Pricesheet - 400 (invalid schema)

{
  "error": {
    "code": 10007,
    "messages": [
      "#/name: expected type: String, found: Integer"
    ],
    "moreInfo": "https://www.propel.us/docs/errors/10007",
    "status": 400,
    "type": "SchemaValidationException"
  }
}

Loading...