In order to fill out the order form, you need to get the directories. To do this, execute the following requests:
POST https://info.gpid.ru/api/ProductCategories
: Get a directory of product categories.
POST https://info.gpid.ru/api/CarBodyTypes
: Get a directory of body types.
POST https://info.gpid.ru/api/UnloadingTypes
: Get a directory of loading and unloading types.
POST https://info.gpid.ru/api/VatRatesTypes
: Get a directory of taxation types.
Response parameters
Parameter |
Type |
Value |
id |
string |
ID |
title |
string |
Name |
Getting data about the organization
Execute the following HTTP request:
Request Parameters
Parameter |
Type |
Value |
Mandatory |
type |
int |
Organization type: 1 — Customer, 2 — Shipper, 3 — Consignee |
Yes |
parentId |
int |
Organization ID. For the Customer, it is an empty value. For the Shipper and Consignee, it is the ID of the selected Customer. |
Yes |
Response parameters
Parameter |
Type |
Value |
isSuccess |
boolean |
Whether the request is successful |
message |
string |
Error information |
entity |
object |
Organization information |
Parameters nested in entity
Parameter |
Type |
Value |
id |
string |
Organization ID |
type |
int |
Organization type: legal entity — 0, individual entrepreneur — 1, individual — 2 |
name |
string |
Name of the legal entity |
inn |
string |
TIN (Taxpayer Identification Number) |
firstName |
string |
First name |
middleName |
string |
Patronymic |
lastName |
string |
Last name |
address |
string |
Address |
Getting a list of organizations on behalf of which an order can be created in the system
Execute the following HTTP request:
Response parameters
Parameter |
Type |
Value |
isSuccess |
boolean |
Whether the request is successful |
message |
string |
Error information |
entity |
object |
List of organizations |
Parameters nested in entity
Parameter |
Type |
Value |
id |
string |
Organization ID |
type |
int |
Organization type |
name |
string |
Name of the legal entity |
inn |
string |
TIN (Taxpayer Identification Number) |
firstName |
string |
First name |
middleName |
string |
Patronymic |
lastName |
string |
Last name |
address |
string |
Address |
Getting address data
Execute the following HTTP request:
Request Parameters
Parameter |
Type |
Value |
Mandatory |
orgId |
int |
Organization ID: For Loading — a selected Shipper, for Unloading — a selected Consignee |
Yes |
type |
int |
1 — Loading, 2 — Unloading |
Yes |
Response parameters
Parameter |
Type |
Value |
isSuccess |
boolean |
Whether the request is successful |
message |
string |
Error information |
entity |
object |
List of organizations |
Parameters nested in entity
Parameter |
Type |
Value |
fullAddress |
string |
Address |
country |
string |
Country |
locality |
string |
Locality |
kladr |
string |
Kladr (russian address classifier) |
postalCode |
string |
Postal code |
apartment |
string |
Apartment |
building |
string |
Building |
house |
string |
House |
housing |
string |
Land plot |
region |
string |
Region |
street |
string |
Street |
kladrRegion |
string |
KLADR region |
geoId |
string |
Address ID. Default value is 0 |
Execute the following HTTP request:
Request Parameters
Parameter |
Type |
Value |
Mandatory |
orgId |
int |
Organization ID: Shipper or Consignee |
Yes |
Response parameters
Parameter |
Type |
Value |
isSuccess |
boolean |
Whether the request is successful |
message |
string |
Error information |
entity |
object |
List of organizations |
Parameters nested in entity
Parameter |
Type |
Value |
phone |
string |
Phone number |
firstName |
string |
First name |
lastName |
string |
Last name |
middleName |
string Patronymic or middle name |
|
additional |
string |
Additional phone number |
Getting a list of organizations for forwarding
Execute the following HTTP request:
Request Parameters
Parameter |
Type |
Value |
Mandatory |
orderType |
int |
Organization type for forwarding: 0 — Forwarders and carriers, 1 — Forwarders, 2 — Carriers |
Yes |
executorLineClientId |
string |
ID of the organization selected from organizations-executors |
Yes |
searchQuery |
string |
Organization search string |
Yes |
onlyPartners |
boolean |
Partners only |
Yes |
Response parameters
Parameter |
Type |
Value |
id |
string |
Organization ID |
title |
string |
Organization name |
inn |
string |
Company's Taxpayer ID |
corporation |
LookupItem |
Corporation where the organization is registered |
genContractId |
string |
ID of the master contract |
Parameters nested in LookupItem
Parameter |
Type |
Value |
id |
string |
Key |
title |
string |
Name |
Support service