iLogistic Orders (1.1.3)
iLogistic Orders
List orders
List all of your orders, optionally using limit/offset for pagination.
Authorizations:
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
- 200
- 400
- 401
[- {
- "id": 54379,
- "source": "Internal API",
- "state": "Jóváhagyva",
- "parcelNumber": "322316421",
- "isCompletable": false,
- "delivery": {
- "name": "Teszt Elek",
- "phoneNumber": "+36701234567",
- "country": "HU",
- "postCode": "1234",
- "city": "Budapest",
- "address": "Petőfi Sándor u. 4.",
- "company": "GLS",
- "aptNumber": "GLS-123g31G"
}, - "billing": {
- "name": "Teszt Elek",
- "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:
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 | |||||||||||||||||||
| |||||||||||||||||||
object | |||||||||||||||||||
| |||||||||||||||||||
object | |||||||||||||||||||
| |||||||||||||||||||
Array of objects | |||||||||||||||||||
Array
| |||||||||||||||||||
foreignId | string or null Foreing ID given by user |
Responses
Request samples
- Payload
{- "delivery": {
- "name": "Teszt Elek",
- "phoneNumber": "+36701234567",
- "country": "HU",
- "postCode": "1234",
- "city": "Budapest",
- "address": "Petőfi Sándor u. 4.",
- "company": "GLS",
- "aptNumber": "GLS-123g31G"
}, - "billing": {
- "name": "Teszt Elek",
- "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
- 201
- 400
- 401
{- "id": 62
}
Get order
Get a single order by its id.
Authorizations:
path Parameters
id required | integer <int64> ID of the order. |
Responses
Response samples
- 200
- 401
- 404
{- "id": 54379,
- "source": "Internal API",
- "state": "Jóváhagyva",
- "parcelNumber": "322316421",
- "isCompletable": false,
- "delivery": {
- "name": "Teszt Elek",
- "phoneNumber": "+36701234567",
- "country": "HU",
- "postCode": "1234",
- "city": "Budapest",
- "address": "Petőfi Sándor u. 4.",
- "company": "GLS",
- "aptNumber": "GLS-123g31G"
}, - "billing": {
- "name": "Teszt Elek",
- "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"
}
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:
path Parameters
id required | integer <int64> ID of the order. |
Request Body schema: application/json
object | |||||||||||||||||||
| |||||||||||||||||||
object | |||||||||||||||||||
| |||||||||||||||||||
object | |||||||||||||||||||
| |||||||||||||||||||
Array of objects | |||||||||||||||||||
Array
|
Responses
Request samples
- Payload
{- "delivery": {
- "name": "Teszt Elek",
- "phoneNumber": "+36701234567",
- "country": "HU",
- "postCode": "1234",
- "city": "Budapest",
- "address": "Petőfi Sándor u. 4.",
- "company": "GLS",
- "aptNumber": "GLS-123g31G"
}, - "billing": {
- "name": "Teszt Elek",
- "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
- 202
- 400
- 401
- 404
- 409
{- "id": 62
}