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

SERTICA Shipments API

The Shipments API from SERTICA — 25 operation(s) for shipments.

SERTICA Shipments API is one of 254 APIs that SERTICA 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, API documentation, an API reference, and authentication docs.

This API exposes 29 operations across 25 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against a single base URL, /api.

29 operations 25 paths 31 schemas 1 DELETE17 GET10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://{sitename}.sertica.com/api
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

SERTICA Shipments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (Bearer).

  • Bearer — JWT Authorization header using the Bearer scheme

Paths & Operations 29

Across 25 paths, the API surfaces 29 operations — 1 DELETE, 17 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Shipments 29
GET
/Shipments
Gets a list of Shipments
GetShipments 2 params → 200401403500
POST
/Shipments
Creates a new Shipment record
CreateShipment body → 201400401403500
GET
/Shipments/{shipmentNo}
Gets a specific Shipment
GetShipment 1 param → 200400404401403500
PUT
/Shipments/{shipmentNo}
Updates an existing Shipment
UpdateShipment 1 param body → 200400404401403500
DELETE
/Shipments/{shipmentNo}
Deletes a Shipment record
deleteShipmentsByShipmentNo 1 param → 204400404401403500
GET
/Shipments/{shipmentNo}/history
Gets history for a specific Shipment
GetShipmentHistory 3 params → 200400404401403500
GET
/Shipments/{ShipmentNo}/copy
Copies an existing Shipment to a new object
CopyShipment 1 param → 200400401403500
GET
/Shipments/searchInfo
Returns structured information about what and how you can search for
ShipmentSearchInfo → 200403500
POST
/Shipments/search
Search for Shipments.
SearchShipments 2 params body → 200400401403500
POST
/Shipments/searchCount
Returns number of hits in a search for Shipments Takes a SearchDefinition…
SearchCountShipments body → 200401403500
POST
/Shipments/searchIndex/{shipmentGuid}
Get index of a record in a search for Shipments Takes a SearchDefinition input…
SearchIndexShipments 1 param body → 200400401403500
GET
/Shipments/{shipmentNo}/documents
Returns a list of Documents used on the Shipment
GetShipmentDocuments 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/destinationWarehouses
Returns a list of DestinationWarehouses used on the Shipment
GetShipmentDestinationWarehouses 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/markings
Returns a list of Markings used on the Shipment
GetShipmentMarkings 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/pickupWarehouses
Returns a list of PickupWarehouses used on the Shipment
GetShipmentPickupWarehouses 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/freightDetails
Returns a list of FreightDetails used on the Shipment
GetShipmentFreightDetails 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/responses
Returns a list of Responses used on the Shipment
GetShipmentResponses 1 param → 200400404401403500
POST
/Shipments/{shipmentNo}/responses
Creates a new ShipmentResponse for the Shipment
CreateShipmentResponse 1 param body → 200400404401403500
GET
/Shipments/{shipmentNo}/responses/count
Returns the number of Responses on a specific Shipment
GetShipmentResponsesCount 1 param → 200400401403500
GET
/Shipments/{shipmentNo}/unassignedCarriers
Returns a list of Unassigned Carriers (ShipmentCarriers) used on the Shipment
GetShipmentUnassignedCarriers 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/markingCarriers
Returns a list of all Marking Carriers used on the Shipment
GetShipmentMarkingCarriers 1 param → 200400404401403500
GET
/Shipments/{shipmentNo}/markings/{markingNo}/carriers
Returns a list of all Marking Carriers used on a specific Marking on the…
GetMarkingCarriers 2 params → 200400404401403500
GET
/Shipments/reports
Gets shipment picking list reports based on selected report numbers from user…
GetShipmentReportsFromUserSettings 2 params → 400200404401403500
GET
/Shipments/{shipmentNos}/reports
Gets shipment reports for the supplied shipment numbers
GetShipmentReports 3 params → 400200404401403500
POST
/Shipments/{shipmentNo}/send
Send a specific Shipment
SendShipment 1 param → 200400404401403500
POST
/Shipments/{shipmentNo}/cancel
Cancel a specific Shipment
CancelShipment 1 param → 200400404401403500
POST
/Shipments/{shipmentNo}/receive
Receive a specific Warehouse Shipment Warning: This endpoint is not compatible…
ReceiveWarehouseShipment 2 params → 200400404401403500
POST
/Shipments/{shipmentNo}/unreceive
Unreceive a specific Warehouse Shipment
UndoReceiveWarehouseShipment 1 param → 200400404401403500
POST
/Shipments/{shipmentNo}/mail
Mail a specific Shipment to either type Consignee or FreightForwarder
MailShipment 1 param body → 200400404401403500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are SerticaWebApi.Models.Distribution.Shipment (53 properties), SerticaWebApi.Models.Distribution.ShipmentMarkingCarrier (24 properties), SerticaWebApi.Models.Distribution.ShipmentDocument (24 properties), SerticaWebApi.Models.Distribution.ShipmentCarrier (22 properties). Each schema is shown below with its type and property counts.

SerticaWebApi.Models.BrokenRuleType
string
SerticaWebApi.Models.Distribution.Shipment
object
53 properties
Logihold.BusinessObjects.LogiholdObjModel.SystemData_ShipmentStatus
string
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDataType
string
Logihold.BusinessObjects.LogiholdObjModel.SystemData_ShipmentType
string
SerticaWebApi.Models.ValidationResult
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfoField
object
5 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchInfo
object
2 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.ForDeviceRequest
object
4 properties
SerticaWebApi.Models.ErrorReason
object
2 properties
SerticaWebApi.Models.Distribution.ShipmentMarking
object
18 properties
SerticaWebApi.Models.Distribution.ShipmentFreightDetail
object
19 properties
Logihold.BusinessObjects.LogiholdObjModel.Procurement.Amount
object
4 properties
SerticaWebApi.Models.Distribution.ShipmentDestinationWarehouse
object
13 properties
SerticaWebApi.Models.Link
object
2 properties
SerticaWebApi.Models.Distribution.ShipmentMailRequest
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.ValuesMatching
string
SerticaWebApi.Models.Distribution.ShipmentCarrier
object
22 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchCriteria
object
4 properties
Logihold.BusinessObjects.LogiholdObjModel.DocumentPreview.PreviewFormat
string
SerticaWebApi.Models.Distribution.ShipmentResponse
object
11 properties
SerticaWebApi.Models.Distribution.ShipmentMarkingCarrier
object
24 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.OrderBy
object
2 properties
SerticaWebApi.Models.Distribution.ShipmentPickupWarehouse
object
11 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchOperator
string
SerticaWebApi.Models.BrokenRule
object
7 properties
SerticaWebApi.Models.Distribution.ShipmentMailRecipientType
string
SerticaWebApi.Models.Distribution.ShipmentDocument
object
24 properties
Logihold.BusinessObjects.LogiholdObjModel.Search.SearchDefinition
object
8 properties
Logihold.BusinessObjects.LogiholdObjModel.View.SortDirection
string
Logimatic.BaseClasses30.DataOwner
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sertica-shipments-api-openapi.yml Raw ↑

Other APIs SERTICA publishes across the network.

SERTICA Accounting Dimensions API
SERTICA Accounting Dimensions Cache API
SERTICA Accounts API
SERTICA Activity Groups API
SERTICA Address Categories API
SERTICA Address Classifications API
SERTICA Addresses API
SERTICA AI Client API
SERTICA Analytics API
SERTICA Analytics Custom Menus API
SERTICA Analytics Custom Templates API
SERTICA Analytics Excel Templates API
Where this information came from

This is an independent, third-party profile of SERTICA Shipments 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.