# QUICKSTART API

## Quick Start

- [API Quick Start](/content/docs/shipping/quickstart/api-quick-start/index.html)
- [Authentication](/content/docs/shipping/quickstart/authentication/index.html)
- [SignString](/content/docs/shipping/quickstart/authentication/sign-string/index.html)

## OAuth

- [Overview](/content/docs/shipping/quickstart/authentication/oauth/overview/index.html)
- [Getting Started](/content/docs/shipping/quickstart/authentication/oauth/getting-started/index.html)
- [Scope List](/content/docs/shipping/quickstart/authentication/oauth/available-scopes/index.html)
- [Rate Limit](/content/docs/shipping/quickstart/rate-limit/index.html)
- [Body Envelope](/content/docs/shipping/quickstart/body-envelope/index.html)
- [Request Errors](/content/docs/shipping/quickstart/request-errors/index.html)

## CHANGELOG

- [Changelog](/content/docs/shipping/changelog/index.html)

## REFERENCE

- [API Overview v3](/content/docs/shipping/260ddb42f20a9-api-overview/index.html)

### Rates

- [Get rates](/content/docs/shipping/99f88b084657b-get-rates/index.html)
- [Calculate rates](/content/docs/shipping/f4353677b8ac1-calculate-rates/index.html)
- [Get a rate](/content/docs/shipping/dc0944cbb5839-get-a-rate/index.html)

### Labels

- [Get labels](/content/docs/shipping/c056230c3b6c4-get-labels/index.html)
- [Create a label](/content/docs/shipping/c665e0489b6d9-create-a-label/index.html)
- [Get a label](/content/docs/shipping/1aa84af009bb2-get-a-label/index.html)

### Manifests

- [Get manifests](/content/docs/shipping/8ba86e501d12e-get-manifests/index.html)
- [Create a manifest](/content/docs/shipping/467d57d8c1766-create-a-manifest/index.html)
- [Get a manifest](/content/docs/shipping/9ca3cc790beee-get-a-manifest/index.html)

### Couriers

- [Get all couriers](/content/docs/shipping/89c99df22fcd7-get-all-couriers/index.html)

### Cancel Labels

- [Get the cancelled labels](/content/docs/shipping/24ec02f862c50-get-the-cancelled-labels/index.html)
- [Cancel a label](/content/docs/shipping/4c82fee7cfe54-cancel-a-label/index.html)
- [Get a cancelled label](/content/docs/shipping/f173ecb472bca-get-a-cancelled-label/index.html)

### Pickups

- [Get pickups](/content/docs/shipping/x8mxu5wa7m6y3-get-pickups/index.html)
- [Create a pickup](/content/docs/shipping/bzel9ue0joeds-create-a-pickup/index.html)
- [Get a pickup](/content/docs/shipping/ytjdnwbl7dqxb-get-a-pickup/index.html)

### Cancel Pickups

- [Get the cancelled pickups](/content/docs/shipping/35p8o3dsqpaqc-get-the-cancelled-pickups/index.html)
- [Cancel a pickup](/content/docs/shipping/nmi7kbs8wavn2-cancel-a-pickup/index.html)
- [Get a cancelled pickup](/content/docs/shipping/lgdp9svgf645n-get-a-cancelled-pickup/index.html)

### Shipper Accounts

- [Get shipper accounts](/content/docs/shipping/5742112a2c755-get-shipper-accounts/index.html)
- [Create a shipper account](/content/docs/shipping/02bbb6a0e0b27-create-a-shipper-account/index.html)
- [Get a shipper account](/content/docs/shipping/51195022963fd-get-a-shipper-account/index.html)
- [Delete a shipper account](/content/docs/shipping/cef1918aaf9df-delete-a-shipper-account/index.html)
- [Update a shipper account's information](/content/docs/shipping/a57d4ec851992-update-a-shipper-account-s-information/index.html)
- [Update a shipper account's credentials](/content/docs/shipping/093809311940d-update-a-shipper-account-s-credentials/index.html)
- [Update a shipper account's settings](/content/docs/shipping/0xlo21h5n3o1j-update-a-shipper-account-s-settings/index.html)

### Specific Shipper Accounts

- [Create a FedEx shipper account](/content/docs/shipping/c1hmaoymtcjf2-create-a-fed-ex-shipper-account/index.html)
- [Update a FedEx shipper account](/content/docs/shipping/alkwtehrfwa1s-update-a-fed-ex-shipper-account/index.html)

### Address Validations (Beta)

- [Create an address validation](/content/docs/shipping/f88a36ecf54a2-create-an-address-validation/index.html)

### Locations

- [Get locations](/content/docs/shipping/bdb851fc7dfdc-get-locations/index.html)

# MODEL

## Envelope

- [Meta v3](/content/docs/shipping/model/envelope/meta/index.html)
- [Error v3](/content/docs/shipping/model/envelope/error/index.html)

## Primitive

- [Billing v3](/content/docs/shipping/model/primitive/billing/index.html)
- [Customs v3](/content/docs/shipping/model/primitive/customs/index.html)
- [Shipment v3](/content/docs/shipping/model/primitive/shipment/index.html)
- [Address v3](/content/docs/shipping/model/primitive/address/index.html)
- [Parcel v3](/content/docs/shipping/model/primitive/parcel/index.html)
- [Item v3](/content/docs/shipping/model/primitive/item/index.html)
- [Courier v3](/content/docs/shipping/model/primitive/courier/index.html)
- [Reference v3](/content/docs/shipping/model/primitive/reference/index.html)
- [Money v3](/content/docs/shipping/model/primitive/money/index.html)
- [PaymentMethodAccount v3](/content/docs/shipping/model/primitive/payment-method-account/index.html)
- [Dimension v3](/content/docs/shipping/model/primitive/dimension/index.html)
- [Weight v3](/content/docs/shipping/model/primitive/weight/index.html)
- [Volume v3](/content/docs/shipping/model/primitive/volume/index.html)
- [Aes v3](/content/docs/shipping/model/primitive/aes/index.html)
- [NoEei v3](/content/docs/shipping/model/primitive/no-eei/index.html)

## Resource

- [Rate v3](/content/docs/shipping/model/resource/rate/index.html)
- [RateRecord v3](/content/docs/shipping/model/resource/rate-record/index.html)
- [Label v3](/content/docs/shipping/model/resource/label/index.html)
- [Manifest v3](/content/docs/shipping/model/resource/manifest/index.html)
- [ShipperAccount v3](/content/docs/shipping/model/resource/shipper-account/index.html)
- [CancelLabel v3](/content/docs/shipping/model/resource/cancel-label/index.html)
- [AddressValidation (Beta) v3](/content/docs/shipping/model/resource/address-validation/index.html)
- [Location v3](/content/docs/shipping/model/resource/location/index.html)
- [Pickup v3](/content/docs/shipping/model/resource/pickups/index.html)
- [CancelPickup v3](/content/docs/shipping/model/resource/cancel-pickup/index.html)

## Carrier Guide

- [Supported Carriers](/content/docs/shipping/carrier-guide-supported-couriers/index.html)

## ENUM

- [Shipper Accounts Credentials](/content/docs/shipping/enum/shipper-accounts-credentials/index.html)
- [Service Types and Service Options List](/content/docs/shipping/enum/service-options-lists/index.html)
- [All Service Options](/content/docs/shipping/enum/all-service-options/index.html)

## Webhook

- [Webhook Overview](/content/docs/shipping/webhook/webhook-overview/index.html)
- [Webhook Specifications](/content/docs/shipping/webhook/webhook-specifications/index.html)
- [Webhook Signature](/content/docs/shipping/webhook/webhook-signature/index.html)
- [Webhook Outgoing IPs](/content/docs/shipping/webhook/webhook-outgoing-ips/index.html)

## SDK

- [Java SDK](https://github.com/AfterShip/shipping-sdk-java)
- [Node.js SDK](https://github.com/postmen/postmen-sdk-js)

## Open Source

- [phone](https://github.com/AfterShip/phone)
- [email-verifier](https://github.com/AfterShip/email-verifier)

## Support

- [Contact Support](https://support.postmen.com/en/)

# Get a rate

**GET**

`https://sandbox-api.aftership.com/postmen/v3/rates/{id}`

## Request

### Security: API Key

### Path Parameters

- `id` (string, required): Rate id

### Headers

- `Content-Type` (string, required): Content-Type  
  **Default**: application/json  
  **Example**: application/json

## Responses

### 200

**Get rate**

### Body:  
`application/json`

#### meta
- **Meta**: Meta data object.  
  **Example**: {"code":200,"type":"OK","message":"Everything worked as expected."}

- **code** (integer, required): Code of Meta
- **message** (string, required): Message of Meta
- **details** (array[Error]): Details of Meta
- **retryable** (boolean): Whether this request will be retryable or not

#### data
- **RateRecord**: RateRecord object: the description of rates information
  - **created_at** (string): the timestamp of created_at, example: 2022-05-18T09:17:38+00:00
  - **id** (string): rate id
  - **updated_at** (string): the timestamp of updated_at, example: 2022-05-18T09:17:38+00:00
  - **status** (string): Allowed values: calculating, calculated, failed
  - **rates** (array[Rate]): rates array

### Auth
- **as-api-key**:

### Send API Request
### API Overview

**Request Sample: Shell / cURL**

```bash
curl --request GET \
  --url https://sandbox-api.aftership.com/postmen/v3/rates/id \
  --header 'Content-Type: application/json' \
  --header 'as-api-key: '
```

### Response Example

```json
{
  "meta": {
    "code": 200,
    "type": "OK",
    "message": "Everything worked as expected."
  },
  "data": {
    "created_at": "2015-09-09T07:49:54.060Z",
    "id": "ad1f9340-608d-4a30-be0e-b0a62e07e4cc",
    "updated_at": "2015-09-09T07:49:57.360Z",
    "status": "calculated",
    "rates": [
      {
        "charge_weight": {
          "value": 1.5,
          "unit": "kg"
        },
        "total_charge": {
          "amount": 429.57,
          "currency": "HKD"
        },
        "shipper_account": {
          "id": "00000000-0000-0000-0000-000000000000",
          "slug": "dhl",
          "description": "DHL Sandbox"
        },
        "service_type": "dhl_express_worldwide",
        "service_name": "dhl_express_worldwide",
        "pickup_deadline": "2015-09-01T18:00:00+00:00",
        "booking_cut_off": "2015-09-01T17:00:00+00:00",
        "delivery_date": "2015-09-01T23:00:00+00:00",
        "transit_time": 1,
        "detailed_charges": [
          {
            "type": "base",
            "charge": {
              "amount": 387,
              "currency": "HKD"
            }
          },
          {
            "type": "fuel_surcharge",
            "charge": {
              "amount": 42.57,
              "currency": "HKD"
            }
          }
        ],
        "error_message": null,
        "info_message": null
      }
    ]
  }
}
```