> ## 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.

# GSTR-1A ECOM

> This API is to get ECOM Details

#### Response body schema

<Card title="View response body schema" icon="code" href="https://raw.githubusercontent.com/in-co-sandbox/in-co-sandbox-docs/refs/heads/main/data/gst/schema/request/taxpayer/gstr-1a/documents/ecom.json" arrow="true" horizontal />


## OpenAPI

````yaml api-reference/gst/compliance/openapi.json GET /gst/compliance/tax-payer/gstrs/gstr-1a/ecom/{year}/{month}
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/tax-payer/gstrs/gstr-1a/ecom/{year}/{month}:
    get:
      tags:
        - Taxpayer
        - Returns
        - GSTR-1A Documents
      summary: GSTR-1A ECOM
      description: This API is to get ECOM Details
      operationId: getGstr1aEcom
      parameters:
        - name: year
          in: path
          description: Return year, for example `2025`.
          required: true
          example: '2026'
          schema:
            type: string
        - name: month
          in: path
          description: Return month, for example `04`.
          required: true
          example: '04'
          schema:
            type: string
        - name: recipient_gstin
          in: query
          description: Optional recipient GSTIN filter.
          required: false
          example: 20GRRHF2562D3A3
          schema:
            type: string
        - name: sub_section
          in: query
          description: Optional subsection filter.
          required: false
          example: ECOM_B2B
          schema:
            type: string
        - name: from
          in: query
          description: Optional from date in `DD/MM/YYYY` format.
          required: false
          example: 04/02/2017
          schema:
            type: string
        - name: authorization
          in: header
          description: >-
            GST taxpayer access token. For token-generation steps, refer to the
            Generate Taxpayer Session flow and pass the token in the
            authorization header.
          required: true
          example: '{{gsp_access_token}}'
          schema:
            type: string
        - name: x-api-version
          in: header
          description: Compliance API version.
          required: false
          example: 1.0.0
          schema:
            type: string
            default: 1.0.0
        - name: x-api-key
          in: header
          description: API key for identification.
          required: true
          example: '{{api_key}}'
          schema:
            type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties: {}
              examples:
                success:
                  summary: Success
                  value:
                    code: 200
                    timestamp: 1763446641000
                    transaction_id: 41bb8041-fb83-4654-8d75-85a19f329158
                    data:
                      status_cd: '1'
                      data:
                        ecom:
                          b2b:
                            - inv:
                                - val: 34567
                                  itms:
                                    - num: 100
                                      itm_det:
                                        rt: 1
                                        txval: 456
                                        iamt: 4.56
                                  inv_typ: DE
                                  flag: 'N'
                                  pos: '32'
                                  idt: 12-03-2023
                                  inum: DE-1
                                  sply_ty: INTER
                                  chksum: >-
                                    6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                                - val: 235423
                                  itms:
                                    - num: 25
                                      itm_det:
                                        rt: 0.25
                                        txval: 1234
                                        iamt: 3.09
                                  inv_typ: DE
                                  flag: 'N'
                                  pos: '32'
                                  idt: 08-03-2023
                                  inum: Normal-1
                                  sply_ty: INTER
                                  chksum: >-
                                    6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                              rtin: 32KLJIP1179C1ZF
                              stin: 33CBCHE8993D1Z5
                            - inv:
                                - val: 567
                                  itms:
                                    - num: 100
                                      itm_det:
                                        rt: 1
                                        txval: 765
                                  inv_typ: SEWOP
                                  flag: 'N'
                                  pos: '37'
                                  idt: 21-03-2023
                                  inum: B2B-2
                                  sply_ty: INTER
                                  chksum: >-
                                    6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                                - val: 7654654
                                  itms:
                                    - num: 100
                                      itm_det:
                                        rt: 1
                                        txval: 78654
                                        iamt: 786.54
                                  inv_typ: SEWP
                                  flag: 'N'
                                  pos: '27'
                                  idt: 21-03-2023
                                  inum: B2B
                                  sply_ty: INTER
                                  chksum: >-
                                    6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                              rtin: 37AABMH4573CKZN
                              stin: 33CBCHE8993D1Z5
                          b2c:
                            - stin: 33CBCHE8993D1Z5
                              csamt: 546
                              samt: 0
                              rt: 1
                              flag: 'N'
                              pos: '04'
                              txval: 8778654
                              camt: 0
                              iamt: 87786.54
                              sply_ty: INTER
                              chksum: >-
                                6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                          urp2b:
                            - inv:
                                - val: 235423
                                  itms:
                                    - num: 25
                                      itm_det:
                                        rt: 0.25
                                        txval: 1234
                                        iamt: 3.09
                                  flag: 'N'
                                  pos: '32'
                                  idt: 08-03-2023
                                  inum: URP2B-1
                                  sply_ty: INTER
                                  inv_typ: R
                                  chksum: >-
                                    6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                              rtin: 32KLJIP1179C1ZF
                          urp2c:
                            - csamt: 546
                              samt: 0
                              rt: 1
                              flag: 'N'
                              pos: '04'
                              txval: 8778654
                              camt: 0
                              iamt: 87786.54
                              sply_ty: INTER
                              chksum: >-
                                6927009f6608b520bb94b0b6890512a91dcc74e5a8723c91280241287058bf66
                wrong_params:
                  summary: Wrong Params
                  value:
                    code: 200
                    timestamp: 1782370541183
                    data:
                      status_cd: '0'
                      error:
                        message: Invalid recipient GSTIN
                        error_cd: RTNECOM-01
                    transaction_id: 23b92f47-08e6-4d4e-be6b-d082ac3da1af
                record_not_found:
                  summary: Record Not Found
                  value:
                    code: 200
                    timestamp: 1782370586912
                    data:
                      status_cd: '0'
                      error:
                        message: >-
                          No document found in selected financial year. Either
                          this document exists in a different financial year or
                          the document number is incorrect.
                        error_cd: RET11416
                    transaction_id: bc1f4c19-564a-41ad-920e-a6269b90a670
          headers: {}
      deprecated: false
      security: []

````