get

주문정보 조회와 관련된 API

주문조회

• 주문조회 (https://api.etomars.com/api/v1/invoice/get, https://api.etomars.com/api/v2/invoice/get) 특이사항 (Exceptional) 코드 안내

  https://app.gitbook.com/o/LLUpbGSdjuYGzVzVQZN5/s/6gpgLBfMlphypoM5lzV5/etc/exceptional

주문 조회

post

조회조건에 해당하는 주문정보를 조회합니다.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

TypestringOptional

주문번호 형식 regno : 접수번호(기본값) ordno : 주문번호 delvno : 택배번호 orgdelvno : 출발국가 택배번호

IsUnpackagebooleanOptional

패키지내 상품 목록 보이기

IsTrackingInfobooleanOptional

배송정보 가져오기

RegNoListstring[]Required

주문번호목록 (최대 100개)

ApiKeystringRequired

APIKey Test KEY:7abd72462c794016849abe4be

Responses

200

sucess

application/jsontext/jsonapplication/xmltext/xml

400

Valid Fail

application/jsontext/jsonapplication/xmltext/xml

post

/api/v1/invoice/get

HTTPcURLJavaScriptPython

POST /api/v1/invoice/get HTTP/1.1
Host: api.etomars.com
Content-Type: application/json
Accept: */*
Content-Length: 176

{
  "Type": "ordno",
  "IsUnpackage": true,
  "IsTrackingInfo": true,
  "RegNoList": [
    "TEST230106-001",
    "TEST230106-002",
    "TEST230106-003",
    "PACKAGE10B-007"
  ],
  "ApiKey": "XXXXXXXXXXXXXXXXXXXXXXXXX"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

{
  "Data": [
    {
      "RegNo": "text",
      "Status": 1,
      "RegDate": "text",
      "SaleSite": "text",
      "StatusDesc": "text",
      "OrderNo1": "text",
      "OrderNo2": "text",
      "DelvNo": "text",
      "DelvCom": "text",
      "DeliveryType": "text",
      "DelvComName": "text",
      "NationCode": "text",
      "ShippingType": "text",
      "SenderName": "text",
      "SenderTelno": "text",
      "SenderAddr": "text",
      "ReceiverName": "text",
      "ReceiverNameYomigana": "text",
      "ReceiverTelNo1": "text",
      "ReceiverTelNo2": "text",
      "ReceiverZipcode": "text",
      "ReceiverState": "text",
      "ReceiverCity": "text",
      "ReceiverDistrict": "text",
      "ReceiverDetailAddr": "text",
      "ReceiverEmail": "text",
      "ReceiverSocialNo": "text",
      "RealWeight": 1,
      "WeightUnit": "text",
      "BoxCount": 1,
      "CurrencyUnit": "text",
      "DelvMessage": "text",
      "UserData1": "text",
      "UserData2": "text",
      "UserData3": "text",
      "DimWidth": 1,
      "DimLength": 1,
      "DimHeight": 1,
      "DimUnit": "text",
      "ExpLicenceNo": "text",
      "VolumeWeight": 1,
      "ChargeableWeight": 1,
      "ShippingFee": 1,
      "ShippingFeeCurrency": "text",
      "OrderDate": "text",
      "PaymentDate": "text",
      "InvtDeductDate": "text",
      "Exceptional": "text",
      "ExceptionStatus": "text",
      "GoodsList": [
        {
          "GoodsName": "text",
          "Qty": 1,
          "UnitPrice": 1,
          "BrandName": "text",
          "PkgCode": "text",
          "SKU": "text",
          "SkuList": [
            {
              "Sku": "text",
              "Qty": 1
            }
          ],
          "HSCODE": "text",
          "PurchaseUrl": "text",
          "GTYPE": "text"
        }
      ],
      "TrackingList": [
        {
          "Status": 1,
          "StatusDesc": "text",
          "IssueDateTime": "text",
          "IssueDetail": "text",
          "Location": "text"
        }
      ]
    }
  ],
  "Message": "text",
  "Code": 1
}

주문 조회

post

조회조건에 해당하는 주문정보를 조회합니다.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

주문조회 Request 모델 v2

TypestringOptional

주문번호 형식 regno : 접수번호(기본값) ordno : 주문번호 delvno : 택배번호 orgdelvno : 출발국가 택배번호

IsUnpackagebooleanOptional

패키지내 상품 목록 보이기

IsTrackingInfobooleanOptional

배송정보 가져오기

IsGoodsInfobooleanOptional

상품정보 가져오기

IsDeliveryInfobooleanOptional

배송정보 가져오기

IsSenderInfobooleanOptional

발송인 정보 가져오기

IsReceiverInfobooleanOptional

수신인 정보 가져오기

IsCargoInfobooleanOptional

무게 정보

IsTrackingPointbooleanOptional

배송

RegNoListstring[]Required

주문번호목록 (최대 100개)

ApiKeystringRequired

APIKey Test KEY:7abd72462c794016849abe4be

Responses

200

sucess

application/jsontext/jsonapplication/xmltext/xml

400

Valid Fail

application/jsontext/jsonapplication/xmltext/xml

post

/api/v2/invoice/get

HTTPcURLJavaScriptPython

POST /api/v2/invoice/get HTTP/1.1
Host: api.etomars.com
Content-Type: application/json
Accept: */*
Content-Length: 301

{
  "Type": "ordno",
  "IsUnpackage": true,
  "IsTrackingInfo": true,
  "IsGoodsInfo": true,
  "IsDeliveryInfo": true,
  "IsSenderInfo": true,
  "IsReceiverInfo": true,
  "IsCargoInfo": true,
  "IsTrackingPoint": true,
  "RegNoList": [
    "TEST230106-001",
    "TEST230106-002",
    "TEST230106-003",
    "PACKAGE10B-007"
  ],
  "ApiKey": "XXXXXXXXXXXXXXXXXXXXXXXXX"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

{
  "Data": [
    {
      "RegNo": "text",
      "RegDate": "text",
      "Status": 1,
      "StatusDesc": "text",
      "SaleSite": "text",
      "NationCode": "text",
      "OrderNo1": "text",
      "OrderNo2": "text",
      "ExpLicenceNo": "text",
      "OrderDate": "text",
      "PaymentDate": "text",
      "UserData1": "text",
      "UserData2": "text",
      "UserData3": "text",
      "Exceptional": "text",
      "TrackingList": [
        {
          "Status": 1,
          "StatusDesc": "text",
          "IssueDateTime": "text",
          "IssueDetail": "text",
          "Location": "text"
        }
      ],
      "GoodsInfo": {
        "CurrencyUnit": "text",
        "GoodsList": [
          {
            "GoodsName": "text",
            "Qty": 1,
            "UnitPrice": 1,
            "BrandName": "text",
            "PkgCode": "text",
            "SKU": "text",
            "SkuList": [
              {
                "Sku": "text",
                "Qty": 1
              }
            ],
            "HSCODE": "text",
            "PurchaseUrl": "text",
            "GTYPE": "text"
          }
        ]
      },
      "DeliveryInfo": {
        "DelvNo": "text",
        "DelvCom": "text",
        "DeliveryType": "text",
        "DelvComName": "text",
        "ShippingType": "text",
        "ShippingFee": 1,
        "ShippingFeeCurrency": "text"
      },
      "SenderInfo": {
        "SenderName": "text",
        "SenderTelno": "text",
        "SenderAddr": "text"
      },
      "ReceiverInfo": {
        "ReceiverName": "text",
        "ReceiverNameYomigana": "text",
        "ReceiverTelNo1": "text",
        "ReceiverTelNo2": "text",
        "ReceiverZipcode": "text",
        "ReceiverState": "text",
        "ReceiverCity": "text",
        "ReceiverDistrict": "text",
        "ReceiverDetailAddr": "text",
        "ReceiverEmail": "text",
        "ReceiverSocialNo": "text",
        "DelvMessage": "text"
      },
      "CargoInfo": {
        "RealWeight": 1,
        "VolumeWeight": 1,
        "WeightUnit": "text",
        "DimWidth": 1,
        "DimLength": 1,
        "DimHeight": 1,
        "DimUnit": "text",
        "ChargeableWeight": 1,
        "BoxCount": 1
      },
      "TrackingPoint": {
        "RegDate": "text",
        "PackingInspection": "text",
        "InvtDeductDate": "text",
        "ReceivedWarehouse": "text",
        "ReleaseWarehouse": "text",
        "FlightDeparture": "text",
        "FlightArrival": "text",
        "DeliveryStarted": "text",
        "DeliveryCompleted": "text"
      }
    }
  ],
  "Message": "text",
  "Code": 1
}

주문번호목록 조회

post

조회조건에 해당하는 주문번호를 조회합니다.(최대기간 90일)

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

TypestringOptional

리턴받을 번호 유형 regno : 접수번호(기본값) ordno : 주문번호 delvno : 택배번호

SalesSitestring · max: 30Optional

판매처

DateTypeinteger · int32Optional

날짜 검색 유형 0 : 접수일 1 : 재고차감일

StartDateTimestringRequired

검색 시작일 yyyy-MM-dd, yyyyMMdd

EndDateTimestringRequired

검색 시작일 yyyy-MM-dd, yyyyMMdd

ApiKeystringRequired

APIKey Test KEY:7abd72462c794016849abe4be

Responses

200

sucess

application/jsontext/jsonapplication/xmltext/xml

400

Valid Fail

application/jsontext/jsonapplication/xmltext/xml

post

/api/v1/invoice/get/numbers

HTTPcURLJavaScriptPython

POST /api/v1/invoice/get/numbers HTTP/1.1
Host: api.etomars.com
Content-Type: application/json
Accept: */*
Content-Length: 118

{
  "Type": "ordno",
  "DateType": 0,
  "StartDateTime": "20230101",
  "EndDateTime": "20230202",
  "ApiKey": "XXXXXXXXXXXXXXXXXXXXXXXXX"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

{
  "Data": [
    "text"
  ],
  "Message": "text",
  "Code": 1
}

주문-배송정보 조회

post

조회조건에 해당하는 주문의 배송정보를 조회합니다.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

TypestringOptional

주문번호 형식 regno : 접수번호(기본값) ordno : 주문번호 delvno : 택배번호 orgdelvno : 출발국가 택배번호

IsUnpackagebooleanOptional

패키지내 상품 목록 보이기

IsTrackingInfobooleanOptional

배송정보 가져오기

RegNoListstring[]Required

주문번호목록 (최대 100개)

ApiKeystringRequired

APIKey Test KEY:7abd72462c794016849abe4be

Responses

200

sucess

application/jsontext/jsonapplication/xmltext/xml

400

Valid Fail

application/jsontext/jsonapplication/xmltext/xml

post

/api/v1/invoice/get/tracking

HTTPcURLJavaScriptPython

POST /api/v1/invoice/get/tracking HTTP/1.1
Host: api.etomars.com
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "Type": "ordno",
  "RegNoList": [
    "TEST230106-003",
    "TEST230106-999"
  ],
  "ApiKey": "XXXXXXXXXXXXXXXXXXXXXXXXX"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

{
  "Data": [
    {
      "RegNo": "text",
      "CustomNo": "text",
      "Status": 1,
      "StatusDesc": "text",
      "OrderNo1": "text",
      "OrderNo2": "text",
      "DelvNo": "text",
      "DelvCom": "text",
      "DelvComName": "text",
      "DepCountryCode": "text",
      "DepCountryName": "text",
      "ArrCountryCode": "text",
      "ArrCountryName": "text",
      "SenderName": "text",
      "RecipientName": "text",
      "RecipientTelno": "text",
      "RecipientAddr": "text",
      "ProductNames": [
        "text"
      ],
      "Seller_Pickup_Request_Time": "text",
      "Delivery_Type": "text",
      "Shipping_Nation": "text",
      "Shipping_Warehouse": "text",
      "Shipping_Way": "text",
      "_3PL_Job_Time": "text",
      "Receiver_First_Contact": "text",
      "TrackingList": [
        {
          "Status": 1,
          "StatusDesc": "text",
          "IssueDateTime": "text",
          "IssueDetail": "text",
          "Location": "text"
        }
      ]
    }
  ],
  "Message": "text",
  "Code": 1
}

주문-배송상태 조회

post

조회조건에 해당하는 주문의 배송상태를 조회합니다.

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

RegNoListstring[]Required

접수번호 목록 (최대 100건)

TypestringOptional

주문번호 형식 regno : 접수번호(기본값) ordno : 주문번호 delvno : 택배번호

ApiKeystringRequired

APIKey 테스트 KEY:7abd72462c794016849abe4be

Responses

200

sucess

application/jsontext/jsonapplication/xmltext/xml

400

Valid Fail

application/jsontext/jsonapplication/xmltext/xml

post

/api/v1/invoice/get/shipping-status

HTTPcURLJavaScriptPython

POST /api/v1/invoice/get/shipping-status HTTP/1.1
Host: api.etomars.com
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "RegNoList": [
    "TEST230106-003",
    "TEST230106-999"
  ],
  "Type": "ordno",
  "ApiKey": "XXXXXXXXXXXXXXXXXXXXXXXXX"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

{
  "Data": [
    {
      "RequestNo": "text",
      "RegNo": "text",
      "CustomNo": "text",
      "OrderNo1": "text",
      "OrderNo2": "text",
      "DelvNo": "text",
      "DelvCom": "text",
      "DelvComName": "text",
      "Status": 1,
      "StatusDesc": "text",
      "CompletionTime": "text",
      "SagawaCode1": "text",
      "SagawaCode2": "text",
      "UPacketCode": "text"
    }
  ],
  "Message": "text",
  "Code": 1
}

예상 배송비 계산

post

Body

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

예상 배송비 계산 Request 모델

nation_codestringOptional

국가코드

real_weightstringOptional

실제 무게

service_codestringOptional

배송타입 AIR_DG, AIR_SLIM, OCEAN_REG, OTHER_COST 등

dim_unitstringOptional

박스치수단위(cm,inch)

box_widthnumber · floatOptional

박스 가로

box_lengthnumber · floatOptional

박스 세로

box_heightnumber · floatOptional

박스 높이

ApiKeystringRequired

APIKey Test KEY:7abd72462c794016849abe4be

Responses

200

OK

application/jsontext/jsonapplication/xmltext/xml

Responseobject

post

/api/v1/invoice/estShippingFee

HTTPcURLJavaScriptPython

POST /api/v1/invoice/estShippingFee HTTP/1.1
Host: api.etomars.com
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "nation_code": "text",
  "real_weight": "text",
  "service_code": "text",
  "dim_unit": "text",
  "box_width": 1,
  "box_length": 1,
  "box_height": 1,
  "ApiKey": "text"
}

application/jsontext/jsonapplication/xmltext/xmlapplication/x-www-form-urlencoded

200

OK

{}