How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AfterShip Locations API

The Locations API from AfterShip — 2 operation(s) for locations.

This API exposes 4 operations across 2 paths, and defines 10 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 3 base URLs: https://api.aftership.com/commerce/2026-07, https://sandbox-api.aftership.com/postmen/v3, https://api.aftership.com/postmen/v3.

4 operations 2 paths 10 schemas 2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.aftership.com/commerce/2026-07
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

AfterShip Locations API declares 1 security scheme for authenticating requests. An API key is passed in the header as as-api-key (as-api-key). By default, every request must be authenticated.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Locations 4
POST
/locations
Create a location
create-location body → 201
GET
/locations
Get locations
get-locations 3 params → 200
GET
/locations/{id}
Get location by ID
get-location-by-id 1 param → 200
PATCH
/locations/{id}
Update location by ID
update-location-by-id 1 param body → 200

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Address_with_coordinate.v1 (14 properties), Location.v3 (12 properties), Location.v1 (10 properties), Opening_hours.v1 (7 properties). Each schema is shown below with its type and property counts.

Opening_hours.v1
object
The regular opening hours of the location.
7 properties
Opening_hour_period.v1
object
The OpeningHourPeriod model provides detailed information about a location's operating hours for a specific day. It includes the start and end times, and indic…
3 properties
Meta.v1
object
The Meta model holds the metadata of the API response, including relevant error details for debugging purposes. [url](../../docs/quickstart/requesterrors.md)
4 properties 3 required
Error.v1
object
The Error model contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a huma…
2 properties
Pagination.v2
object
The Pagination holds the information for the pagination when the response contains multiple objects.
3 properties
Location.v1
object
A Location represents a warehouse, store, or other physical place used for fulfillment, order processing, and pickup settings. Location resources are scoped to…
10 properties 6 required
Address_with_coordinate.v1
object
The physical address and contact information of the location. For Location resources, firstname and lastname are joined into one contact name on write; on read…
14 properties 3 required
Meta.v3
object
Meta data object.
4 properties 2 required
Error.v3
object
Each error object contains a "path" key and an "info" key. The "path" is the JSON path of the request object to indicate the error location. The "info" is a hu…
2 properties
Location.v3
object
Location object: the description of location information
12 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aftership-locations-api-openapi.yml Raw ↑
Where this information came from

This is an independent, third-party profile of AfterShip Locations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.