For AI agents: visit https://developers.shipup.co/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.

Jump to Content

Home Guides API Reference Changelog

v2024-07-11

Status page Log In

API Reference

v2024-07-11Home Guides API Reference Changelog

Introduction

Getting started
API response codes
Rate limiting
Authentication

Sending order data

Data model
Sending orders and trackers
- Create or update single orders
- Batch create or update orders
Sending trackers
- Batch create or update trackers
Sending Pickup Point information
- Create or update pickup points

Retrieving data

API getting started
Pagination
Expanding responses
Data model
Available endpoints

Webhooks

Receiving webhooks
Types

SMART DELIVERY ESTIMATES

Data model
Shipup ETA (JS library)
- Initialization
- Fetching predictions
API - Delivery date estimation

Third-Party Integrations

Klaviyo integration
Customer.io integration

Returns

Getting started
Uploading product data

Powered by

Data model

This is a current list of the data models available in the API

Job
Order
Order details
Fulfillment
Tracker
Event
Line item
Address
Notification

Updated 10 months ago

Expanding responses

Did this page help you?

Updated 10 months ago

Expanding responses

Did this page help you?