Inex API Documentation

ამანათის დეტალები

მიმდინარე სერვისით თქვენ შეძლებთ მიიღოთ ამანათის შესახებ ინფორმაცია თრექინგ ნომრის მიხედვით.

GET /integrators/parcels/detail/{waybillNumber}

Field	Type	In	Required	Example	Description
waybillNumber	string	PATH	Yes	YT72358DF03423452	ამანათის თრექინგ ნომერი.

პასუხის სტრუქტურა 200 OK

Attribute	Type	Example	Description
data.weight	integer	1551	ამანათის წონა გრამებში.
data.length	integer	318	ამანათის სიგანე მილიმეტრებში.
data.height	integer	684	ამანათის სიმაღლე მილიმეტრებში.
data.width	integer	489	ამანათის სიგრძე მილიმეტრებში.
data.status	string	disposed	ამანათის სტატუსი. შესაძლო ვარიანტები: created, received, pending, arrived, takeout, returned, confiscated, lost, dropOfDate, damaged, compensated, notCompensated, returnToSellerIsInProgress, disposed
data.senderCountry.name	string	United States	გამომგზავნი ქვეყნის სახელი ლათინურად.
data.senderCountry.code	string	US	გამომგზავნი ქვეყნის კოდი - ISO 3166-1 alpha-2.
data.receiverCity.name	string	Tbilisi	მიმღები ქალაქის სახელი ლათინურად.
data.receiverPickupLocation.name	string	Isani	მიმღები ფილიალის სახელი ლათინურად.
data.receiverPickupLocation.address	string	Isani, Atskuri Street #45	მიმღები ფილიალის მისამართი ლათინურად.
data.receiverPickupLocation.phone	string	(0322) 2222222	მიმღები ფილიალის ტელეფონის ნომერი.
data.receiverPickupLocation.latitude	float	56.961032	მიმღები ფილიალის კოორდინატი.
data.receiverPickupLocation.longitude	float	94.614571	მიმღები ფილიალის კოორდინატი.
data.receiverPickupLocation.postalCode	string	Isani	მიმღები ფილიალის საფოსტო ინდექსი.
data.waybillNumbers	array	[]	ამანათის თრექინგ კოდების მასივი.
data.waybillNumbers.*	string	eqweqwecwrekjewqionwqe.ewqe1eqq	ამანათის თრექინგ კოდი.

სტატუსების აღწერა

created	სისტემაში დამატებული.
received	საწყობში მიღებული.
pending	გამოგზავნილი.
arrived	ჩამოსული.
takeout	გატანილი.
returned	დაბრუნებული.
confiscated	ჩამორთმეული.
lost	დაკარგული.
dropOfDate	უცნობი.
damaged	დაზიანებული.
compensated	ანაზღაურებული.
notCompensated	არ ანაზღაურდება.
returnToSellerIsInProgress	სელერთან დაბრუნებსი პროცესში.
disposed	ამანათი გადაეცა სახელმწიფოს, შეუსაბამობის, დაზიანების ან მიმღების უმოქმედობის გამო.

შესაძლო პასუხები

Code	Description
200 OK	ამანათის ობიექტი.
404 Not Found	ამანათი მითითებული თრექინგ ნომრით არ მოიძებნა.
403 Forbidden	თქვენ არ გაქვთ ამ ოპერაციის შესრულების უფლება

cURL Request BASH

curl -X GET https://api-staging.inex.ge/api/v1/integrators/parcels/detail/YT72358DF03423452 \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json"

Response (200 OK)

JSON Response JSON

{
    "data": {
        "weight": 1551,
        "length": 318,
        "height": 684,
        "width": 489,
        "status": "disposed",
        "senderCountry": {
            "name": "United States",
            "code": "US"
        },
        "receiverCity": {
            "name": "Tbilisi"
        },
        "receiverPickupLocation": {
            "name": "Isani",
            "address": "Isani, Atskuri Street #45",
            "phone": "(0322) 2222222",
            "latitude": 56.961032,
            "longitude": 94.614571,
            "postalCode": "64691"
        },
        "waybillNumbers": [
            "eqweqwecwrekjewqionwqe.ewqe1eqq",
            "23311234.ewqe1eqq"
        ]
    }
}

Error Response (403)

JSON Response JSON

{
    "errors": {
        "general": [
            "You are not authorized to perform this action. Contact administrator."
        ]
    },
    "message": "error"
}

Error Response (404)

JSON Response JSON

{
    "errors": {
        "general": [
            "Requested parcel not found"
        ]
    },
    "message": "error"
}