# Introduction

SuperShip APIs is a set of application programming interfaces (APIs) provided by SuperShip. These APIs allow developers and businesses to integrate SuperShip's shipping services into their applications.

# Brand Name

Please use the SuperShip brand name correctly as follows, valued partners and customers:

• Correct: SuperShip (note that both "S" characters must be capitalized), SUPERSHIP
• Incorrect: Supership (second "S" is not capitalized), suppership (extra "p" added), shupership (extra "h" added at the beginning), supersip (missing "h" at the end)...

# Logo

Customers and partners who wish to display the SuperShip logo can use the following resources:

• Red Square Logo PNG: View
• Red Square Logo SVG: View
• Red Landscape Logo PNG: View
• White Landscape Logo PNG: View
• Red Background White Square Logo PNG: View
• White Background Red Square Logo PNG: View
• Standard Vertical Logo PNG: View

# Contact

Customers and partners in need of support or collaboration can contact us via:

• Telegram: SuperShip Support APIs
• Email: supertek@supership.vn

# Request Format

• The Accept value in the request header must be application/json.
• The Content-Type value in the request header must be application/json.

# Response Format

The value will be in JSON format when the request includes Accept header with a value of application/json.

# Success

{
    "status": "Success",
    "message": "<Message-Content>",
    "results": "<Successful-Data>"
}

# Failure

{
    "status": "Error",
    "message": "<Error-Description>",
    "errors": "<Error-Detail-Information>"
}

# Environment

• URL Production: https://api.mysupership.vn
• URL Sandbox: Currently under maintenance, please use the test account provided by SuperShip to test directly on Production. Please join the API Support Group on Telegram SuperShip Support APIs for assistance.

# Features

• Areas API: This API allows developers to retrieve a list of provinces, districts, and communes supported by SuperShip for the pickup, delivery, and return of goods.
• Auth API: This API allows developers to register a new user and retrieve a token via username and password.
• Orders API: This API allows developers to retrieve shipping rates, create a new order, retrieve order information, obtain order status lists, and generate shipping labels.
• Warehouses API: This API allows developers to create a new warehouse, edit the current warehouse, and retrieve information on all warehouses.
• Webhooks API: This API allows developers to register a new webhook, edit the current webhook, and retrieve registered webhooks.