Jump to Content
ShipupStatus page
HomeGuidesAPI ReferenceChangelog
Status pageLog InShipup
API Reference
Log In
HomeGuidesAPI ReferenceChangelog

Introduction

  • Getting started
  • API response codes
  • Rate limiting
  • Authentication

Sending order data

  • Data model
    • The order object
      • Available languages
    • The fulfillment object
      • Fulfillment status codes
    • The tracker object
      • Expected deliveries
      • Carrier Services
    • The line item object
    • The address object
  • Sending orders and trackers
    • Create or update single orders
    • Batch create or update orders
  • Sending trackers
    • Batch create or update trackers

Retrieving data

  • API getting started
  • Pagination
  • Expanding responses
  • Data model
    • Job
    • Order
      • Delivery statuses
    • Fulfillment
    • Tracker
      • Expected deliveries
    • Event
      • Event type codes
    • Line item
    • Address
    • Carrier
    • Carrier service
    • Notification
      • Notification category codes
      • Notification type
      • Notification payload
  • Available endpoints
    • Orders
    • Trackers
    • Job

Webhooks

  • Receiving webhooks
  • Types
    • tracker.events.new
    • tracker.new
    • notification.new
      • The notification object
    • feedback.new
      • The feedback object
      • Feedback scenario and sub scenario
      • Feedback properties attribute

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
    • Product feed
    • Pricing feed
    • Non-returnable products
    • Stock feed

Data model

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

  • Job
  • Order
  • Fulfillment
  • Tracker
  • Event
  • Line item
  • Address
  • Notification