[1.23.0] Services

Created by anagorski
May 14, 2021

Warning!

The resource is available only in the following countries: PL, IT

List of services for the Organization. Currently available services for a given country can be found at: Shipment sizes and services


On this page

 

Structure

The Service resource has the following attributes:

AttributeTypeDescriptionAvailability
idStringUnique service identifier.PL, IT
nameStringService name.PL, IT
descriptionStringService description.PL, IT
additional_servicesArray

List of available additional services. The additional_services object has the following attributes:

AttributeTypeDescription
idStringUnique identifier.
nameStringName.
descriptionStringDescription.
PL, IT

An example of a resource in JSON:

{
    "id":"inpost_courier_standard",
    "name":"Kurier Standard",
    "description":"Przesyłka kurierska standardowa.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"sms",
        "name":"Serwis SMS",
        "description":"Powiadomienie o przesyłce via SMS."
      },{
        "id":"email",
        "name":"Serwis e-mail",
        "description":"Powiadomienie o przesyłce via e-mail."
      },{
        "id":"saturday",
        "name":"Doręczenie sobota",
        "description":"Doręczenie przesyłki w sobotę."
      },{
        "id":"dor1720",
        "name":"Doręczenie od 17",
        "description":"Doręczenie pomiędzy 17:00 a 20:00 obejmuje doręczenie przesyłki do Odbiorcy w dni robocze w godzinach wieczornych pomiędzy 17:00 a 20:00"
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  }


Authentication

Access to the resource does not require authentication.



Services list

Returns list of all services handled by ShipX.

GET /v1/services

Request example

curl -X GET https://api-shipx-pl.easypack24.net/v1/services -H 'Content-Type: application/json'

Response

HTTP/1.1 200 OK 
Content-Type: application/json
[
  {
    "id":"inpost_locker_standard",
    "name":"Paczkomatowa Standardowa",
    "description":"Przesyłka paczkomatowa standardowa.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },
      {
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      }
    ]
  },
  {
    "id":"inpost_locker_allegro",
    "name":"AllePaczka",
    "description":"Przesyłka paczkomatowa Allegro Paczkomaty InPost.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },
      {
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      }
    ]
  },
  {
    "id":"inpost_courier_palette",
    "name":"Paleta Standard",
    "description":"Przesyłka kurierska Paleta Standard",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"sms",
        "name":"Serwis SMS",
        "description":"Powiadomienie o przesyłce via SMS."
      },{
        "id":"email",
        "name":"Serwis e-mail",
        "description":"Powiadomienie o przesyłce via e-mail."
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_allegro",
    "name":"Allegro Kurier",
    "description":"Przesyłka kurierska Allegro Kurier InPost.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      }
    ]
  },
  {
    "id":"inpost_courier_standard",
    "name":"Kurier Standard",
    "description":"Przesyłka kurierska standardowa.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"sms",
        "name":"Serwis SMS",
        "description":"Powiadomienie o przesyłce via SMS."
      },{
        "id":"email",
        "name":"Serwis e-mail",
        "description":"Powiadomienie o przesyłce via e-mail."
      },{
        "id":"saturday",
        "name":"Doręczenie sobota",
        "description":"Doręczenie przesyłki w sobotę."
      },{
        "id":"dor1720",
        "name":"Doręczenie od 17",
        "description":"Doręczenie pomiędzy 17:00 a 20:00 obejmuje doręczenie przesyłki do Odbiorcy w dni robocze w godzinach wieczornych pomiędzy 17:00 a 20:00"
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_express_1000",
    "name":"Kurier Doręczenie 10:00",
    "description":"Przesyłka kurierska z doręczeniem do godziny 10:00 następnego dnia.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"sms",
        "name":"Serwis SMS",
        "description":"Powiadomienie o przesyłce via SMS."
      },{
        "id":"email",
        "name":"Serwis e-mail",
        "description":"Powiadomienie o przesyłce via e-mail."
      },{
        "id":"saturday",
        "name":"Doręczenie sobota",
        "description":"Doręczenie przesyłki w sobotę."
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_express_1200",
    "name":"Kurier Doręczenie 12:00",
    "description":"Przesyłka kurierska z doręczeniem do godziny 12:00 następnego dnia.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"sms",
        "name":"Serwis SMS",
        "description":"Powiadomienie o przesyłce via SMS."
      },{
        "id":"email",
        "name":"Serwis e-mail",
        "description":"Powiadomienie o przesyłce via e-mail."
      },{
        "id":"saturday",
        "name":"Doręczenie sobota",
        "description":"Doręczenie przesyłki w sobotę."
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_express_1700",
    "name":"Kurier Doręczenie 17:00",
    "description":"Przesyłka kurierska z doręczeniem do godziny 17:00 następnego dnia.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."},{"id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."},{"id":"sms",
        "name":"Serwis SMS",
        "description":"Powiadomienie o przesyłce via SMS."},{"id":"email",
        "name":"Serwis e-mail",
        "description":"Powiadomienie o przesyłce via e-mail."},{"id":"saturday",
        "name":"Doręczenie sobota",
        "description":"Doręczenie przesyłki w sobotę."},{"id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_local_standard",
    "name":"Kurier Lokalny Standard",
    "description":"Przesyłka kurierska Lokalna Standardowa",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_local_express",
    "name":"Kurier Lokalny Express",
    "description":"Przesyłka kurierska Lokalna Expresowa",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_courier_local_super_express",
    "name":"Kurier Lokalny Super Express",
    "description":"Przesyłka kurierska Lokalna Super Expresowa",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      },{
        "id":"cod",
        "name":"Pobranie",
        "description":"Pobranie za przesyłkę."
      },{
        "id":"rod",
        "name":"Zwrot dokumentów",
        "description":"Zwrot dokumentów"
      }
    ]
  },
  {
    "id":"inpost_letter_allegro",
    "name":"Minipaczka Allegro InPost",
    "description":"Przesyłka listowa Minipaczka Allegro InPost.",
    "additional_services":[
      {
        "id":"insurance",
        "name":"Ubezpieczenie",
        "description":"Ubezpieczenie przesyłki."
      }
    ]
  }
]