Versions Compared

Old Version 2

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Zasób Batch słuzy do tworzenia i podglądu wielu przesyłek. W trybie asynchronicznym po walidacji każda przesyłka procesuje sie się w osobnym wątku, a co za tym idzie informacje zwrotne sa są wysyłane na WebHooki dla każdej przesyłki z osobna.

PanelbgColor#f0f0f0titleBGColor#f0f0f0

title

Na tej stronie

Table of Contents
minLevel2
 

Struktura

Zasób Batch

 posiada

 posiada następujące atrybuty:

Atrybut

Typ

Opis

id

Integer

Id obiektu

status

String

Status przetwarzania przesyłek

shipments

Array[Shipment]

Przesyłki

created_at

DateTime

Data utworzenia

updated_at

DateTime

 

Data aktualizacji

Przykład zasobu Batch w formacie JSON:

Code Block
languagejson
{
  "href": "https://api-shipx-pl.easypack24.net/v1/batches/16",
  "id": 16,
  "status": "done",
  "shipments": [
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/151",
      "id": 151,
      "status": "confirmed",
      "tracking_number": "633100159730624319900067"
    },
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/150",
      "id": 150,
      "status": "confirmed",
	  "tracking_number": "633100159730624319900068"
    }
  ],
  "created_at": "2017-06-08T14:17:25.675+02:00",
  "updated_at": "2017-06-08T14:17:25.675+02:00"
}

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i aktualnego access tokenu.

Tworzenie wielu przesyłek

Info
title
Uwaga! Klienci debetowi

Po utworzeniu przesyłki

,

nie zwracamy cen dla klientów debetowych.
Atrybut rate przyjmuje wartość null

Code Block
Tworzenie wielu przesyłek
language
code
json
POST /v1/organizations/:organization_id/batches

Parametry

Parametr

Typ

Opis

Walidacja

only_choice_of_offer

Boolean

Ustawienie parametru na true powoduje, że oferta we wszystkich przesyłkach zostanie wybrana dla podanego serwisu, ale nie zostanie automatycznie opłacona.
Taka przesyłkę trzeba opłacić przed końcem wygaśnięcia oferty wykonując operacje (Opłacanie przesyłki).
Parametr ten można ustawić również dla każdej przesyłki z osobna (w takim przypadku parametr ustawiony w przesyłce ma wyższy priorytet).

Atrybut nie jest wymagany.

  • Defoultowa wartość false

shipments

Array[Hash]

Atrybut nie jest wymagany.

  • Minimum 1

  • Maksimum 2500

Parametry zasobu shipments

Parametr

Type

Opis

id

String

Wymagany. Unikalny identyfikator danej przesyłki, który pozwala zwrócić użytkownikowi informację o błędach walidacji przypisanych do konkretnej przesyłki. Id nie jest zapisywany w bazie danych i nie jest zwracany jak atrybut utworzonej przesyłki.

...

...

Pozostałe parametry przesyłki uproszczonej opisane na

Uproszczone tworzenie przesyłki

Atrybut nie jest wymagany.

  • Minimum 1
  • Maksimum 2500

stronie

[1.9.0] Tworzenie przesyłki w trybie uproszczonym

Przykład zapytania

Code Block
languagejson
curl -X POST https://api-shipx-pl.easypack24.net/v1/organizations/1/batches -H 'Authorization: Bearer token' -H 'content-type: application/json' -d '{ 
  "only_choice_of_offer": false,
  "shipments": [
    {
      "id": 1,
      "service": "inpost_locker_standard",
"reference": "Test",

      "custom_attributes": {
        "target_point": "
KRA012
KRA010"
      },
      "parcels":{
        "template": "small"
      },
      "receiver": {
"name": "Name",

        "company_name": "Company name 1",
"first_name": "Jan", "last_name": "Kowalski",

        "email": "
receiver@example
sklep@inpost.
com
pl",
        "phone": "
888000000
888888888",
        "address": {
          "
street
line1": "
Cybernetyki
Zawila 65L",
"building_number": "10",

          "city": "
Warszawa
Krakow",
          "post_code": "
02
30-
677
390",
          "country_code": "PL"
        }
      },
      "sender": {
       "company_name": "
Nazwa
Company name 2",
"company_name
    "email": "
InPost S.A.", "first_name
sklep@inpost.pl",
        "phone": "
Jan
999999999",
"last_name

        "address": {
          "line1": "
Nowak
Zawila 65L",
"email
      "city": "
sender@email.com
Krakow",
          "
phone
post_code": "
888000000
30-390",
"address": { "street

          "country_code": "
Malborska", "building_number": "130", "city
PL"
        }
      },
      "cod": {
        "amount": 1,
        "currency": "
Kraków", "post_code": "30-624", "country_code
PLN"
      },
      "insurance": {
        "amount": 23,
        "currency": "
PL
PLN"
      }
}
  },
    {
      "id": 2,
      "service": "inpost_locker_standard",
"reference": "Test",
      "custom_attributes": {
        "target_point": "
KRA012"
KRA010"
      },
      "parcels":{
        "template": "small"
      },
      "receiver": {
"name": "Name",

        "company_name": "Company name 1",
"first_name": "Jan", "last_name": "Kowalski",

        "email": "
receiver@example
sklep@inpost.
com
pl",
        "phone": "
888000000
888888888",
        "address": {
          "
street
line1": "
Cybernetyki
Zawila 65L",
"building_number": "10",

          "city": "
Warszawa
Krakow",
          "post_code": "
02
30-
677
390",
          "country_code": "PL"
        }
      },
      "sender": {
       "company_name": "
Nazwa
Company name 2",
"company_name
    "email": "
InPost S.A.", "first_name
sklep@inpost.pl",
        "phone": "
Jan
999999999",
"last_name
    "address": {
          "line1": "
Nowak
Zawila 65L",
"email
      "city": "
sender@email.com
Krakow",
          "
phone
post_code": "
888000000
30-390",
"address": { "street

          "country_code": "
Malborska", "building_number": "130", "city
PL"
        }
      },
      "cod": {
        "amount": 1,
        "currency": "
Kraków", "post_code": "30-624", "country_code
PLN"
      },
      "insurance": {
        "amount": 23,
        "currency": "
PL
PLN"
      }
    }
}
 ]
}'

Odpowiedź

Code Block
languagejson
HTTP/1.1 201 Created
Content-Type: application/json
{
  "href": "https://api-shipx-pl.easypack24.net/v1/batches/
1672310
35",
  "id":
1672310
35,
  "status": "in_progress",
  "shipments": [
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/195",
      "id": 195,
      "status": "confirmed",
      "tracking_number": "520000017830390003337439"
    },
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/195",
      "id": 195,
      "status": "offer_selected",
      "tracking_number": "520000017830390003337439"
    },
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/196",
      "id": 196,
      "status": "create",
      "tracking_number": null
    }
  ],
  "created_at": "
2021
2017-
08
06-
11T12
12T14:
58
19:
40
20.
579
432+02:00",
  "updated_at": "
2021
2017-
08
06-
11T12
12T14:
58
19:
40
20.
579
432+02:00"
}
Warning

Informacje o błędach

 Serwer może zwrócić następujące błędy

  • validation_failed - błąd walidacji 

    forbidden - akcja jest niedostępna dla podanego tokenu

  • token_invalid - użytkownik nie ma praw dostępu do określonej organizacji

Podgląd wielu przesyłek

Code Block
languagejson
GET /v1/batches/:id

Przykład zapytania

Code Block
languagejson
curl -X GET https://api-shipx-pl.easypack24.net/v1/batches/16 -H 'Authorization: Bearer token' -H 'content-type: application/json'

Odpowiedź

Code Block
languagejson
HTTP/1.1 200 OK
Content-Type: application/json
{
  "href": "https://api-shipx-pl.easypack24.net/v1/batches/16",
  "id": 16,
  "status": "done",
  "shipments": [
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/151",
      "id": 151,
      "status": "confirmed",
      "tracking_number": "633100159730624319900067"
    },
    {
      "href": "https://api-shipx-pl.easypack24.net/v1/shipments/150",
      "id": 150,
      "status": "confirmed",
      "tracking_number": "633100159730624319900068"
    }
  ],
  "created_at": "2017-06-08T14:17:25.675+02:00",
  "updated_at": "2017-06-08T14:17:25.675+02:00"
}
Warning

Informacje o błędach

 

Serwer może zwrócić następujące błędy

  • resource_not_found - w przypadku gdy batch nie istnieje

  • token_invalid - użytkownik nie ma praw dostępu do określonej organizacji