Skip to main content

iLogistic Orders (1.1.3)

iLogistic Orders

Orders

List orders

List all of your orders, optionally using limit/offset for pagination.

Authorizations:
bearerAuth
query Parameters
limit
integer <int64>

Number of items to list.

offset
integer <int64>

Number of items to be skipped.

state
string

Filter for orders based on their state. Accepted values are the available order states with url encoding.

paymentMethod
string

Filter for orders based on their payment method. Accepted values are the available order payment methods with url encoding.

deliveryCompany
string

Filter for orders based on their shipping method. Accepted values are the available order shipping methods with url encoding.

source
string

Filter for orders based on their source.

changedSince
string

Filter for orders based on the time of it's most recent state change event. Accepted values are date time strings defined as ISO-8601 (ex. 2023-01-12T12:45:57 ).

isCompletable
boolean

Filter for completable orders.

Responses

Response samples

Content type
application/json
[
  • {
    • "id": 54379,
    • "source": "Internal API",
    • "state": "Jóváhagyva",
    • "parcelNumber": "322316421",
    • "isCompletable": false,
    • "delivery": {
      • "name": "Teszt Elek",
      • "email": "[email protected]",
      • "phoneNumber": "+36701234567",
      • "country": "HU",
      • "postCode": "1234",
      • "city": "Budapest",
      • "address": "Petőfi Sándor u. 4.",
      • "company": "GLS",
      • "aptNumber": "GLS-123g31G"
      },
    • "billing": {
      • "name": "Teszt Elek",
      • "email": "[email protected]",
      • "phoneNumber": "+36701234567",
      • "country": "HUN",
      • "postCode": "1234",
      • "city": "Budapest",
      • "address": "Petőfi Sándor u. 4."
      },
    • "payment": {
      • "type": "Utánvétes fizetés",
      • "cost": 1000
      },
    • "content": [
      • {
        • "productId": 126445,
        • "serialNumbers": [
          • "5998900130062",
          • "5998900130063"
          ],
        • "productName": "Teszt Sajt",
        • "itemNumber": "00149978438",
        • "quantity": 2
        }
      ],
    • "foreignId": "I-24532"
    }
]

Create order

Create a new order.

Authorizations:
bearerAuth
header Parameters
X-WebShop-Alias
string
Example: mywebshop.com

Alias of the webshop where the order is coming from.

Request Body schema: application/json
object
name
string <= 50 characters

Receiver first and last name

email
string <= 50 characters

Enter delivery email

phoneNumber
string <= 50 characters

The phone number must start with +36

country
string <= 50 characters

Name of the country, accepted formats: hungarian name, ISO 3166 Alpha 2 and ISO 3166 Alpha 3

postCode
string <= 50 characters

The appropriate postcode for your country and city, can be up to 50 characters long

city
string <= 50 characters

Name of the city to be transported

address
string <= 255 characters

The address of the buyer where the order can be delivered in case of home delivery.

company
string
Enum: "GLS" "Foxpost" "Személyes átvétel" "MPL" "DHL" "Raklapos szállítás" "iLogistic csomagpont" "Pactic Elsődleges" "Pactic Másodlagos" "Express One" "Express One raklapos" "Sprinter"

Ordering methods,One order method must be selected

aptNumber
string or null <= 50 characters

ID number of the selected parcel locker

object
name
string <= 50 characters

The name in whose name the invoice is made

email
string <= 50 characters

Billing email address

phoneNumber
string <= 50 characters

Customer's phone number,The phone number must start with +36

country
string <= 50 characters

Name of the country, accepted formats: hungarian name, ISO 3166 Alpha 2 and ISO 3166 Alpha 3

postCode
string <= 50 characters

The postcode of the city on the bill

city
string <= 50 characters

The name of the city on the invoice

address
string <= 255 characters

The name of the street on your invoice,name of public area and the street number

object
type
string <= 50 characters
Enum: "Utánvétes fizetés" "Bankkártyás fizetés" "Átutalásos fizetés"

Choose the type of payment,Only one piece can be selected

cost
number <float>

The number will be rounded to two decimal values

Array of objects
Array
itemNumber
string

Product identifier

quantity
integer

Quantity,How many pieces of a given product have been fitted

foreignId
string or null

Foreing ID given by user

Responses

Request samples

Content type
application/json
{
  • "delivery": {
    • "name": "Teszt Elek",
    • "email": "[email protected]",
    • "phoneNumber": "+36701234567",
    • "country": "HU",
    • "postCode": "1234",
    • "city": "Budapest",
    • "address": "Petőfi Sándor u. 4.",
    • "company": "GLS",
    • "aptNumber": "GLS-123g31G"
    },
  • "billing": {
    • "name": "Teszt Elek",
    • "email": "[email protected]",
    • "phoneNumber": "+36701234567",
    • "country": "HUN",
    • "postCode": "1234",
    • "city": "Budapest",
    • "address": "Petőfi Sándor u. 4."
    },
  • "payment": {
    • "type": "Utánvétes fizetés",
    • "cost": 1000
    },
  • "content": [
    • {
      • "itemNumber": "00149978438",
      • "quantity": 2
      }
    ],
  • "foreignId": "I-24532"
}

Response samples

Content type
application/json
{
  • "id": 62
}

Get order

Get a single order by its id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

ID of the order.

Responses

Response samples

Content type
application/json
{
  • "id": 54379,
  • "source": "Internal API",
  • "state": "Jóváhagyva",
  • "parcelNumber": "322316421",
  • "isCompletable": false,
  • "delivery": {
    • "name": "Teszt Elek",
    • "email": "[email protected]",
    • "phoneNumber": "+36701234567",
    • "country": "HU",
    • "postCode": "1234",
    • "city": "Budapest",
    • "address": "Petőfi Sándor u. 4.",
    • "company": "GLS",
    • "aptNumber": "GLS-123g31G"
    },
  • "billing": {
    • "name": "Teszt Elek",
    • "email": "[email protected]",
    • "phoneNumber": "+36701234567",
    • "country": "HUN",
    • "postCode": "1234",
    • "city": "Budapest",
    • "address": "Petőfi Sándor u. 4."
    },
  • "payment": {
    • "type": "Utánvétes fizetés",
    • "cost": 1000
    },
  • "content": [
    • {
      • "productId": 126445,
      • "serialNumbers": [
        • "5998900130062",
        • "5998900130063"
        ],
      • "productName": "Teszt Sajt",
      • "itemNumber": "00149978438",
      • "quantity": 2
      }
    ],
  • "foreignId": "I-24532"
}

Get resent orders new id

Get a single resent order's new id by its old id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

ID of the order.

Responses

Response samples

Content type
application/json
{
  • "status": "resend",
  • "newOrderId": "24532"
}

Modify order

Update an order by id, only the updatable fields should be present. Orders cannot be modified after it has been in "Összekészítés alatt" state.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

ID of the order.

Request Body schema: application/json
object
name
string <= 50 characters

Receiver first and last name

email
string <= 50 characters

Enter delivery email

phoneNumber
string <= 50 characters

The phone number must start with +36

country
string <= 50 characters

Name of the country, accepted formats: hungarian name, ISO 3166 Alpha 2 and ISO 3166 Alpha 3

postCode
string <= 50 characters

The appropriate postcode for your country and city, can be up to 50 characters long

city
string <= 50 characters

Name of the city to be transported

address
string <= 255 characters

The address of the buyer where the order can be delivered in case of home delivery.

company
string
Enum: "GLS" "Foxpost" "Személyes átvétel" "MPL" "DHL" "Raklapos szállítás" "iLogistic csomagpont" "Pactic Elsődleges" "Pactic Másodlagos" "Express One" "Express One raklapos" "Sprinter"

Ordering methods,One order method must be selected

aptNumber
string or null <= 50 characters

ID number of the selected parcel locker

object
name
string <= 50 characters

The name in whose name the invoice is made

email
string <= 50 characters

Billing email address

phoneNumber
string <= 50 characters

Customer's phone number,The phone number must start with +36

country
string <= 50 characters

Name of the country, accepted formats: hungarian name, ISO 3166 Alpha 2 and ISO 3166 Alpha 3

postCode
string <= 50 characters

The postcode of the city on the bill

city
string <= 50 characters

The name of the city on the invoice

address
string <= 255 characters

The name of the street on your invoice,name of public area and the street number

object
type
string <= 50 characters
Enum: "Utánvétes fizetés" "Bankkártyás fizetés" "Átutalásos fizetés"

Choose the type of payment,Only one piece can be selected

cost
number <float>

The number will be rounded to two decimal values

Array of objects
Array
itemNumber
string

Product identifier

quantity
integer

Quantity,How many pieces of a given product have been fitted

Responses

Request samples

Content type
application/json
{
  • "delivery": {
    • "name": "Teszt Elek",
    • "email": "[email protected]",
    • "phoneNumber": "+36701234567",
    • "country": "HU",
    • "postCode": "1234",
    • "city": "Budapest",
    • "address": "Petőfi Sándor u. 4.",
    • "company": "GLS",
    • "aptNumber": "GLS-123g31G"
    },
  • "billing": {
    • "name": "Teszt Elek",
    • "email": "[email protected]",
    • "phoneNumber": "+36701234567",
    • "country": "HUN",
    • "postCode": "1234",
    • "city": "Budapest",
    • "address": "Petőfi Sándor u. 4."
    },
  • "payment": {
    • "type": "Utánvétes fizetés",
    • "cost": 1000
    },
  • "content": [
    • {
      • "itemNumber": "00149978438",
      • "quantity": 2
      }
    ]
}

Response samples

Content type
application/json
{
  • "id": 62
}

Delete order

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

ID of the order.

Responses

Response samples

Content type
application/json
{
  • "id": 62
}