Sweet Tracker Shipping Tracking API

https://info.sweettracker.co.kr/v2/api-docs
Admin
Sweet Tracker is a RESTful API for real-time package tracking information from 77 domestic and 59...
Tokens:2,976
Snippets:25
Trust Score:7.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Get Company List

Source: https://info.sweettracker.co.kr/v2/api-docs

Retrieves a list of all supported shipping companies. Useful for populating dropdowns or providing users with carrier options.

```APIDOC
## GET /api/v1/companylist

### Description
Retrieves a list of all supported shipping companies. Useful for populating dropdowns or providing users with carrier options.

### Method
GET

### Endpoint
/api/v1/companylist

### Parameters
#### Query Parameters
- **t_key** (string) - Required - Your issued API key

### Responses
#### Success Response (200)
- **Company** (array) - List of companies
  - **Code** (string) - Company code
  - **Name** (string) - Company name
  - **International** (boolean) - Indicates if the company handles international shipping

#### Error Responses
- **404**: Not Found. Check the 'code' and 'message' in the response body.
- **500**: Server Error.
```

--------------------------------

### Get API Key Usage

Source: https://info.sweettracker.co.kr/v2/api-docs

Retrieves the current usage statistics for your API key. Helps in monitoring your API consumption and staying within limits.

```APIDOC
## GET /api/v1/key/usage

### Description
Retrieves the current usage statistics for your API key. Helps in monitoring your API consumption and staying within limits.

### Method
GET

### Endpoint
/api/v1/key/usage

### Parameters
#### Header Parameters
- **key** (string) - Required - Your API key

### Responses
#### Success Response (200)
- **currentUsage** (integer) - Current number of API calls made.
- **limit** (integer) - The daily limit for API calls.

#### Error Responses
- **404**: API Key not found.
- **500**: Server Error.
```

--------------------------------

### Get Recommended Company

Source: https://info.sweettracker.co.kr/v2/api-docs

Recommends a shipping company based on the provided tracking number. This can help users identify the correct carrier for a given shipment.

```APIDOC
## GET /api/v1/recommend

### Description
Recommends a shipping company based on the provided tracking number. This can help users identify the correct carrier for a given shipment.

### Method
GET

### Endpoint
/api/v1/recommend

### Parameters
#### Query Parameters
- **t_invoice** (string) - Required - The tracking number
- **t_key** (string) - Required - Your issued API key

### Responses
#### Success Response (200)
- **Company** (array) - List of recommended companies
  - **Code** (string) - Company code
  - **Name** (string) - Company name
  - **International** (boolean) - Indicates if the company handles international shipping

#### Error Responses
- **404**: Not Found. Check the 'code' and 'message' in the response body.
- **500**: Server Error.
```

--------------------------------

### Get Invoice Information

Source: https://info.sweettracker.co.kr/v2/api-docs

Retrieves the shipping status and details for a given invoice number and carrier code. Response code 404 indicates an issue with the provided code and message, which should be checked in the response body.

```APIDOC
## POST /api/v2/tracking/getInvoiceInfo

### Description
Retrieves the shipping status and details for a given invoice number and carrier code. Response code 404 indicates an issue with the provided code and message, which should be checked in the response body.

### Method
POST

### Endpoint
/api/v2/tracking/getInvoiceInfo

### Parameters
#### Query Parameters
- **t_code** (string) - Required - 택배사 코드 (Carrier code)
- **t_invoice** (string) - Required - 운송장 번호 (Invoice number)
- **t_key** (string) - Required - 발급받은 키 (Issued key)

### Responses
#### Success Response (200)
- **TrackingInfo** - 운송장 번호 조회 결과 정상 (Normal result of invoice number inquiry)

#### Error Responses
- **101**: 발급된 고유키가 존재 하지 않음 (Issued unique key does not exist)
- **102**: 만료된 키 (Expired key)
- **103**: 키 사용량 초과 (Key usage exceeded)
- **104**: 유효하지 않은 운송장 번호 혹은 택배사 코드 입력 (Invalid invoice number or carrier code entered)
- **105**: 동일한 운송장의 하루 요청 제한 건수 초과 (Exceeded daily request limit for the same invoice number)
- **106**: 운송장 번호 조회 에러 (Invoice number inquiry error)
- **404**: code 와 msg 정보 확인 바랍니다. (Please check code and msg information.)
- **500**: 서버 에러 입니다 (Server error)
```

--------------------------------

### Get Invoice Info

Source: https://info.sweettracker.co.kr/v2/api-docs

Retrieves detailed shipping information for a given tracking number and carrier code. Handles various error codes for invalid inputs or service issues.

```APIDOC
## GET /api/v1/trackingInfo

### Description
Retrieves detailed shipping information for a given tracking number and carrier code. Handles various error codes for invalid inputs or service issues.

### Method
GET

### Endpoint
/api/v1/trackingInfo

### Parameters
#### Query Parameters
- **t_code** (string) - Required - Carrier code
- **t_invoice** (string) - Required - Tracking number
- **t_key** (string) - Required - Your issued API key

### Responses
#### Success Response (200)
- **invoiceNo** (string) - Tracking number
- **invoiceTimeline** (array) - Array of tracking events
  - **timeAccept** (string) - Time of acceptance
  - **timeCom** (string) - Time of completion
  - **remark** (string) - Description of the event
  - **codeProgress** (string) - Progress code
  - **displayYn** (string) - Display flag
  - **subThroughYn** (string) - Sub-through flag
  - **ownTelNo** (string) - Own phone number
  - **rcvnm** (string) - Receiver name
  - **senderNm** (string) - Sender name
  - **ordNo** (string) - Order number
  - **deliCorpNm** (string) - Delivery company name
  - **deliCorpEngNm** (string) - Delivery company English name
  - **deliCorpCode** (string) - Delivery company code
  - **trackingMobileImage** (string) - Mobile tracking image URL
  - **trackingWebUrl** (string) - Web tracking URL
  - **zipCode** (string) - Zip code
  - **detailAddress** (string) - Detail address
  - **address** (string) - Address
  - **goodsDetail** (string) - Goods details
  - **deliStatus** (string) - Delivery status
  - **deliCorpTel** (string) - Delivery company phone number
  - **deliCorpWebUrl** (string) - Delivery company website URL
  - **deliCorpCodeDetail** (string) - Delivery company code detail
  - **deliCorpCodeDetailUrl** (string) - Delivery company code detail URL
  - **deliCorpCodeDetailTel** (string) - Delivery company code detail phone number

#### Error Responses
- **101**: Issued unique key does not exist.
- **102**: Expired key.
- **103**: Key usage limit exceeded.
- **104**: Invalid tracking number or carrier code entered.
- **105**: Exceeded daily request limit for the same tracking number.
- **106**: Error querying tracking number.
```

--------------------------------

### Usage Information

Source: https://info.sweettracker.co.kr/apidoc

Retrieves information about the usage of your API key, including remaining quotas.

```APIDOC
## Usage Information

### Description
Retrieves information about the usage of your API key, including remaining quotas.

### Method
GET

### Endpoint
/api/v1/key/usage
```

--------------------------------

### Recommended Companies

Source: https://info.sweettracker.co.kr/apidoc

Retrieves a list of recommended shipping companies.

```APIDOC
## Recommended Companies

### Description
Retrieves a list of recommended shipping companies.

### Method
GET

### Endpoint
/api/v1/recommend
```

--------------------------------

### List of Companies

Source: https://info.sweettracker.co.kr/apidoc

Retrieves a list of all supported shipping companies and their codes.

```APIDOC
## List of Companies

### Description
Retrieves a list of all supported shipping companies and their codes.

### Method
GET

### Endpoint
/api/v1/companylist
```

--------------------------------

### Tracking Information

Source: https://info.sweettracker.co.kr/apidoc

Retrieves tracking information for a given tracking number and shipping company.

```APIDOC
## Tracking Information

### Description
Retrieves tracking information for a given tracking number and shipping company.

### Method
GET

### Endpoint
/api/v1/trackingInfo
```

```APIDOC
## Tracking Information

### Description
Retrieves tracking information for a given tracking number and shipping company.

### Method
POST

### Endpoint
/api/v1/trackingInfo
```

--------------------------------

### HTML Form for Delivery Tracking

Source: https://info.sweettracker.co.kr/apidoc

Use this HTML form to integrate delivery tracking functionality into your website. Ensure you replace placeholder values with your API key, carrier code, and invoice number. The 'action' URL can be modified to select different template styles (e.g., /tracking/1 for Cyan, /tracking/5 for Sky).

```html
<form action="https://info.sweettracker.co.kr/tracking/5" method="post">
            <div class="form-group">
              <label for="t_key">API key</label>
              <input type="text" class="form-control" id="t_key" name="t_key" placeholder="제공받은 APIKEY">
            </div>
            <div class="form-group">
              <label for="t_code">택배사 코드</label>
              <input type="text" class="form-control" name="t_code" id="t_code" placeholder="택배사 코드">
            </div>
            <div class="form-group">
              <label for="t_invoice">운송장 번호</label>
              <input type="text" class="form-control" name="t_invoice" id="t_invoice" placeholder="운송장 번호">
            </div>
            <button type="submit" class="btn btn-default">조회하기</button>
        </form>
```
Tokens:
Raw