Otpravka API Specification

https://otpravka.pochta.ru/specification
Admin
Otpravka is a REST API for Russian Post's online shipping service that enables integration with...
Tokens:3,962
Snippets:30
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Authentication

Source: https://otpravka.pochta.ru/specification

To interact with the API, you will need an application authorization token and a user authorization key. Ensure these are handled securely and not stored in plain text.

```APIDOC
## Authentication

### Description
Details on obtaining and using authentication credentials for the API.

### Required Credentials
- **Application Authorization Token**: Obtained for your application.
- **User Authorization Key**: Obtained for the specific user.

### Security Recommendations
- Do not store API tokens or keys in plain text files.
- Avoid writing down sensitive credentials on paper or other physical media.
- Do not share API credentials with third parties.
```

--------------------------------

### Returns API

Source: https://otpravka.pochta.ru/specification#/main

Manage return shipments, including creation, modification, and deletion.

```APIDOC
## Returns API

### Create Return Shipment for Existing Shipment
Creates a return shipment for a previously created shipment.

### Endpoint
POST /api/returns/shipment/{shipmentId}

### Create Separate Return Shipment
Creates an independent return shipment.

### Endpoint
POST /api/returns/separate-shipment

### Delete Separate Return Shipment
Removes an independent return shipment.

### Endpoint
DELETE /api/returns/separate-shipment/{returnShipmentId}

### Edit Separate Return Shipment
Modifies an independent return shipment.

### Endpoint
PUT /api/returns/separate-shipment/{returnShipmentId}
```

--------------------------------

### Authentication

Source: https://otpravka.pochta.ru/specification#/main

To interact with the API, you need an application authorization token and a user authorization key. Ensure secure handling of these credentials.

```APIDOC
## Authentication

### Description
Authentication is required for all API requests. You will need an application authorization token and a user authorization key.

### Required Credentials
- **Application Authorization Token**: Obtained through your application registration.
- **User Authorization Key**: Obtained through user authentication.

### Security Recommendations
- Do not store API credentials in plain text files.
- Avoid writing down or sharing sensitive authentication information.
```

--------------------------------

### Applications API

Source: https://otpravka.pochta.ru/specification#/main

Manage applications and their associated services.

```APIDOC
## Applications API

### Create Application for Additional Service
Submits an application for an additional service.

### Endpoint
POST /api/applications/additional-service
```

--------------------------------

### Settings API

Source: https://otpravka.pochta.ru/specification#/main

Retrieve current settings related to dispatch points and user preferences.

```APIDOC
## Settings API

### Get Current Dispatch Points
Retrieves information about the current dispatch points.

### Endpoint
GET /api/settings/dispatch-points

### Get Current User Settings
Retrieves the current settings for the authenticated user.

### Endpoint
GET /api/settings/user
```

--------------------------------

### API Endpoints Overview

Source: https://otpravka.pochta.ru/specification

This section outlines the various functionalities available through the API, categorized by their purpose.

```APIDOC
## API Endpoints Overview

### Orders
- Create Order
- Create Order (Version 2)
- Search Order
- Search Order by ID
- Edit Order
- Delete Order
- Return Orders to "New"
- Search Orders by Group ID

### Parcels
- Create Parcel from N Orders
- Change Dispatch Day to Post Office
- Move Orders to Parcel
- Search Parcel by Name
- Search Orders with SPPI
- Add Orders to Parcel
- Remove Orders from Parcel
- Request Order Data in Parcel
- Search All Parcels
- Search Order in Parcel by ID
- Search Orders by Group ID

### Documents
- Generate Documentation Package
- Generate Printed Form F7p
- Generate Printed Form F112EК
- Generate Printed Forms for Order (before parcel formation)
- Generate Printed Forms for Order
- Generate Printed Form F103
- Prepare and Send Electronic Form F103
- Generate Inspection Act
- Generate Return Label on One Printed Page

### Archive
- Request Data on Parcels in Archive
- Move Parcel to Archive
- Return Parcel from Archive

### Search Post Offices (OPS)
- By Index
- By Address
- Postal Services OPS
- Postal Services OPS by Service Group ID
- By Coordinates
- Search Indices in Locality
- Export from OPS Passport

### Time Slots
- Get List of Available Time Slots
- Book Time Slot
- Create Order
- Get List of Available Time Slots for Rebooking
- Book Rebooking
- Cancel Booking

### Long-Term Storage
- Request Data on Orders in Archive

### Returns
- Create Return Shipment for Previously Created Shipment
- Create Separate Return Shipment
- Delete Separate Return Shipment
- Edit Separate Return Shipment

### Settings
- Current Drop-off Points
- Current User Settings

### Data
- Normalize Address
- Normalize Full Name (FIO)
- Normalize Phone Number
- Calculate Shipping Cost
- Current API Request Count

### Applications
- Create Application for Additional Service
```

--------------------------------

### Documents API

Source: https://otpravka.pochta.ru/specification#/main

Generate various documents and documentation packages.

```APIDOC
## Documents API

### Generate Documentation Package
Creates a package of necessary documentation.

### Endpoint
POST /api/documents/package

### Generate Form F7p
Generates the printable form F7p.

### Endpoint
POST /api/documents/form-f7p

### Generate Form F112EК
Generates the printable form F112EК.

### Endpoint
POST /api/documents/form-f112ek

### Generate Order Forms (Before Parcel Formation)
Generates printable forms for an order before it is included in a parcel.

### Endpoint
POST /api/documents/order-forms/pre-parcel

### Generate Order Forms
Generates printable forms for an order.

### Endpoint
POST /api/documents/order-forms

### Generate Form F103
Generates the printable form F103.

### Endpoint
POST /api/documents/form-f103

### Prepare and Send Electronic Form F103
Prepares and sends the electronic form F103.

### Endpoint
POST /api/documents/electronic-form-f103

### Generate Inspection Act
Generates an act of inspection for the contents.

### Endpoint
POST /api/documents/inspection-act

### Generate Return Label
Generates a return label on a single printed page.

### Endpoint
POST /api/documents/return-label
```

--------------------------------

### Orders API

Source: https://otpravka.pochta.ru/specification#/main

Manage orders through various endpoints, including creation, retrieval, and modification.

```APIDOC
## Orders API

### Create Order
Creates a new order.

### Endpoint
POST /api/orders

### Create Order (Version 2)
Creates a new order using the second version of the API.

### Endpoint
POST /api/v2/orders

### Find Order
Retrieves a list of orders based on specified criteria.

### Endpoint
GET /api/orders

### Find Order by ID
Retrieves a specific order by its unique identifier.

### Endpoint
GET /api/orders/{orderId}

### Edit Order
Modifies an existing order.

### Endpoint
PUT /api/orders/{orderId}

### Delete Order
Removes an order.

### Endpoint
DELETE /api/orders/{orderId}

### Return Orders to 'New'
Resets the status of specified orders to 'New'.

### Endpoint
POST /api/orders/return-to-new

### Find Orders by Group ID
Retrieves orders associated with a specific group identifier.

### Endpoint
GET /api/orders/group/{groupId}
```

--------------------------------

### Testing API

Source: https://otpravka.pochta.ru/specification#/main

Endpoints and tools for testing API functionality.

```APIDOC
## Testing API

### Test and Normalize Address (SoapUI)
Provides functionality to test and normalize addresses, potentially using SoapUI.

### Endpoint
POST /api/testing/normalize-address

### Create Shipments via Chrome Extension
Allows creation of shipments using a Chrome browser extension.

### Endpoint
POST /api/testing/create-shipment-chrome
```

--------------------------------

### Data Processing API

Source: https://otpravka.pochta.ru/specification#/main

Utilize services for data normalization and cost calculation.

```APIDOC
## Data Processing API

### Normalize Address
Normalizes address data.

### Endpoint
POST /api/data/normalize/address

### Normalize Full Name
Normalizes full name (Last Name, First Name, Patronymic) data.

### Endpoint
POST /api/data/normalize/full-name

### Normalize Phone Number
Normalizes phone number data.

### Endpoint
POST /api/data/normalize/phone

### Calculate Shipping Cost
Calculates the cost of shipping based on provided details.

### Endpoint
POST /api/data/calculate/shipping-cost

### Get Current API Request Count
Retrieves the current count of API requests made.

### Endpoint
GET /api/data/request-count
```

--------------------------------

### Time Slots API

Source: https://otpravka.pochta.ru/specification#/main

Manage time slots for services, including booking and cancellation.

```APIDOC
## Time Slots API

### Get Available Time Slots
Retrieves a list of available time slots.

### Endpoint
GET /api/time-slots/available

### Book Time Slot
Books a selected time slot.

### Endpoint
POST /api/time-slots/book

### Create Order (Time Slot)
Forms an order related to a time slot booking.

### Endpoint
POST /api/time-slots/order

### Get Available Time Slots for Rebooking
Retrieves available time slots for rebooking an existing reservation.

### Endpoint
GET /api/time-slots/rebook/available

### Rebook Time Slot
Manages the rebooking of a time slot.

### Endpoint
POST /api/time-slots/rebook

### Cancel Booking
Cancels an existing booking.

### Endpoint
DELETE /api/time-slots/booking/{bookingId}
```

--------------------------------

### Shipping Cost Calculation

Source: https://otpravka.pochta.ru/specification

Calculate the estimated shipping cost for an item based on provided details.

```APIDOC
## Calculate Shipping Cost

### Description
Calculates the estimated cost for shipping an item.

### Method
POST

### Endpoint
/api/data/calculate/shipping_cost

### Request Body
- **weight** (number) - Required - The weight of the shipment in kilograms.
- **dimensions** (object) - Optional - The dimensions of the shipment.
  - **length** (number) - Required if dimensions are provided.
  - **width** (number) - Required if dimensions are provided.
  - **height** (number) - Required if dimensions are provided.
- **destination_address** (string) - Required - The destination address.
- **service_type** (string) - Optional - The type of shipping service (e.g., 'standard', 'express').

### Response
#### Success Response (200)
- **estimated_cost** (number) - The estimated shipping cost.
- **currency** (string) - The currency of the estimated cost.
```

--------------------------------

### Data Normalization

Source: https://otpravka.pochta.ru/specification

The API provides endpoints for normalizing various data types, ensuring consistency and accuracy in your requests.

```APIDOC
## Data Normalization Endpoints

### Normalize Address

### Description
Normalizes an address string to a standardized format.

### Method
POST

### Endpoint
/api/data/normalize/address

### Request Body
- **address** (string) - Required - The address string to normalize.

### Response
#### Success Response (200)
- **normalized_address** (string) - The normalized address.
- **quality_code** (integer) - Code indicating the quality of normalization.
- **validation_code** (integer) - Code indicating the validation result.

### Normalize Full Name (FIO)

### Description
Normalizes a full name string (First Name, Middle Name, Last Name).

### Method
POST

### Endpoint
/api/data/normalize/fio

### Request Body
- **fio** (string) - Required - The full name string to normalize.

### Response
#### Success Response (200)
- **normalized_fio** (string) - The normalized full name.
- **quality_code** (integer) - Code indicating the quality of normalization.

### Normalize Phone Number

### Description
Normalizes a phone number string to a standardized format.

### Method
POST

### Endpoint
/api/data/normalize/phone

### Request Body
- **phone** (string) - Required - The phone number string to normalize.

### Response
#### Success Response (200)
- **normalized_phone** (string) - The normalized phone number.
- **quality_code** (integer) - Code indicating the quality of normalization.
```

--------------------------------

### Long-Term Storage API

Source: https://otpravka.pochta.ru/specification#/main

Access data for orders stored long-term.

```APIDOC
## Long-Term Storage API

### Get Archived Order Data
Retrieves data for orders that are stored long-term.

### Endpoint
GET /api/long-term-storage/orders
```

--------------------------------

### Parcels API

Source: https://otpravka.pochta.ru/specification#/main

Manage parcels, including creation, modification, and searching for parcels and their contents.

```APIDOC
## Parcels API

### Create Parcel from Orders
Creates a new parcel containing a specified number of orders.

### Endpoint
POST /api/parcels/create-from-orders

### Change Dispatch Day
Modifies the dispatch day for a parcel to a post office.

### Endpoint
PUT /api/parcels/{parcelId}/dispatch-day

### Move Orders to Parcel
Transfers specified orders into an existing parcel.

### Endpoint
POST /api/parcels/{parcelId}/add-orders

### Find Parcel by Name
Searches for a parcel using its name.

### Endpoint
GET /api/parcels?name={parcelName}

### Find Orders with Tracking Code
Searches for orders within parcels using their tracking codes.

### Endpoint
GET /api/parcels/orders/tracking-code?trackingCode={trackingCode}

### Add Orders to Parcel
Adds orders to an existing parcel.

### Endpoint
POST /api/parcels/{parcelId}/orders

### Remove Orders from Parcel
Deletes orders from a parcel.

### Endpoint
DELETE /api/parcels/{parcelId}/orders/{orderId}

### Get Order Data in Parcel
Retrieves information about orders contained within a specific parcel.

### Endpoint
GET /api/parcels/{parcelId}/orders

### Find All Parcels
Retrieves a list of all available parcels.

### Endpoint
GET /api/parcels

### Find Order in Parcel by ID
Searches for a specific order within a parcel using its ID.

### Endpoint
GET /api/parcels/{parcelId}/orders/{orderId}

### Find Orders by Group ID
Retrieves orders associated with a specific group identifier within parcels.

### Endpoint
GET /api/parcels/group/{groupId}/orders
```

--------------------------------

### Archive API

Source: https://otpravka.pochta.ru/specification#/main

Manage archived parcels and retrieve data from the archive.

```APIDOC
## Archive API

### Get Archived Parcel Data
Retrieves data for parcels that are in the archive.

### Endpoint
GET /api/archive/parcels

### Move Parcel to Archive
Archives a specified parcel.

### Endpoint
POST /api/archive/parcels/{parcelId}/archive

### Restore Parcel from Archive
Restores a parcel from the archive.

### Endpoint
POST /api/archive/parcels/{parcelId}/restore
```

--------------------------------

### Post Office Search API

Source: https://otpravka.pochta.ru/specification#/main

Search for post offices based on various criteria.

```APIDOC
## Post Office Search API

### Search by Index
Finds post offices using a postal index.

### Endpoint
GET /api/post-offices/search/index?index={postalIndex}

### Search by Address
Finds post offices based on address information.

### Endpoint
GET /api/post-offices/search/address?address={addressQuery}

### Get Post Office Services
Retrieves information about post office services.

### Endpoint
GET /api/post-offices/services

### Get Post Office Services by Group ID
Retrieves post office services for a specific service group identifier.

### Endpoint
GET /api/post-offices/services/group/{groupId}

### Search by Coordinates
Finds post offices based on geographical coordinates.

### Endpoint
GET /api/post-offices/search/coordinates?lat={latitude}&lon={longitude}

### Find Indices in Locality
Searches for postal indices within a specific locality.

### Endpoint
GET /api/post-offices/indices?locality={localityName}

### Get Post Office Passport Data
Retrieves detailed data from a post office's passport.

### Endpoint
GET /api/post-offices/{postOfficeId}/passport
```
Tokens:
Raw