Skip to main content
API docs by Redocly

Inbound Shipment Management Service (v2025.10.23-0)

Download OpenAPI specification:Download

Get/find inbound shipments by query

This endpoint returns a list of inbound shipments matching the given query.

query Parameters
merchant
string
Example: merchant=testmerchant.logitrail.com

Owning merchant

status
string (Status of the inbound shipment.)
Enum: "initial" "confirmed" "en_route" "arrived_at_warehouse" "processed" "processing" "problem" "cancelled" "deleted"

The current status of the inbound shipment. This is a read-only property.

limit
number [ 1 .. 1000 ]
Default: 250

Responses

Response samples

Content type
application/json
{
  • "inbound_shipments": [
    ]
}

Create a new inbound shipment

This endpoint creates a new inbound shipment to the system. The inbound shipment is created in draft status.

Request Body schema: application/json
merchants_ref
string or null

Merchant's reference to the inbound shipment. Note that value is trimmed (trailing and leading spaces removed) and empty string is ignored.

sender_name
string or null

Sender's name, as given by the merchant.

priority
number or null [ -10000000 .. 10000000 ]

Merchant's priority of the inbound shipment. This can be an integer between -10000000 (slowest handling) to 1000000 (fastest handling). Note that the value is effective only within merchant's other inbound shipments. Value 0 is ignored.

merchant_remarks
string or null

Free text remarks from Merchant to Logitrail.

estimated_arrival_date
string or null <date>

Estimated arrival date of the inbound shipment.

type
string
Default: "purchase_order"
Enum: "purchase_order" "order_return"

Type of the inbound shipment.

Array of objects
Default: []

List of product items to be expected to arrive in this inbound shipment.

Responses

Request samples

Content type
application/json
{
  • "merchants_ref": "string",
  • "sender_name": "string",
  • "priority": -10000000,
  • "merchant_remarks": "string",
  • "estimated_arrival_date": "2019-08-24",
  • "type": "purchase_order",
  • "items": [ ]
}

Response samples

Content type
application/json
{
  • "inbound_shipment": {
    }
}

Get an inbound shipment by ID

This endpoint returns the requested inbound shipment.

path Parameters
inboundShipmentId
required
string^[a-f0-9]{24}$
Example: 5f8d0f8d8f8d8f8d8f8d8f8d

Inbound Shipment ID

Responses

Response samples

Content type
application/json
{
  • "inbound_shipment": {
    }
}

Update the inbound shipment

This endpoint returns the given inbound shipment after modifications.

path Parameters
inboundShipmentId
required
string^[a-f0-9]{24}$
Example: 5f8d0f8d8f8d8f8d8f8d8f8d

Inbound Shipment ID

Request Body schema: application/json
merchants_ref
string or null

Merchant's reference to the inbound shipment. Note that value is trimmed (trailing and leading spaces removed) and empty string is ignored.

sender_name
string or null

Sender's name, as given by the merchant.

priority
number or null [ -10000000 .. 10000000 ]

Merchant's priority of the inbound shipment. This can be an integer between -10000000 (slowest handling) to 1000000 (fastest handling). Note that the value is effective only within merchant's other inbound shipments. Value 0 is ignored.

merchant_remarks
string or null

Free text remarks from Merchant to Logitrail.

estimated_arrival_date
string or null <date>

Estimated arrival date of the inbound shipment.

Array of objects

List of product items to be expected to arrive in this inbound shipment. Note that passing this argument replaces the item list. If you want to add or remove individual item, use /products endpoint.

Responses

Request samples

Content type
application/json
{
  • "merchants_ref": "string",
  • "sender_name": "string",
  • "priority": -10000000,
  • "merchant_remarks": "string",
  • "estimated_arrival_date": "2019-08-24",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "inbound_shipment": [
    ]
}

Get attachments

This endpoint returns a list of inbound shipment attachments and a temporary link to download/view the attachment file. Attachments can be PDF documents or images provided by Logitrail Crew upon receiving the packages.

path Parameters
inboundShipmentId
required
string^[a-f0-9]{24}$
Example: 5f8d0f8d8f8d8f8d8f8d8f8d

Inbound Shipment ID

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}

Get Product Arrival Estimations

Provides arrival estimations for a product.

Authorizations:
idp
path Parameters
productId
required
string (Product ID) ^[a-fA-F0-9]{24}$

ID of the product that estimations are requested

header Parameters
x-logitrail-merchant-id
required
string (Logitrail's Merchant ID) non-empty

Responses

Response samples

Content type
application/json
{
  • "arrival_estimations": [
    ]
}

Extra Items

Add extra item

This endpoint adds a new extra item to the inbound shipment. Extra items are line items that have not been in the original shipment data, or are unknown.

Authorizations:
idp
path Parameters
inboundShipmentId
required
string^[a-f0-9]{24}$
Example: 5f8d0f8d8f8d8f8d8f8d8f8d

Inbound Shipment ID

Request Body schema: application/json
required
object

List of product items to be added to this inbound shipment.

object
reason_code
string (Reason Code (why extra item))
Enum: "exp_date" "broken" "extra_items" "unknown" "not_ordered"

Reason code set by Logitrail warehouse employee. Describes why this extra item is an extra item.

quantity
number or null >= 1

Amount of extra items arrived.

object or null

Responses

Request samples

Content type
application/json
{
  • "extra_item": {
    }
}

Response samples

Content type
application/json
{
  • "extra_item": {
    }
}

Update the extra item

Updates the extra item details.

Authorizations:
idp
path Parameters
inboundShipmentId
required
string^[a-f0-9]{24}$
Example: 5f8d0f8d8f8d8f8d8f8d8f8d

Inbound Shipment ID

extraItemId
required
string^[a-f0-9]{24}$

Inbound Shipment Extra Item ID

Request Body schema: application/json
required
object

Extra item updates

object
reason_code
string (Reason Code (why extra item))
Enum: "exp_date" "broken" "extra_items" "unknown" "not_ordered"

Reason code set by Logitrail warehouse employee. Describes why this extra item is an extra item.

quantity
number or null >= 1

Amount of extra items arrived.

object or null

Responses

Request samples

Content type
application/json
{
  • "extra_item": {
    }
}

Response samples

Content type
application/json
{
  • "extra_item": {
    }
}

Delete the extra item

Deletes the extra item from the inbound shipment.

Authorizations:
idp
path Parameters
inboundShipmentId
required
string^[a-f0-9]{24}$
Example: 5f8d0f8d8f8d8f8d8f8d8f8d

Inbound Shipment ID

extraItemId
required
string^[a-f0-9]{24}$

Inbound Shipment Extra Item ID

Request Body schema: application/json
object
Default: {}

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "message": "string",
  • "errors": [
    ]
}