Shipbubble API Documentation
  • Shipbubble API
  • Get started
    • Authentication
    • Request and Responses
    • Errors
    • Rate Limiting
    • Pagination
    • Postman
  • API Reference
    • Wallet
      • Get shipping wallet balance
      • Request wallet fund
    • Addresses
      • Validate address (global)
      • Get validated addresses
      • Edit address details
      • Get single address details
    • Package categories
    • Package dimensions
    • Couriers
    • Rates
      • Request shipping rates
      • Request shipping rates from selected couriers
      • Edit request token details
    • Cash on delivery
    • Insurance
      • Get Insurance Rates
    • Shipments
      • Create shipment
      • Cancel shipment
    • Returns
      • Get rates for a return shipment request
    • Tracking
      • Get shipments
      • Get multiple specific shipments
    • Webhooks
      • Webhook simulator (sandbox)
Powered by GitBook
On this page

Was this helpful?

  1. Get started

Request and Responses

JSON is used to format both the request body and the returned data (response). Application/JSON will always be the content type for responses. In general, all responses will be formatted as follows:

Field
Datatype
Description

status

String

Helps differentiate responses, it either returns 'success' or 'failed'

message

String

Gives a description of the status returned (do not use for your checks)

data

Object

Contains actionable result of a successfully processed request if present

errors

Array

Contains errors pertaining to a request body (e.g invalid parameter submitted)

PreviousAuthenticationNextErrors

Last updated 3 years ago

Was this helpful?