Openpath orgs/parcels API
The orgs/parcels API from Openpath — 12 operation(s) for orgs/parcels.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/parcels API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
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:
- type: integer
name: orgId
in: path
required: true
- type: integer
minimum: 1
maximum: 1000
name: limit
in: query
- type: integer
default: 0
minimum: 0
name: offset
in: query
- type: string
default: recipient.identity.email
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
name: sort
in: query
- type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
name: order
in: query
- type: string
name: q
in: query
- type: string
name: filter
in: query
- type: string
name: preFilter
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/parcels
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
cursors:
type: object
properties:
nextCursor:
type: integer
x-nullable: true
x-alternatives:
- type: integer
x-nullable: true
- type: string
pattern: ^[a-zA-Z0-9,@._~-]+$
x-nullable: true
hasNextPage:
type: boolean
data:
type: array
items:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type: string
maxLength: 500
x-nullable: true
recipient:
x-nullable: true
type: object
properties:
id:
type: integer
x-nullable: true
opal:
type: string
x-nullable: true
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
firstName:
type: string
minLength: 1
x-nullable: true
lastName:
type: string
minLength: 1
x-nullable: true
nicknames:
x-nullable: true
type: array
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
required:
- id
required:
- id
- opal
- identity
statusLastUpdatedBy:
x-nullable: true
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
email:
type: string
required:
- id
parcelPictures:
x-nullable: true
type: array
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
x-nullable: true
pictureFullSizeUrl:
type: string
x-nullable: true
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
x-nullable: true
carrier:
type: string
x-nullable: true
sender:
type: string
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
parcelPickedUpAt:
type: string
format: date
x-nullable: true
scannedName:
type: string
x-nullable: true
isManualScan:
type: boolean
x-nullable: true
weight:
type: string
x-nullable: true
poNumber:
type: string
x-nullable: true
signedBy:
type: string
x-nullable: true
signedAt:
type: string
format: date
x-nullable: true
required:
- idExt
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
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:
- type: integer
name: orgId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
note:
type: string
maxLength: 500
x-nullable: true
trackingNumber:
type: string
x-nullable: true
carrier:
type: string
x-nullable: true
sender:
type: string
x-nullable: true
weight:
type: string
x-nullable: true
poNumber:
type: string
x-nullable: true
recipientId:
type: integer
x-nullable: true
parcelStatusId:
type: integer
mailroomId:
type: integer
isManualScan:
type: boolean
x-nullable: true
scannedName:
type: string
x-nullable: true
matchedUserIds:
type: array
items:
type: object
properties:
id:
type: integer
distance:
type: number
required:
- id
- distance
required:
- parcelStatusId
- mailroomId
consumes:
- application/json
produces:
- application/json
tags:
- orgs/parcels
security:
- jwt: []
responses:
'201':
schema:
type: object
properties:
data:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type: string
maxLength: 500
x-nullable: true
recipient:
x-nullable: true
type: object
properties:
id:
type: integer
x-nullable: true
opal:
type: string
x-nullable: true
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
firstName:
type: string
minLength: 1
x-nullable: true
lastName:
type: string
minLength: 1
x-nullable: true
nicknames:
x-nullable: true
type: array
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
required:
- id
required:
- id
- opal
- identity
statusLastUpdatedBy:
x-nullable: true
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
email:
type: string
required:
- id
parcelPictures:
x-nullable: true
type: array
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
x-nullable: true
pictureFullSizeUrl:
type: string
x-nullable: true
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
x-nullable: true
carrier:
type: string
x-nullable: true
sender:
type: string
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
parcelPickedUpAt:
type: string
format: date
x-nullable: true
scannedName:
type: string
x-nullable: true
isManualScan:
type: boolean
x-nullable: true
weight:
type: string
x-nullable: true
poNumber:
type: string
x-nullable: true
signedBy:
type: string
x-nullable: true
signedAt:
type: string
format: date
x-nullable: true
required:
- idExt
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Created
x-op-scopes:
- o{params.orgId}-parcelMgmtParcels:w
- o:w
- s-o:w
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:
- type: integer
name: orgId
in: path
required: true
- in: body
name: body
schema:
type: array
items:
type: string
x-format:
guid: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/parcels
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-parcelMgmtParcels:w
- o:w
- s-o:w
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:
- type: integer
name: orgId
in: path
required: true
- in: body
name: body
schema:
type: array
items:
type: object
properties:
note:
type: string
maxLength: 500
x-nullable: true
trackingNumber:
type: string
x-nullable: true
carrier:
type: string
x-nullable: true
sender:
type: string
x-nullable: true
weight:
type: string
x-nullable: true
poNumber:
type: string
x-nullable: true
recipientId:
type: integer
x-nullable: true
idExt:
type: string
x-format:
guid: true
parcelStatusId:
type: integer
mailroomId:
type: integer
required:
- idExt
consumes:
- application/json
produces:
- application/json
tags:
- orgs/parcels
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
cursors:
type: object
properties:
nextCursor:
type: integer
x-nullable: true
x-alternatives:
- type: integer
x-nullable: true
- type: string
pattern: ^[a-zA-Z0-9,@._~-]+$
x-nullable: true
hasNextPage:
type: boolean
data:
type: array
items:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type: string
maxLength: 500
x-nullable: true
recipient:
x-nullable: true
type: object
properties:
id:
type: integer
x-nullable: true
opal:
type: string
x-nullable: true
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
firstName:
type: string
minLength: 1
x-nullable: true
lastName:
type: string
minLength: 1
x-nullable: true
nicknames:
x-nullable: true
type: array
items:
type: object
properties:
nickname:
type: string
minLength: 1
maxLength: 100
email:
type: string
required:
- id
required:
- id
- opal
- identity
statusLastUpdatedBy:
x-nullable: true
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
email:
type: string
required:
- id
parcelPictures:
x-nullable: true
type: array
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
x-nullable: true
pictureFullSizeUrl:
type: string
x-nullable: true
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
x-nullable: true
carrier:
type: string
x-nullable: true
sender:
type: string
x-nullable: true
createdAt:
type: string
format: date
updatedAt:
type: string
format: date
parcelPickedUpAt:
type: string
format: date
x-nullable: true
scannedName:
type: string
x-nullable: true
isManualScan:
type: boolean
x-nullable: true
weight:
type: string
x-nullable: true
poNumber:
type: string
x-nullable: true
signedBy:
type: string
x-nullable: true
signedAt:
type: string
format: date
x-nullable: true
required:
- idExt
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-parcelMgmtParcels:w
- o:w
- s-o:w
/orgs/{orgId}/parcels/{parcelIdExt}:
get:
summary: Describe a parcel
operationId: describeParcel
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__: describeParcel'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: string
x-format:
guid: true
name: parcelIdExt
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/parcels
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
idExt:
type: string
x-format:
guid: true
note:
type: string
maxLength: 500
x-nullable: true
recipient:
x-nullable: true
type: object
properties:
id:
type: integer
x-nullable: true
opal:
type: string
x-nullable: true
identity:
type: object
properties:
id:
type: integer
minimum: 1
fullName:
type: string
minLength: 1
x-nullable: true
firstName:
type: string
minLength: 1
x-nullable: true
lastName:
type: string
minLength: 1
x-nullable: true
nicknames:
x-nullable: true
type: array
items:
type: object
properties:
# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openpath/refs/heads/main/openapi/openpath-orgs-parcels-api-openapi.yml