Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

99 Minutos shipments API

The shipments API from 99 Minutos — 3 operation(s) for shipments.

99 Minutos shipments API is one of 9 APIs that 99 Minutos publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include shipments. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 19 schemas. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against 2 base URLs: https://delivery.99minutos.com, https://sandbox.99minutos.com.

5 operations 3 paths 19 schemas 1 DELETE3 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://delivery.99minutos.com
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

99 Minutos shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (AuthJWT).

Paths & Operations 5

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

shipments 5
GET
/api/v3/shipments/{id}
Return a shipment given an trackingId or internalKey
get-api-v3-shipments-id 1 param → 200
PATCH
/api/v3/shipments/{id}
Update the destination address of a shipment. The shipment must be in one of the following statuses: DRAFT CONFIRMED UNSUCCESSFULLPICKUP ONROADTOPICKUP COLLECTED STORED
shipments_partial_update 2 params body → 200
DELETE
/api/v3/shipments/{id}
Cancels an order by trackingId or internalKey.
delete-api-v3-shipments-id 2 params body → 200
GET
/api/v3/shipments/tracking
Track a shipment by the given identifier. Get all information about the shipments with the related events and data. Remember that if you are thinking of implementing a recurring pull system on this e…
shipments_tracking_retrieve 1 param → 200429
GET
/api/v3/shipments/tracking/batch
Batch tracking can add multiple identifiers of the following format -- /api/v3/shipments/tracking/batch?identifiers={trackingId}&identifiers={trackingId} Track a shipment by the given identifier. Get…
shipments_tracking_batch_retrieve 1 param → 200429

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are ShipmentUpdate (12 properties), Location (8 properties), Item (7 properties), Option (6 properties). Each schema is shown below with its type and property counts.

DeliveryType2faEnum
string
CurrencyEnum
string
Payment
object
Payment options are included in this section
3 properties
Option
object
Options to customize the shipment.
6 properties
PatchedShipmentUpdate
object
Update shipment serializer. Only the origin and destination fields can be updated. The deliveryType is not in read only fields because is required for the cove…
1 property
Event
object
5 properties 5 required
Sender
object
Person who will receive the shipment.
4 properties 4 required
TrackingBatchResponse
object
3 properties
TrackingResponse
object
4 properties 4 required
Location
object
Location where the package is picked up. Depending on the flow you choose, you must send different parameters. A location is a geographical point that can be t…
8 properties
Item
object
Array of items/packages to send.
7 properties 3 required
TooManyRequest
object
1 property 1 required
Recipient
object
Person who will receive the shipment.
4 properties 4 required
ItemSizeEnum
string
Embedded
object
Serializer for EmbeddedDocuments. Skips id field and uniqueness validation. When saving, skips calling instance.save
2 properties 2 required
LocationCountryEnum
string
StatusNameEnum
string
StatusCodeEnum
string
ShipmentUpdate
object
Update shipment serializer. Only the origin and destination fields can be updated. The deliveryType is not in read only fields because is required for the cove…
12 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

99-minutos-shipments-api-openapi.yml Raw ↑

Other APIs 99 Minutos publishes across the network.

99 Minutos coverage API
99 Minutos documents API
99 Minutos locations API
99 Minutos oauth API
99 Minutos Orders API
99 Minutos shipping-rates API
99 Minutos super-geocoding API
99 Minutos webhooks API