---
title: "GET /openapi/{version}/consignments/inbound_consignments/{id}/"
method: GET
path: "/openapi/{version}/consignments/inbound_consignments/{id}/"
tags: ["Inbound Consignment"]
---

# GET /openapi/{version}/consignments/inbound_consignments/{id}/

`GET /openapi/{version}/consignments/inbound_consignments/{id}/`

## Request

- Base URL: `https://base_url`
- URL: `https://base_url/openapi/{version}/consignments/inbound_consignments/{id}/`
- Auth: none declared

This endpoint retrieves an inbound consignment by its ID. 
 
 <b>Example `curl` Request:</b>
```bash
curl --location '{{url}}/openapi/v2/consignments/inbound_consignments/17049' \
--header 'Authorization: Bearer {{token}}'
```

## Path parameters

- `id` string, required
- `version` string, required

## Response `200`

- EnvelopedInboundConsignmentOpenAPI
  - `success` boolean
  - `data` InboundConsignmentOpenAPI, required
    - `id` integer, required
    - `consignment_number` string, required: Consignment Number
    - `consignment_date` string, date, required: Consignment Date
    - `address` string, required: Shipper Address
    - `tracking_number` string: Tracking Number
    - `carrier_name` string: Carrier Name
    - `tracking_url` string: Tracking URL
    - `warehouse_id` integer, required: Warehouse ID
    - `warehouse_transfer` boolean: Warehouse transfer
    - `product_details` InboundConsignmentProductDetailsOpenAPI[], required
      - `sku` string, required
      - `batch` string, nullable, required
      - `expiry_date` string, date, nullable, required
      - `consignment_quantity` integer, nullable, required
      - `received_quantity` integer, nullable, required
      - `usable_quantity` integer, nullable, required
      - `unusable_quantity` integer, nullable, required
    - `products` InboundConsignmentProductOpenAPI[], required
      - `sku` string, required: SKU
      - `consignment_quantity` integer, required: Quantity
      - `expiry_date` string, date, nullable: Expiry Date
    - `estimated_arrival_date` string, date, nullable, required: Estimated arrival date
    - `asn_note` string, nullable: ASN Note
    - `warehouse_note` string, nullable, required: Warehouse Note
    - `inbounded_at` string, date-time, nullable, required: Inbounded at
    - `timeline` InboundConsignmentTimeline, required
      - `drafted_at` string, date-time, nullable
      - `submitted_at` string, date-time, nullable
      - `approved_at` string, date-time, nullable
      - `rejected_at` string, date-time, nullable
      - `created_in_wms_at` string, date-time, nullable
      - `received_at` string, date-time, nullable
      - `unloaded_at` string, date-time, nullable
      - `processing_started_at` string, date-time, nullable
      - `count_started_at` string, date-time, nullable
      - `inbounded_at` string, date-time, nullable
      - `put_away_at` string, date-time, nullable
      - `completed_at` string, date-time, nullable
    - `total_consignment_quantity` string, required
    - `total_received_quantity` string, required
    - `completed_at` string, required
    - `total_usable_quantity` string, required
    - `total_unusable_quantity` string, required
    - `consignment_status` 'ASN_APPROVED' | 'ASN_DRAFT' | 'ASN_ON_HOLD' | 'ASN_PENDING' | 'ASN_REJECTED' | 'CANCELLED' | 'COMPLETED' | 'ERROR' | 'PENDING_APPROVAL' | 'PROCESSING' | 'QUALITY_CHECK' | 'STOCK_COUNT' | 'STOCK_INBOUNDED' | 'STOCK_RECEIVED' | 'UNKNOWN' | 'UNTRACKED' | 'VALIDATING', required: * `ASN_APPROVED` - ASN_APPROVED * `ASN_DRAFT` - ASN_DRAFT * `ASN_ON_HOLD` - ASN_ON_HOLD * `ASN_PENDING` - ASN_PENDING * `ASN_REJECTED` - ASN_REJECTED * `CANCELLED` - CANCELLED * `COMPLETED` - COMPLETED * `ERROR` - ERROR * `PENDING_APPROVAL` - PENDING_APPROVAL * `PROCESSING` - PROCESSING * `QUALITY_CHECK` - QUALITY_CHECK * `STOCK_COUNT` - STOCK_COUNT * `STOCK_INBOUNDED` - STOCK_INBOUNDED * `STOCK_RECEIVED` - STOCK_RECEIVED * `UNKNOWN` - UNKNOWN * `UNTRACKED` - UNTRACKED * `VALIDATING` - VALIDATING
    - `channel_status` string, required
    - `warehouse` WarehouseOpenAPI, required
      - `id` integer, required
      - `name` string, required
      - `code` string, nullable
      - `address` WarehouseAddressOpenAPI, required
        - `first_name` string, required: Name
        - `last_name` string
        - `address_line1` string, required: Address line 1
        - `address_line2` string, nullable: Address line 2
        - `address_line3` string, nullable: Address line 3
        - `email` string
        - `phone` string
        - `city` string, required: City
        - `state` string, required: State
        - `country` string, required: Country
        - `locality` string, required: Locality (barangay or suburb)
        - `zipcode` string, required: Zipcode
      - `pickup_location_id` integer, required: Pickup location id
    - `is_draft` boolean
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `message` string, required

## Other responses

- `400`: Bad Request - Invalid input.
- `401`: Unauthorized - Invalid or expired credentials.
- `403`: Forbidden - You do not have permission to access this resource.
- `404`: Not Found - The requested resource does not exist.
- `500`: Internal Server Error - Unexpected error occurred.

---

[API](https://skmtc.dev/golocad/apis/locad-api.md) - [All operations](https://skmtc.dev/golocad/apis/locad-api/llms.txt) - [OpenAPI document](https://skmtc.dev/golocad/apis/locad-api/revisions/428200f33a81?raw)