ProductPriceLists.get

Returns ProductPriceList with given id

Responses

🟢200OK

application/json

ProductPriceList data

Body

success

boolean

optional

True when response succeeded, false on error.

Example:

true

data

object (ProductPriceList)

optional

is_delete_protected

boolean

read-onlyrequired

Tells if the entity instance is protected against delete (Entities that need to be present in the system at any time). Delete action still may fail if entity is deletable, due some other additional validations.

Example:

false

string <uuid>

read-onlyrequired

Unique identifier of entity.

Example:

01234567-abcd-dcba-ffff-000000000000

is_deleted

boolean

read-onlyoptional

Specifies if the entity is considered deleted.

Example:

false

modified

string <date-time>

read-onlyoptional

Last modification time.

Example:

2019-01-01T00:00:00

created

string <date-time>

read-onlyoptional

Creation time.

Example:

2019-01-01T00:00:00

description

string

optional

Multi-line text input field.

Example:

string

end_date

string <date>

required

Date information.

Example:

2019-01-01

name

string

required

Name of the entity and its default text representation.

Example:

string

start_date

string <date>

required

Date information.

Example:

2019-01-01

revision

integer <int32>

optional

Revision when entity was lastly changed.

Example:

product_price_list_prices

array[string <uri>]

optional

Relations to Products.

Example

{
    "success": true,
    "data": {
        "is_delete_protected": false,
        "id": "01234567-abcd-dcba-ffff-000000000000",
        "is_deleted": false,
        "modified": "2019-01-01T00:00:00",
        "created": "2019-01-01T00:00:00",
        "description": "string",
        "end_date": "2019-01-01",
        "name": "string",
        "start_date": "2019-01-01",
        "revision": 1,
        "product_price_list_prices": [
            "http://example.com"
        ]
    }
}

🟠404Record Not Found

🔴500Server Error

Request

Request samples

Responses