Endpoint overview

Every active v2 endpoint at a glance. Click a group heading for the full reference — parameters, response shapes, and error tables.

Base URL: https://app.shipos.co.il/api/v2 · Every endpoint requires client-credential headers except GET /ping.

Public

Method	Path	Description
GET	/ping	Health check — the only endpoint with no auth.

Tracking

Method	Path	Description
GET	/tracking/{shipping_code}	PII-free status by tracking code. Authenticated and scoped to your licenses.

Account

Method	Path	Description
GET	/account	The authenticated customer, with licenses embedded.

Shipments

Method	Path	Description
GET	/shipments	List shipments.
POST	/shipments	Create a shipment (idempotent).
POST	/shipments/labels	Bulk label URLs for many shipments.
GET	/shipments/{shipment}	A single shipment.
GET	/shipments/{shipment}/status	Live delivery status.
GET	/shipments/{shipment}/label	Label for one shipment.
POST	/shipments/{shipment}/cancel	Cancel at the carrier.

{shipment} accepts the uuid, the carrier tracking code or the short tracking code.

Returns are not a separate resource: create one with POST /shipments and ship_data.type = 2, list them with GET /shipments?filter[type]=2. See Handle returns.

Batches

Method	Path	Description
GET	/batches	List batches (items embedded).
POST	/batches	Queue up to 2,000 shipments (202).
GET	/batches/{uuid}	Poll batch progress.
GET	/batches/{uuid}/items	Per-item results, including failures.

Exports

Method	Path	Description
POST	/exports	Queue a CSV export (202).
GET	/exports/{export}	Poll export progress.

Orders

Method	Path	Description
GET	/orders	List orders (cursor-paginated).
GET	/orders/{order}	A single order with its shipments.
GET	/orders/{order}/shipments	Shipments belonging to an order.

Pickup points

Method	Path	Description
GET	/pickup-points	The carrier's pickup network — city/limit filters, nearest-first via lat+lng or address.

Licenses

Method	Path	Description
GET	/licenses	Every carrier account you own — the source of license_key values.

Reference data

Method	Path	Description
GET	/reference/shipping-statuses	Known shipping status names.
GET	/reference/service-types	Service types (home / pickup / exchange / return).

Webhooks

Method	Path	Description
GET	/webhooks	List subscriptions.
POST	/webhooks	Subscribe (signing secret returned once).
PATCH	/webhooks/{uuid}	Update URL / events.
POST	/webhooks/{uuid}/ping	Send a test delivery.
GET	/webhooks/{uuid}/deliveries	Recent delivery attempts.
DELETE	/webhooks/{uuid}	Remove the subscription.

Notifications

Method	Path	Description
GET	/notifications/sms-settings	Current SMS settings.
PUT	/notifications/sms-settings	Update SMS settings.
POST	/notifications/test-sms	Send a test SMS.
GET	/notifications/sms-logs	Sent-SMS audit log.
GET	/notifications/sms-templates	List message templates.
POST	/notifications/sms-templates	Create / upsert a template.
PUT	/notifications/sms-templates/{template}/toggle	Enable / disable a template.
DELETE	/notifications/sms-templates/{template}	Delete a template.