> ## Documentation Index
> Fetch the complete documentation index at: https://developer.sandbox.co.in/llms.txt
> Use this file to discover all available pages before exploring further.

# Get E-Way Bill

> Fetch E-Way Bill details by number.

#### Response schema

For successful responses, this reference describes the NIC E-Way Bill payload at `data.data`.

<Card title="View JSON schema" icon="code" href="https://raw.githubusercontent.com/in-co-sandbox/in-co-sandbox-docs/refs/heads/main/data/gst/schema/request/e-way-bill/get_e_way_bill.json" arrow="true" horizontal />


## OpenAPI

````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}
openapi: 3.0.1
info:
  title: compliance
  description: >-
    **GST Compliance API** enables businesses to automate compliance
    requirements like [Taxpayer
    verification](https://developer.sandbox.co.in/reference/search-gstin-api),
    [GSTR
    Filing](https://developer.sandbox.co.in/reference/gst-taxpayer-authentication),
    [Generating
    E-Invoices](https://developer.sandbox.co.in/reference/e-invoice-authentication-api),
    and [E-Way
    Bills](https://developer.sandbox.co.in/reference/e-way-bill-authentication-api).We
    provide these APIs from GSTN-authorised GST Suvidha Providers, handling the
    encryption-decryption and signing so you don't have to handle the
    complexities.
  version: 1.0.0
servers:
  - url: https://api.sandbox.co.in
  - url: https://test-api.sandbox.co.in
security: []
tags:
  - name: Public
  - name: Taxpayer
  - name: Taxpayer Auth
  - name: Returns
  - name: GSTR-1 Documents
  - name: File GSTR-1
  - name: GSTR-2A Documents
  - name: GSTR-2B Document
  - name: File GSTR-3B
  - name: GSTR-4
  - name: File GSTR-9
  - name: Invoice Management System
  - name: GSTR-1A Documents
  - name: File GSTR-1A
  - name: Ledgers
  - name: e-Invoice
  - name: Sales e-Invoices for return period
  - name: Purchase e-Invoices for return period
  - name: Front Office Notices
  - name: Front Office
  - name: AATO
  - name: e-Invoice1
  - name: Authentication
  - name: e-Invoice12
  - name: E-Way Bill
  - name: E-Way Bill1
  - name: Authentication1
  - name: Consignor
  - name: Consolidated E-Way Bill
  - name: Multi-Vehicle Movement
  - name: Consignee
  - name: Transporter
  - name: Consolidated E-Way Bill1
  - name: Multi-vehicle Movement
  - name: Common
paths:
  /gst/compliance/e-way-bill/tax-payer/bill/{ewb_no}:
    get:
      tags:
        - E-Way Bill1
        - Common
      summary: Get E-Way Bill
      operationId: getEWayBill
      parameters:
        - name: ewb_no
          in: path
          description: ''
          required: true
          example: ''
          schema:
            type: string
        - name: authorization
          in: header
          description: >-
            E-Way Bill access token. For token-generation steps, refer to the
            [Generate E-Way Bill
            Session](/recipes/gst/authentication/generate_e_way_bill_session)
            recipe, then pass the token in the authorization header.
          required: true
          example: ''
          schema:
            type: string
        - name: x-source
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
            example: primary
        - name: x-proxy
          in: header
          description: ''
          required: false
          example: ''
          schema:
            type: string
            example: secondary
        - name: x-api-key
          in: header
          description: API key for identification
          required: true
          example: ''
          schema:
            type: string
        - name: x-api-version
          in: header
          description: API version
          required: false
          example: ''
          schema:
            type: string
            default: 1.0.0
      responses:
        '200':
          description: >-
            200 EWB fetched / 357 EWB data not available / 200 Fetch rejected
            EWB
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEWayBillResponse'
              examples:
                200 EWB fetched:
                  summary: 200 EWB fetched
                  value:
                    code: 200
                    data:
                      data:
                        VehiclListDetails:
                          - enteredDate: 01/05/2024 07:00:00 PM
                            fromPlace: FRAZER TOWN
                            fromState: 27
                            groupNo: '0'
                            transDocDate: null
                            transDocNo: ''
                            transMode: '1'
                            tripshtNo: 0
                            updMode: API
                            userGSTINTransin: 27AAACQ3770E004
                            vehicleNo: PVC1234
                        actFromStateCode: 27
                        actToStateCode: 29
                        actualDist: 1000
                        cessNonAdvolValue: 400
                        cessValue: 400.56
                        cgstValue: 0
                        docDate: 15/12/2017
                        docNo: 7001-8
                        docType: INV
                        ewayBillDate: 01/05/2024 07:00:00 PM
                        ewbNo: 291010077005
                        extendedTimes: 0
                        fromAddr1: 2ND CROSS NO 59  19  A
                        fromAddr2: GROUND FLOOR OSBORNE ROAD
                        fromGstin: 29AAACQ3770E000
                        fromPincode: 400027
                        fromPlace: FRAZER TOWN
                        fromStateCode: 27
                        fromTrdName: welton
                        genMode: API
                        igstValue: 300.67
                        itemList:
                          - cessNonAdvol: 0
                            cessRate: 3
                            cgstRate: 0
                            hsnCode: 1001
                            igstRate: 3
                            itemNo: 1
                            productDesc: Wheat
                            productId: 0
                            productName: Wheat
                            qtyUnit: BOX
                            quantity: 4
                            sgstRate: 0
                            taxableAmount: 5609889
                        noValidDays: 5
                        otherValue: -100
                        rejectStatus: 'N'
                        sgstValue: 0
                        status: ACT
                        subSupplyType: '1  '
                        supplyType: O
                        toAddr1: Shree Nilaya
                        toAddr2: Dasarahosahalli
                        toGstin: 27AAACQ3770E000
                        toPincode: 560090
                        toPlace: Beml Nagar
                        toStateCode: 29
                        toTrdName: sthuthya
                        totInvValue: 68358
                        totalValue: 56099
                        transactionType: 4
                        transporterId: 27AAACQ3770E004
                        transporterName: Acme Industries Private Limited
                        userGstin: 29AAACQ3770E000
                        validUpto: 06/05/2024 11:59:00 PM
                        vehicleType: R
                      status: '1'
                    timestamp: 1763446641000
                    transaction_id: 6dddbe8f-147f-4678-88b6-003f112854d7
                200 Fetch rejected EWB:
                  summary: 200 Fetch rejected EWB
                  value:
                    code: 200
                    data:
                      data:
                        VehiclListDetails:
                          - enteredDate: 01/05/2024 07:00:00 PM
                            fromPlace: FRAZER TOWN
                            fromState: 27
                            groupNo: '0'
                            transDocDate: null
                            transDocNo: ''
                            transMode: '1'
                            tripshtNo: 0
                            updMode: API
                            userGSTINTransin: 27AAACQ3770E004
                            vehicleNo: PVC1234
                        actFromStateCode: 27
                        actToStateCode: 29
                        actualDist: 1000
                        cessNonAdvolValue: 400
                        cessValue: 400.56
                        cgstValue: 0
                        docDate: 15/12/2017
                        docNo: 7001-8
                        docType: INV
                        ewayBillDate: 01/05/2024 07:00:00 PM
                        ewbNo: 291010077010
                        extendedTimes: 0
                        fromAddr1: 2ND CROSS NO 59  19  A
                        fromAddr2: GROUND FLOOR OSBORNE ROAD
                        fromGstin: 29AAACQ3770E000
                        fromPincode: 400027
                        fromPlace: FRAZER TOWN
                        fromStateCode: 27
                        fromTrdName: welton
                        genMode: API
                        igstValue: 300.67
                        itemList:
                          - cessNonAdvol: 0
                            cessRate: 3
                            cgstRate: 0
                            hsnCode: 1001
                            igstRate: 3
                            itemNo: 1
                            productDesc: Wheat
                            productId: 0
                            productName: Wheat
                            qtyUnit: BOX
                            quantity: 4
                            sgstRate: 0
                            taxableAmount: 5609889
                        noValidDays: 5
                        otherValue: -100
                        rejectStatus: 'Y'
                        sgstValue: 0
                        status: ACT
                        subSupplyType: '1  '
                        supplyType: O
                        toAddr1: Shree Nilaya
                        toAddr2: Dasarahosahalli
                        toGstin: 27AAACQ3770E000
                        toPincode: 560090
                        toPlace: Beml Nagar
                        toStateCode: 29
                        toTrdName: sthuthya
                        totInvValue: 68358
                        totalValue: 56099
                        transactionType: 4
                        transporterId: 27AAACQ3770E004
                        transporterName: Quicko Infosoft Private Limited
                        userGstin: 29AAACQ3770E000
                        validUpto: 06/05/2024 11:59:00 PM
                        vehicleType: R
                      status: '1'
                    timestamp: 1763446641000
                    transaction_id: 67f3b1ad-80d6-4692-92d8-e978ffec096b
                357 EWB data not available:
                  summary: 357 EWB data not available
                  value:
                    code: 200
                    data:
                      error:
                        errorCodes: '357'
                      info: ''
                      status: '0'
                    timestamp: 1763446641000
                    transaction_id: 5a742c1b-de26-41fe-bf27-9becb16ed6f4
          headers: {}
      deprecated: false
      security: []
components:
  schemas:
    GetEWayBillResponse:
      oneOf:
        - $ref: '#/components/schemas/GetEWayBillSuccessResponse'
        - $ref: '#/components/schemas/EWayBillBusinessErrorResponse'
      description: >-
        An E-Way Bill success or NIC business-failure response. Both variants
        use HTTP 200.
    GetEWayBillSuccessResponse:
      allOf:
        - $ref: '#/components/schemas/EWayBillResponseMetadata'
        - type: object
          required:
            - data
          properties:
            data:
              type: object
              properties:
                data:
                  $ref: '#/components/schemas/GetEWayBillSuccessPayload'
                error:
                  type: object
                  properties:
                    errorCodes:
                      type: string
                      example: '357'
                info:
                  type: string
                  example: ''
                status:
                  type: string
                  example: '1'
                  enum:
                    - '1'
                  description: NIC success status.
    EWayBillBusinessErrorResponse:
      allOf:
        - $ref: '#/components/schemas/EWayBillResponseMetadata'
        - type: object
          required:
            - data
          properties:
            data:
              type: object
              required:
                - status
                - error
              properties:
                status:
                  type: string
                  enum:
                    - '0'
                  description: NIC business-failure status.
                error:
                  $ref: '#/components/schemas/EWayBillBusinessError'
    EWayBillResponseMetadata:
      type: object
      description: Metadata returned with every E-Way Bill response.
      required:
        - code
        - timestamp
        - transaction_id
      properties:
        code:
          type: integer
          enum:
            - 200
          description: NIC response code.
        timestamp:
          type: integer
          format: int64
          description: Unix timestamp.
        transaction_id:
          type: string
          description: Request transaction identifier.
    GetEWayBillSuccessPayload:
      type: object
      properties:
        VehiclListDetails:
          type: array
          items:
            type: object
            properties:
              enteredDate:
                type: string
                example: 01/05/2024 07:00:00 PM
                description: The enteredDate value.
              fromPlace:
                type: string
                example: FRAZER TOWN
                description: The fromPlace value.
              fromState:
                type: number
                example: 27
                description: The fromState value.
              groupNo:
                type: string
                example: '0'
                description: The groupNo value.
              transDocDate:
                type: string
                nullable: true
                example: null
                description: The transDocDate value.
              transDocNo:
                type: string
                example: ''
                description: The transDocNo value.
              transMode:
                type: string
                example: '1'
                description: The transMode value.
              tripshtNo:
                type: number
                example: 0
                description: The tripshtNo value.
              updMode:
                type: string
                example: API
                description: The updMode value.
              userGSTINTransin:
                type: string
                example: 27AAACQ3770E004
                description: The userGSTINTransin value.
              vehicleNo:
                type: string
                example: PVC1234
                description: The vehicleNo value.
            description: E-Way Bill schema.
          example:
            - enteredDate: 01/05/2024 07:00:00 PM
              fromPlace: FRAZER TOWN
              fromState: 27
              groupNo: '0'
              transDocDate: null
              transDocNo: ''
              transMode: '1'
              tripshtNo: 0
              updMode: API
              userGSTINTransin: 27AAACQ3770E004
              vehicleNo: PVC1234
          description: The VehiclListDetails value.
        actFromStateCode:
          type: number
          example: 27
          description: The actFromStateCode value.
        actToStateCode:
          type: number
          example: 29
          description: The actToStateCode value.
        actualDist:
          type: number
          example: 1000
          description: The actualDist value.
        cessNonAdvolValue:
          type: number
          example: 400
          description: The cessNonAdvolValue value.
        cessValue:
          type: number
          example: 400.56
          description: The cessValue value.
        cgstValue:
          type: number
          example: 0
          description: The cgstValue value.
        docDate:
          type: string
          example: 15/12/2017
          description: The docDate value.
        docNo:
          type: string
          example: 7001-8
          description: The docNo value.
        docType:
          type: string
          example: INV
          description: The docType value.
        ewayBillDate:
          type: string
          example: 01/05/2024 07:00:00 PM
          description: The ewayBillDate value.
        ewbNo:
          type: number
          example: 291010077005
          description: The ewbNo value.
        extendedTimes:
          type: number
          example: 0
          description: The extendedTimes value.
        fromAddr1:
          type: string
          example: 2ND CROSS NO 59  19  A
          description: The fromAddr1 value.
        fromAddr2:
          type: string
          example: GROUND FLOOR OSBORNE ROAD
          description: The fromAddr2 value.
        fromGstin:
          type: string
          example: 29AAACQ3770E000
          description: The fromGstin value.
        fromPincode:
          type: number
          example: 400027
          description: The fromPincode value.
        fromPlace:
          type: string
          example: FRAZER TOWN
          description: The fromPlace value.
        fromStateCode:
          type: number
          example: 27
          description: The fromStateCode value.
        fromTrdName:
          type: string
          example: welton
          description: The fromTrdName value.
        genMode:
          type: string
          example: API
          description: The genMode value.
        igstValue:
          type: number
          example: 300.67
          description: The igstValue value.
        itemList:
          type: array
          items:
            type: object
            properties:
              cessNonAdvol:
                type: number
                example: 0
                description: The cessNonAdvol value.
              cessRate:
                type: number
                example: 3
                description: The cessRate value.
              cgstRate:
                type: number
                example: 0
                description: The cgstRate value.
              hsnCode:
                type: number
                example: 1001
                description: The hsnCode value.
              igstRate:
                type: number
                example: 3
                description: The igstRate value.
              itemNo:
                type: number
                example: 1
                description: The itemNo value.
              productDesc:
                type: string
                example: Wheat
                description: The productDesc value.
              productId:
                type: number
                example: 0
                description: The productId value.
              productName:
                type: string
                example: Wheat
                description: The productName value.
              qtyUnit:
                type: string
                example: BOX
                description: The qtyUnit value.
              quantity:
                type: number
                example: 4
                description: The quantity value.
              sgstRate:
                type: number
                example: 0
                description: The sgstRate value.
              taxableAmount:
                type: number
                example: 5609889
                description: The taxableAmount value.
            description: E-Way Bill schema.
          example:
            - cessNonAdvol: 0
              cessRate: 3
              cgstRate: 0
              hsnCode: 1001
              igstRate: 3
              itemNo: 1
              productDesc: Wheat
              productId: 0
              productName: Wheat
              qtyUnit: BOX
              quantity: 4
              sgstRate: 0
              taxableAmount: 5609889
          description: The itemList value.
        noValidDays:
          type: number
          example: 5
          description: The noValidDays value.
        otherValue:
          type: number
          example: -100
          description: The otherValue value.
        rejectStatus:
          type: string
          example: 'N'
          description: The rejectStatus value.
        sgstValue:
          type: number
          example: 0
          description: The sgstValue value.
        status:
          type: string
          example: ACT
          description: The status value.
        subSupplyType:
          type: string
          example: '1  '
          description: The subSupplyType value.
        supplyType:
          type: string
          example: O
          description: The supplyType value.
        toAddr1:
          type: string
          example: Shree Nilaya
          description: The toAddr1 value.
        toAddr2:
          type: string
          example: Dasarahosahalli
          description: The toAddr2 value.
        toGstin:
          type: string
          example: 27AAACQ3770E000
          description: The toGstin value.
        toPincode:
          type: number
          example: 560090
          description: The toPincode value.
        toPlace:
          type: string
          example: Beml Nagar
          description: The toPlace value.
        toStateCode:
          type: number
          example: 29
          description: The toStateCode value.
        toTrdName:
          type: string
          example: sthuthya
          description: The toTrdName value.
        totInvValue:
          type: number
          example: 68358
          description: The totInvValue value.
        totalValue:
          type: number
          example: 56099
          description: The totalValue value.
        transactionType:
          type: number
          example: 4
          description: The transactionType value.
        transporterId:
          type: string
          example: 27AAACQ3770E004
          description: The transporterId value.
        transporterName:
          type: string
          example: Acme Industries Private Limited
          description: The transporterName value.
        userGstin:
          type: string
          example: 29AAACQ3770E000
          description: The userGstin value.
        validUpto:
          type: string
          example: 06/05/2024 11:59:00 PM
          description: The validUpto value.
        vehicleType:
          type: string
          example: R
          description: The vehicleType value.
      description: E-Way Bill schema.
    EWayBillBusinessError:
      type: object
      description: NIC business-error details.
      required:
        - errorCodes
      properties:
        errorCodes:
          type: string
          description: NIC error code.

````