Price items

Resource Representation ↑

Example:
{
  "id": 28,
  "amount": 10,
  "product_id": 6,
  "from": null,
  "to": null,
  "description": "promotion ABC"
  "enabled?": true,
  "price_book": {
    "id": 1,
    "name": "default"
  }
}

Supported Formats

json
>>>

GET /api/v2/price_items
List price items

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": 28,
        "amount": 10,
        "product_id": 6,
        "from": null,
        "to": null,
        "enabled?": true,
        "price_book": {
          "id": 1,
          "name": "default"
        }
      }
    ]
  }

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.
lang
optional

Language code for translated value

Validations:

  • Must be a String
>>>

POST /api/v2/price_items
Create an price item

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_item": {
        "amount": 12,
        "from": "2016-07-05T09:00:00.000+10:00",
        "to": "2016-07-08T09:00:00.000+10:00",
        "product_id": 6,
        "price_book_id": 1
    }
  }

Sample: create a media item for Npc Entity with npc entity id
  {
    "price_item": {
        "amount": 12,
        "from": "2016-07-05T09:00:00.000+10:00",
        "to": "2016-07-08T09:00:00.000+10:00",
        "npc_entity_id": 6,
        "price_book_id": 1
    }
  }

response:
  {
    "id": 29,
    "amount": 12,
    "product_id": 6,
    "from": "2016-07-05T09:00:00.000+10:00",
    "to": "2016-07-08T09:00:00.000+10:00",
    "enabled?": true,
    "price_book": {
      "id": 1,
      "name": "default"
    }
  }

Params

Param name Description
price_item
required

Validations:

  • Must be a Hash
price_item[amount]
required

Price amount

Validations:

  • Must be a Numeric
price_item[from]
optional , nil allowed

Valid from. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

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

Valid to. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

  • Must be a String
price_item[product_id]
optional , nil allowed

Parent product ID. Mandatory if assigning price item to product and produce_code is not provided.

Validations:

  • Must be a Integer
price_item[product_code]
optional , nil allowed

Parent product code. Mandatory if assigning price item to product and product_id is not provided.

Validations:

  • Must be a String
price_item[npc_entity_id]
optional , nil allowed

Parent npc entity ID. Mandatory if assigning price item to Npc entity and npc_entity_code is not provided.

Validations:

  • Must be a Integer
price_item[npc_entity_code]
optional , nil allowed

Parent npc entity code. Mandatory if assigning price item to Npc entity and npc_entity_id is not provided.

Validations:

  • Must be a String
price_item[price_book_id]
required

Parent price book ID

Validations:

  • Must be a Integer
price_item[description]
optional , nil allowed

Description for this price item. For example, to record a discount reason or promotion code.

Validations:

  • Must be a String
>>>

PUT /api/v2/price_items/:id
Update an price item

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_item": {
      "amount": 10
    }
  }

response:
  {
    "id": 28,
    "amount": 10,
    "product_id": 6,
    "from": null,
    "to": null,
    "enabled?": true,
    "price_book": {
      "id": 1,
      "name": "default"
    }
  }

Params

Param name Description
price_item
required

Validations:

  • Must be a Hash
price_item[amount]
optional

Price amount

Validations:

  • Must be a Numeric
price_item[from]
optional , nil allowed

Valid from. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

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

Valid to. ISO_8601 format 2016-05-30T05:13:26Z.

Validations:

  • Must be a String
price_item[product_id]
optional , nil allowed

Parent product ID. Mandatory if assigning price item to product and produce_code is not provided.

Validations:

  • Must be a Integer
price_item[product_code]
optional , nil allowed

Parent product code. Mandatory if assigning price item to product and product_id is not provided.

Validations:

  • Must be a String
price_item[npc_entity_id]
optional , nil allowed

Parent npc entity ID. Mandatory if assigning price item to Npc entity and npc_entity_code is not provided.

Validations:

  • Must be a Integer
price_item[npc_entity_code]
optional , nil allowed

Parent npc entity code. Mandatory if assigning price item to Npc entity and npc_entity_id is not provided.

Validations:

  • Must be a String
price_item[price_book_id]
optional

Parent price book ID

Validations:

  • Must be a Integer
price_item[description]
optional , nil allowed

Description for this price item. For example, to record a discount reason or promotion code.

Validations:

  • Must be a String
>>>

DELETE /api/v2/price_items/:id
Delete an price item

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": 28
  }