Gets the preset of the company by ID.

Gets information about the preset and the preset body.

HTTP Request

GET https://courier.yandex.ru/api/v1/reference-book/companies/{company_id}/presets/{preset_id}

Path Parameters

company_id *	integer The ID of the company whose presets you need to get.
preset_id *	string ID of the preset in the reference book.

* Required parameter

Responses

Code 200

Preset has been successfully returned.

{
  "body": {},
  "description": string,
  "history": {
    "created_at": string,
    "updated_at": string,
    "updated_by": string
  },
  "id": string,
  "number": string,
  "type": string
}
Copied to clipboard

Representation

Collapse all

Expand all

Fields

body	object The preset body is in the form of json, the schema must match the preset type.
description	string Description of the preset.
history	object
history.created_at	string The preset creation time in the format YYYY-MM-DDThh:mm:ssZ.
history.updated_at	string Preset update time in the format YYYY-MM-DDThh:mm:ssZ.
history.updated_by	string Who made the last changes.
id	string ID of the preset in the reference book.
number	string Preset number. Cannot start with public_ and contain a comma character.
type	string The type of preset. Allowed values depot location options vehicle vehicle-shift

* Required parameter

Code 401

Authorization error. Make sure that the request header contains the correct OAuth token.

Code 403

You do not have access to this object.

Code 422

Incorrect input. The preset is associated with some other company.

Code 500

Server error during request processing.