Skip to main content

iLogistic Inward Handling (1.0.2)

iLogistic Inward Handling

inward-handling

List shipments

List all of your shipments, 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 inward handlings based on their state. Accepted values are the available inward handling states with url encoding.

hasArrived
boolean

Filter for inward handlings based on whether the inward handlings have arrived yet. Accepted values are 0 (as not arrived yet) or 1 (as already arrived).

arrivedSince
string

Filter for inward handlings based on the time of it's completion. Accepted values are date time strings defined as ISO-8601 (ex. 2023-01-12T12:45:57 ).

Responses

Response samples

Content type
application/json
[
  • {
    • "id": 2367,
    • "name": "Szótárak beszállítás",
    • "status": "Várható",
    • "estimatedArrival": "2021-05-28 12:48:12",
    • "actualArrival": "2021-05-28 14:12:54",
    • "hasArrived": false,
    • "urgent": false,
    • "express": false,
    • "description": "Ebben a beszállításban angol-magyar szótárak érkeznek.",
    • "warehouse": 204,
    • "contents": [
      • {
        • "itemNumber": "frozen-pumpkin-01",
        • "estimated": 2,
        • "received": 2,
        • "serialNumbers": [
          • "fppk-001"
          ]
        }
      ]
    }
]

Create shipment

Create a new shipment.

Authorizations:
bearerAuth
Request Body schema: application/json
name
string [ 3 .. 50 ] characters
estimatedArrival
string or null <date>
urgent
boolean

Indicates if the shipment is urgent.

express
boolean

Indicates if the shipment is express.

description
string <= 255 characters

Short description.

warehouse
integer <int32>
Deprecated
Enum: 204 153

DEPRECATED This field is no longer used, we always use your comapny's warehouse information.

Array of objects
Array
itemNumber
string

ItemNumber of the given product.

estimated
integer <int64>

The amount you initially ordered.

Responses

Request samples

Content type
application/json
{
  • "name": "Szótárak beszállítás",
  • "estimatedArrival": "2021-05-28 12:48:12",
  • "urgent": false,
  • "express": false,
  • "description": "Ebben a beszállításban angol-magyar szótárak érkeznek.",
  • "warehouse": 204,
  • "contents": [
    • {
      • "itemNumber": "frozen-pumpkin-01",
      • "estimated": 2
      }
    ]
}

Response samples

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

Update shipment

Update a shipment by id, only the updatable fields should be present.

Authorizations:
bearerAuth
Request Body schema: application/json
name
string [ 3 .. 50 ] characters
estimatedArrival
string or null <date>
urgent
boolean

Indicates if the shipment is urgent.

express
boolean

Indicates if the shipment is express.

description
string <= 255 characters

Short description.

warehouse
integer <int32>
Deprecated
Enum: 204 153

DEPRECATED This field is no longer used, we always use your comapny's warehouse information.

Array of objects
Array
itemNumber
string

ItemNumber of the given product.

estimated
integer <int64>

The amount you initially ordered.

Responses

Request samples

Content type
application/json
{
  • "name": "Szótárak beszállítás",
  • "estimatedArrival": "2021-05-28 12:48:12",
  • "urgent": false,
  • "express": false,
  • "description": "Ebben a beszállításban angol-magyar szótárak érkeznek.",
  • "warehouse": 204,
  • "contents": [
    • {
      • "itemNumber": "frozen-pumpkin-01",
      • "estimated": 2
      }
    ]
}

Response samples

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

Get shipment

Get a single shipment by its id.

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

ID of the inward-handling.

Responses

Response samples

Content type
application/json
{
  • "id": 2367,
  • "name": "Szótárak beszállítás",
  • "status": "Várható",
  • "estimatedArrival": "2021-05-28 12:48:12",
  • "actualArrival": "2021-05-28 14:12:54",
  • "hasArrived": false,
  • "urgent": false,
  • "express": false,
  • "description": "Ebben a beszállításban angol-magyar szótárak érkeznek.",
  • "warehouse": 204,
  • "contents": [
    • {
      • "itemNumber": "frozen-pumpkin-01",
      • "estimated": 2,
      • "received": 2,
      • "serialNumbers": [
        • "fppk-001"
        ]
      }
    ]
}

Delete shipment

Authorizations:
bearerAuth
path Parameters
id
required
integer <int64>

ID of the inward-handling.

Responses

Response samples

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