Openpath orgs/parcels API
The orgs/parcels API from Openpath — 12 operation(s) for orgs/parcels.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/openpath-orgs-parcels-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Openpath API Documentation auth Orgs/parcels API
version: 1.0.0
description: Authentication and Login
servers:
- url: https://api.openpath.com
tags:
- name: orgs/parcels
paths:
/orgs/{orgId}/parcels:
get:
summary: List active parcels
operationId: listParcels
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w<br/><br/>__Endpoint name__: listParcels'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
- name: limit
in: query
schema:
type: integer
maximum: 1000
minimum: 1
- name: offset
in: query
schema:
type: integer
default: 0
minimum: 0
- name: sort
in: query
schema:
type: string
default: recipient.identity.email
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
- name: order
in: query
schema:
type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
- name: q
in: query
schema:
type: string
- name: filter
in: query
schema:
type: string
- name: preFilter
in: query
schema:
type: string
tags:
- orgs/parcels
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
cursors:
type: object
properties:
nextCursor:
type:
- integer
- 'null'
x-alternatives:
- type:
- integer
- 'null'
- type:
- string
- 'null'
pattern: ^[a-zA-Z0-9,@._~-]+$
hasNextPage:
type: boolean
data:
type: array
items:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type:
- string
- 'null'
maxLength: 500
recipient:
type:
- object
- 'null'
properties:
id:
type:
- integer
- 'null'
opal:
type:
- string
- 'null'
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type:
- string
- 'null'
minLength: 1
firstName:
type:
- string
- 'null'
minLength: 1
lastName:
type:
- string
- 'null'
minLength: 1
nicknames:
type:
- array
- 'null'
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
required:
- id
required:
- id
- opal
- identity
statusLastUpdatedBy:
type:
- object
- 'null'
properties:
id:
type: integer
minimum: 1
fullName:
type:
- string
- 'null'
minLength: 1
email:
type: string
required:
- id
parcelPictures:
type:
- array
- 'null'
items:
type: object
properties:
id:
type: number
parcelPictureType:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
contentType:
type: string
fileName:
type: string
pictureUrl:
type:
- string
- 'null'
pictureFullSizeUrl:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
required:
- id
mailroom:
type: object
properties:
id:
type: integer
name:
type: string
timezone:
type: string
isSelfPickup:
type: boolean
isSignatureRequired:
type: boolean
required:
- id
- name
- timezone
- isSelfPickup
- isSignatureRequired
parcelStatus:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
trackingNumber:
type:
- string
- 'null'
carrier:
type:
- string
- 'null'
sender:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
parcelPickedUpAt:
type:
- string
- 'null'
format: date
scannedName:
type:
- string
- 'null'
isManualScan:
type:
- boolean
- 'null'
weight:
type:
- string
- 'null'
poNumber:
type:
- string
- 'null'
signedBy:
type:
- string
- 'null'
signedAt:
type:
- string
- 'null'
format: date
required:
- idExt
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-scopes:
- o{params.orgId}-parcelMgmtParcels:r
- o{params.orgId}-parcelMgmtParcels:w
- o:w
- o:r
- s-o:r
- s-o:w
post:
summary: Create a parcel
operationId: createParcel
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: createParcel'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
tags:
- orgs/parcels
security:
- jwt: []
responses:
'201':
description: Created
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type:
- string
- 'null'
maxLength: 500
recipient:
type:
- object
- 'null'
properties:
id:
type:
- integer
- 'null'
opal:
type:
- string
- 'null'
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type:
- string
- 'null'
minLength: 1
firstName:
type:
- string
- 'null'
minLength: 1
lastName:
type:
- string
- 'null'
minLength: 1
nicknames:
type:
- array
- 'null'
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
required:
- id
required:
- id
- opal
- identity
statusLastUpdatedBy:
type:
- object
- 'null'
properties:
id:
type: integer
minimum: 1
fullName:
type:
- string
- 'null'
minLength: 1
email:
type: string
required:
- id
parcelPictures:
type:
- array
- 'null'
items:
type: object
properties:
id:
type: number
parcelPictureType:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
contentType:
type: string
fileName:
type: string
pictureUrl:
type:
- string
- 'null'
pictureFullSizeUrl:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
required:
- id
mailroom:
type: object
properties:
id:
type: integer
name:
type: string
timezone:
type: string
isSelfPickup:
type: boolean
isSignatureRequired:
type: boolean
required:
- id
- name
- timezone
- isSelfPickup
- isSignatureRequired
parcelStatus:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
trackingNumber:
type:
- string
- 'null'
carrier:
type:
- string
- 'null'
sender:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
parcelPickedUpAt:
type:
- string
- 'null'
format: date
scannedName:
type:
- string
- 'null'
isManualScan:
type:
- boolean
- 'null'
weight:
type:
- string
- 'null'
poNumber:
type:
- string
- 'null'
signedBy:
type:
- string
- 'null'
signedAt:
type:
- string
- 'null'
format: date
required:
- idExt
meta:
type: object
properties:
accessToken:
type:
- object
- 'null'
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
type:
- object
- 'null'
properties:
isSiteSpecific:
type: boolean
siteIds:
type:
- array
- 'null'
items:
type: integer
siteIdsByScope:
type:
- object
- 'null'
properties:
string:
type:
- array
- 'null'
items:
type: integer
x-op-scopes:
- o{params.orgId}-parcelMgmtParcels:w
- o:w
- s-o:w
requestBody:
content:
application/json:
schema:
type: object
properties:
note:
type:
- string
- 'null'
maxLength: 500
trackingNumber:
type:
- string
- 'null'
carrier:
type:
- string
- 'null'
sender:
type:
- string
- 'null'
weight:
type:
- string
- 'null'
poNumber:
type:
- string
- 'null'
recipientId:
type:
- integer
- 'null'
parcelStatusId:
type: integer
mailroomId:
type: integer
isManualScan:
type:
- boolean
- 'null'
scannedName:
type:
- string
- 'null'
matchedUserIds:
type: array
items:
type: object
properties:
id:
type: integer
distance:
type: number
required:
- id
- distance
required:
- parcelStatusId
- mailroomId
delete:
summary: Delete multiple parcels
operationId: deleteParcels
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteParcels'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
tags:
- orgs/parcels
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-parcelMgmtParcels:w
- o:w
- s-o:w
requestBody:
content:
application/json:
schema:
type: array
items:
type: string
x-format:
guid: true
patch:
summary: Bulk update parcels
operationId: updateParcels
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateParcels'
parameters:
- name: orgId
in: path
required: true
schema:
type: integer
tags:
- orgs/parcels
security:
- jwt: []
responses:
'200':
description: Successful
content:
application/json:
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
cursors:
type: object
properties:
nextCursor:
type:
- integer
- 'null'
x-alternatives:
- type:
- integer
- 'null'
- type:
- string
- 'null'
pattern: ^[a-zA-Z0-9,@._~-]+$
hasNextPage:
type: boolean
data:
type: array
items:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type:
- string
- 'null'
maxLength: 500
recipient:
type:
- object
- 'null'
properties:
id:
type:
- integer
- 'null'
opal:
type:
- string
- 'null'
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type:
- string
- 'null'
minLength: 1
firstName:
type:
- string
- 'null'
minLength: 1
lastName:
type:
- string
- 'null'
minLength: 1
nicknames:
type:
- array
- 'null'
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
required:
- id
required:
- id
- opal
- identity
statusLastUpdatedBy:
type:
- object
- 'null'
properties:
id:
type: integer
minimum: 1
fullName:
type:
- string
- 'null'
minLength: 1
email:
type: string
required:
- id
parcelPictures:
type:
- array
- 'null'
items:
type: object
properties:
id:
type: number
parcelPictureType:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
contentType:
type: string
fileName:
type: string
pictureUrl:
type:
- string
- 'null'
pictureFullSizeUrl:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
required:
- id
mailroom:
type: object
properties:
id:
type: integer
name:
type: string
timezone:
type: string
isSelfPickup:
type: boolean
isSignatureRequired:
type: boolean
required:
- id
- name
- timezone
- isSelfPickup
- isSignatureRequired
parcelStatus:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
trackingNumber:
type:
- string
- 'null'
carrier:
type:
- string
- 'null'
sender:
type:
- string
- 'null'
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
parcelPickedUpAt:
type:
- string
- 'null'
format: date
scannedName:
type:
- string
- 'null'
isManualScan:
type:
- boolean
- 'null'
weight:
type:
- string
- 'null'
poNumber:
type:
- string
- 'null'
signedBy:
type:
- string
- 'null'
signedAt:
type:
- stri
# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-parcels-api-openapi.yml