TABLE OF CONTENTS
V1 APIs
Introduction
Get Started
Api Endpoint
Authentication
Rates
Calculate Insurance Rate
Validations
Create Shipment
Zapier APIs
Authentication
Get Stores
Rates
Create Shipment
Get Shipments
Shipment Tracking
V1 APIs
Introduction
PostMerica API is a cutting-edge shipping solution that revolutionizes the way businesses handle their shipping operations. With a focus on affordability and convenience, PostMerica API offers a comprehensive suite of services that include printing shipment labels at low cost and providing real-time tracking capabilities.
The primary feature of PostMerica API is its ability to generate and print shipment labels at significantly reduced costs. By integrating with the API, businesses can seamlessly generate labels for their shipments directly from their own applications or websites. This eliminates the need for manual label creation or reliance on expensive third-party solutions, saving both time and money. With the low-cost printing service, businesses can enjoy substantial cost savings while maintaining a high level of efficiency in their shipping processes.
In addition to cost-effective label printing, PostMerica API offers robust tracking functionality. Businesses can provide their customers with the ability to track their shipments in real-time, ensuring transparency and enhancing the overall customer experience. The tracking feature allows users to monitor the progress of their packages from the moment they are picked up until they reach their final destinations. This level of visibility empowers both businesses and customers to stay informed, anticipate any potential issues, and proactively manage their shipping operations.
PostMerica API boasts a user-friendly interface and provides seamless integration capabilities, making it easy for businesses to incorporate the service into their existing systems. Whether its an e-commerce platform, inventory management software, or a custom-built application, PostMerica API can seamlessly integrate with various platforms, enabling businesses to streamline their shipping processes and enhance overall operational efficiency.
With its low-cost label printing service and comprehensive tracking capabilities, PostMerica API is an ideal choice for businesses seeking an affordable shipping solution without compromising on quality. By leveraging this powerful API, businesses can optimize their shipping operations, improve customer satisfaction, and ultimately drive growth and success in their industry.
Get Started
The API offered by this service requires users to include an api-key and api-secret in the headers of each request in order to process the request successfully. To obtain these keys, visit Api Keys, click Generate API key to generate your API key and API secret.
API Endpoint
https://ship.postmerica.com/apis/api/v1All endpoints are only accessible via HTTPS and are located at ship.postmerica.com
Authentication
How to get your API Key?
Visit API keys. Click Generate API key to generate your API key.The API Key method is a more straightforward authentication method that only verifies whether the API Key value is correct or not.
Rates fayyaz GET
https://ship.postmerica.com/apis/api/v1/ratesRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Response Example fayyaz
{
"status": 200,
"data": [
{
"carrier_name": [String],
"service_name": [String],
"description": [String],
"service_key": [String],
"price": [Float],
"above_five_lbs_price": [Float]
}
]
}Validations GET
https://ship.postmerica.com/apis/api/v1/validationsRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Response Example
{
"status": 200,
"data": [
{
"carrier_name": [String],
"validations": [Object]
]
}Calculate Insurance Rate POST
https://ship.postmerica.com/apis/api/v1/calculate-insurance-rateRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Required Body
{
"cost_of_shipment": [Float]
}| cost_of_shipment | float | Cost of Shipment | Required |
Response Example
{
"status": 200,
"cost_of_insurance": [Float]
}Create Shipment POST
https://ship.postmerica.com/apis/api/v1/create-shipmentRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Required Body
{
"carrier": [String],
"service_key": [String],
"from": {
"name": [String],
"company": [String],
"phone": [String],
"street1": [String],
"street2": [String],
"city": [String],
"state": [String],
"country": [String],
"zip": [String]
},
"to": {
"name": [String],
"company": [String],
"phone": [String],
"street1": [String],
"street2": [String],
"city": [String],
"state": [String],
"country": [String],
"zip": [String]
},
"misc": {
"length": [Float],
"width": [Float],
"height": [Float],
"weight": [Float]
},
"options": {
"is_insured": [Boolean],
"cost_of_shipment": [Float],
"receiver_signature": [Boolean],
"address_validation": [Boolean],
"label_format": [String]
}
}| carrier | string | Carrier name i.e. UPS | Required |
|---|---|---|---|
| service_key | string | Service key | Required |
from
| name | string | Name of shipped from | Required |
|---|---|---|---|
| company | string | Shipped from company name | |
| phone | string | Shipped from phone number | Required |
| street1 | string | Shipped from address line 1 | Required |
| street2 | string | Shipped from address line 2 | Required |
| city | string | Shipped from city | Required |
| state | string | Shipped from state (Must be in state code i.e. TX) | Required |
| country | string | Shipped from country (Must be in country code i.e. US) | Required |
to
| name | string | Name of shipping to | Required |
|---|---|---|---|
| company | string | Shipping to company name | |
| phone | string | Shipping to phone number | Required |
| street1 | string | Shipping to address line 1 | Required |
| street2 | string | Shipping to address line 2 | Required |
| city | string | Shipping to city | Required |
| state | string | Shipping to state (Must be in state code i.e. TX) | Required |
| country | string | Shipping to country (Must be in country code i.e. US) | Required |
misc
| length | float | Shipment length (in inches) | Required |
| width | float | Shipment width (in inches) | Required |
| height | float | Shipment height (in inches) | Required |
| weight | float | Shipment weight (in lbs) | Required |
options
| is_insured | boolean | Package insurance | Required |
| cost_of_shipment | float | Cost of shipment | Required (if is_insured is true) |
| receiver_signature | boolean | Receiver Signature | Required |
| address_validation | boolean | Validate shipment from/to address through Google if set true | Required |
| label_format | string | PDF or ZPL (Only applicable on USPS services) |
Response Example
Response contain pdf of created shipment label with shipment information attached in response headers.
Response Header
| File-Name | Name of shipment label file |
| Order-Id | PostMerica order id of shipment label |
| Tracking-Id | PostMerica tracking id of shipment label |
| Service-Price | Service price applied on shipment label |
| Time | Response time of shipment label |
Zapier APIs
Authentication GET
https://ship.postmerica.com/apis/api/v1/authRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Response Example
{
"status": 200,
"message": [String]
}Get Stores GET
https://ship.postmerica.com/apis/api/v1/storesRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Response Example
[
{
"id": [Integer],
"name": [String],
"store_type": [String]
}
]Rates GET
https://ship.postmerica.com/apis/api/v1/rates-zapierRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Response Example
[
{
"carrier_name": [String],
"service_name": [String],
"description": [String],
"service_key": [String],
"price": [Float],
"above_five_lbs_price": [Float]
}
]Create Shipment POST
https://ship.postmerica.com/apis/api/v1/create-shipment-zapierRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Required Body
{
"store_id": [Int],
"order_number": [String],
"carrier": [String],
"service_key": [String],
"from": {
"name": [String],
"company": [String],
"phone": [String],
"street1": [String],
"street2": [String],
"city": [String],
"state": [String],
"country": [String],
"zip": [String]
},
"to": {
"name": [String],
"company": [String],
"phone": [String],
"street1": [String],
"street2": [String],
"city": [String],
"state": [String],
"country": [String],
"zip": [String]
},
"misc": {
"length": [Float],
"width": [Float],
"height": [Float],
"weight": [Float]
},
"options": {
"is_insured": [Boolean],
"cost_of_shipment": [Float],
"receiver_signature": [Boolean],
"address_validation": [Boolean]
}
}| store_id | int | Store Id (Default null) | |
| order_number | string | Store order number | Required (If store_id provided) |
| carrier | string | Carrier name i.e. UPS | Required |
| service_key | string | Service key | Required |
from
| name | string | Name of shipped from | Required |
| company | string | Shipped from company name | |
| phone | string | Shipped from phone number | Required |
| street1 | string | Shipped from address line 1 | Required |
| street2 | string | Shipped from address line 2 | Required |
| city | string | Shipped from city | Required |
| state | string | Shipped from state (Must be in state code i.e. TX) | Required |
| country | string | Shipped from country (Must be in country code i.e. US) | Required |
to
| name | string | Name of shipping to | Required |
| company | string | Shipping to company name | |
| phone | string | Shipping to phone number | Required |
| street1 | string | Shipping to address line 1 | Required |
| street2 | string | Shipping to address line 2 | Required |
| city | string | Shipping to city | Required |
| state | string | Shipping to state (Must be in state code i.e. TX) | Required |
| country | string | Shipping to country (Must be in country code i.e. US) | Required |
misc
| length | float | Shipment length (in inches) | Required |
| width | float | Shipment width (in inches) | Required |
| height | float | Shipment height (in inches) | Required |
| weight | float | Shipment weight (in lbs) | Required |
options
| is_insured | boolean | Package insurance | Required |
|---|---|---|---|
| cost_of_shipment | float | Cost of shipment | Required (if is_insured is true) |
| receiver_signature | boolean | Receiver Signature | Required |
| address_validation | boolean | Validate shipment from/to address through Google if set true | Required |
Response Example
[{
'id': [String],
'pdf': [String],
'File-Name': [String],
'Order-Id': [String],
'Tracking-Id': [String],
'Service-Price': [Float],
'Time': [String]
}]Get Shipments POST
https://ship.postmerica.com/apis/api/v1/get-completed-ordersRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Required Body
{
"store_id": 0
}Response Example
[{[Shipment Objects}]Shipment Tracking POST
https://ship.postmerica.com/apis/api/v1/get-order-trackingRequired Headers
| Header Name | Example |
|---|---|
| api-key | ps_key_C1ThsK*****... |
| api-key | ps_secret_cAd0Y*****... |
| Header Name | Example |
| api-key | ps_key_C1ThsK0YxKGqoAL*************** |
| api-key | ps_secret_cAdxFrkYFDOjnQHy4crD*************** |
Required Body
{
"order_id": [Order ID],
"tracking_code": [Tracking Code]
}Response Example
[{[Shipment Tracking Objects}]
Postmerica 2024