Price books

Resource Representation ↑

Example:
{
  "id": 1,
  "name": "default",
  "currency": "AUD",
  "price_type": "normal",
  "include_tax": true,
  "include_duty": false,
  "from": null,
  "to": null,
  "status": "active",
  "data_sets": []
}

Supported Formats

json
>>>

GET /api/v2/price_books
List price books

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

Response:
  {
    "page": 1,
    "per_page": 50,
    "total_pages": 1,
    "total_entries": 1,
    "entries": [
      {
        "id": 1,
        "name": "default",
        "currency": "AUD",
        "price_type": "normal",
        "include_tax": true,
        "include_duty": true,
        "from": null,
        "to": null,
        "status": "active",
        "data_sets": []
      }
    ]
  }

Params

Param name Description
per_page
optional

Number of objects in one response. Default is 50

Validations:

  • Must be a number.
page
optional

Page number. Default is 1

Validations:

  • Must be a number.
>>>

POST /api/v2/price_books
Create an price book

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "price_book": {
          "name": "AU RRP",
          "currency": "AUD",
          "price_type": "retail",
          "status": "active"
      }
  }

response:
  {
    "id": 2,
    "name": "AU RRP",
    "currency": "AUD",
    "price_type": "retail",
    "include_tax": true,
    "include_duty": true,
    "from": null,
    "to": null,
    "status": "active",
    "data_sets": []
  }

Params

Param name Description
price_book
required

Validations:

  • Must be a Hash
price_book[name]
required

Name of the price book

Validations:

  • Must be a String
price_book[currency]
required

Validations:

  • Must be a String
price_book[price_type]
required

Validations:

  • Must be one of: normal, sale, retail.
price_book[include_tax]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
price_book[include_duty]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
price_book[from]
optional , nil allowed

Valid from

Validations:

  • Must be a String
price_book[to]
optional , nil allowed

Valid to

Validations:

  • Must be a String
price_book[timezone]
optional , nil allowed

Timezone of the price book

Validations:

  • Must be a String
price_book[status]
required

Validations:

  • Must be one of: inactive, active.
>>>

PUT /api/v2/price_books/:id
Update an price book

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

request:
  {
      "price_book": {
          "status": "inactive"
      }
  }

response:
  {
    "id": 2,
    "name": "AU RRP",
    "currency": "AUD",
    "price_type": "retail",
    "include_tax": true,
    "include_duty": false,
    "from": null,
    "to": null,
    "status": "inactive",
    "data_sets": [],
    "timezone": ""
  }

Params

Param name Description
price_book
required

Validations:

  • Must be a Hash
price_book[name]
optional

Name of the price book

Validations:

  • Must be a String
price_book[currency]
optional

Validations:

  • Must be a String
price_book[price_type]
optional

Validations:

  • Must be one of: normal, sale, retail.
price_book[include_tax]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
price_book[include_duty]
optional , nil allowed

Validations:

  • Must be one of: true, false, 1, 0.
price_book[from]
optional , nil allowed

Valid from

Validations:

  • Must be a String
price_book[to]
optional , nil allowed

Valid to

Validations:

  • Must be a String
price_book[timezone]
optional , nil allowed

Timezone of the price book

Validations:

  • Must be a String
price_book[status]
optional

Validations:

  • Must be one of: inactive, active.
>>>

DELETE /api/v2/price_books/:id
Delete an price book

Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
  {
    "id": 2
  }