Page tree
Skip to end of metadata
Go to start of metadata

Zasób ShipmentTemplate reprezentuje obiekt serializowanego szablonu przesyłki w kontekście organizacji, która go utworzyła.

Na tej stronie

 

Uwierzytelnianie

Dostęp do zasobu wymaga podania prawidłowego i ważnego access tokenu.

Zasób ShipmentTemplate posiada następujące atrybuty:

AtrybutTypOpisDopuszczalne wartości
nameStringNazwa szablonu 
statusStringStatusactivated, suspended
descriptionStringOpis szablonu 
serialized_data
JSONzserializowany obekt przesylki Shipment (API Przesyłka [Shipment]) 
updated_at
DateTimeOstatnia aktualizacja profilu użytkownika. 
created_at
DateTimeData utworzenia profilu użytkownika. 

Przykład zasobu ShipmentTemplate w formacie JSON:

{
    "href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
    "id": 1,
    "organization_id": "1",
    "status": "activated",
    "description": "description...",
    "serialized_data": {...},
    "organization": { ... },
    "updated_at": "2015-09-29T15:22:00.000+02:00",
    "created_at": "2015-09-29T15:22:00.000+02:00"
}

Pobranie szablonu

Pobieranie informacji o określonym szablonie, do którego użytkownik ma dostęp:

GET /v1/shipment_templates/1

Przykład zapytania

curl https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H "Authorization: Bearer ..."

Odpowiedź

HTTP/1.1 200 OK
Content-Type: application/json

{
   "href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
   "id": 1,
   "status": "activated",
   "description": "(API Tests)",
   "name": "Inittec Sp. z o.o. ",
   "serialized_data": { ... },
   "organization": { ... },
   "created_at": "2016-03-22T09:31:28.609+01:00",
   "updated_at": "2016-03-22T09:31:28.609+01:00"
}

Informacje o błędach

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

  • resource_not_found - w przypadku gdy szablon nie istnieje lub użytkownik nie ma praw dostępu do określonej organizacji.

Lista szablonów

Lista szablonów w ramach określonej organizacji:

GET /v1/organizations/:organization_id/shipment_templates

Przykład zapytania

curl https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates -H "Authorization: Bearer ..."

Odpowiedź

HTTP/1.1 200 OK
Content-Type: application/json
 
{
    "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates",
    "count": 15,
    "per_page": 30,
    "page": 1,
    "items": [
        {
            "href": "https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates/123",
            "id": 123,
            ... other attribute omitted for brevity ....
        }
        ... other items omitted for brevity ...
    ]
}

Informacje o błędach

  • resource_not_found - organizacja, dla której użytkownik chce pobrać listę przesyłek nie istnieje lub nie ma do niej dostępu.

Dodawanie szablonu

Tworzenie nowego szablonu

POST /v1/organizations/1/shipment_templates

Parametry

ParametrTypOpisWalidacja
nameStringNazwa szablonu

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
statusStringStatus szablonu

Atrybut jest wymagany.

  • Dopuszczalne wartości (ACTIVATED, SUSPENDED)
descriptionStringOpis szablonu

Atrybut jest wymagany.

  • Maksymalnie 255 znaków
serialized_dataShipmentSerializowany obiekt ShipmentAtrybut jest wymagany.

Przykład zapytania

POST https://api-shipx-pl.easypack24.net/v1/organizations/1/shipment_templates
{
    "name":"template name", 
    "status":"suspended", 
    "description":"description...", 
    "serialized_data": {
        "receiver": {
            "email": "paczkomat@test.pl",
            "phone": "888000022"
        },
        "parcels": { "template": "small"}
    }
}

Odpowiedź

HTTP/1.1 200 OK
Content-Type: application/json
{
  "href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/6",
  "id": 6,
  "name": "non-active",
  "status": "suspended",
  "description": "description...",
  "organization": {
    ...
  },
  "template": {
    "status": "created",
    "service": null,
    "custom_attributes": {},
    "cod": {
      "amount": null,
      "currency": null
    },
    "insurance": {
      "amount": null,
      "currency": null
    },
    "additional_services": [],
    "reference": null,
    "is_return": false,
    "parcels": [
      {
        "id": null,
        "template": "small",
        "dimensions": {
          "length": 380,
          "width": 640,
          "height": 80,
          "unit": "mm"
        },
        "weight": {
          "amount": 25,
          "unit": "kg"
        },
        "tracking_number": null
      }
    ],
    "sender": null,
    "receiver": {
      "id": null,
      "name": null,
      "company_name": null,
      "first_name": null,
      "last_name": null,
      "email": "paczkomat@test.pl",
      "phone": "888000022",
      "address": null
    }
  },
  "created_at": "2016-10-04T12:43:37.454+02:00",
  "updated_at": "2016-10-04T12:43:37.454+02:00"
}

Informacje o błędach

  • validation_failed - dane przesłane metodą POST są niepoprawne. Szczegóły zawarte w odpowiedzi w polu details,
  • resource_not_found - organizacja, dla której użytkownik chce pobrać listę przesyłek nie istnieje lub nie ma do niej dostępu.

 

 

Usuwanie szablonu

Usuwanie istniejącego szablonu przypisanej do organizacji.

DELETE /v1/shipment_templates/1

Przykład zapytania

curl https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -H DELETE -H "Authorization: Bearer ..."

Odpowiedź

HTTP/1.1 204 NO_CONTENT
Content-Type: application/json

Informacje o błędach

  • resource_not_found - szablon, dla którego użytkownik chce pobrać listę przesyłek nie istnieje lub nie ma do niej dostępu.

 

 

Edycja szablonu

Tworzenie nowego szablonu

PUT /v1/shipment_templates/:template_id

Parametry

ParametrTypOpisWalidacja
nameStringNazwa szablonu

Atrybut nie jest wymagany.

  • Maksymalnie 255 znaków
statusStringStatus szablonu

Atrybut nie jest wymagany.

  • Dopuszczalne wartości (ACTIVATED, SUSPENDED
descriptionStringOpis szablonu

Atrybut nie jest wymagany.

  • Maksymalnie 255 znaków
serialized_dataShipmentZserializowany obiekt ShipmentAtrybut nie jest wymagany.

Przykład zapytania

curl https://api-shipx-pl.easypack24.net/v1/shipment_templates/1 -d '{"name":"szablon_1", "status":"activated", "description":"description...", "serialized_data": { ... } }' -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer ..."

Odpowiedź

HTTP/1.1 200 OK
Content-Type: application/json

{
   "href": "https://api-shipx-pl.easypack24.net/v1/shipment_templates/1",
   "id": 1,
   "status": "activated",
   "description": "(API Tests)",
   "name": "Inittec Sp. z o.o. ",
   "serialized_data": { ... },
   "organization": { ... },
   "created_at": "2016-03-22T09:31:28.609+01:00",
   "updated_at": "2016-03-22T09:31:28.609+01:00"
}

Informacje o błędach

  • validation_failed - dane przesłane metodą POST są niepoprawne. Szczegóły zawarte w odpowiedzi w polu details,
  • resource_not_found - szablon, dla którego użytkownik chce pobrać listę przesyłek nie istnieje lub nie ma do niej dostępu.
  • No labels