Truckit LogoTruckit API Documentation
Truckit Apis

Schemas

Item

  • idstring
    Example: item1
  • categorystring · enum
    Enum values:
    Appliances & Electronics
    Art & Antiques
    Boxes, Bags and Suitcases
    Furniture
    Glass and Fragile Items
    Piano
    Sports and Outdoor
    Example: Furniture
  • descriptionstring
    Example: Sleeper Couch
  • collectstring
    Example: 3 Smith St, Burwood East VIC 3151
  • deliverstring
    Example: 49-65 Kenny Rd, Chambers Flat QLD 4133
  • quantitynumber
    Example: 1
    Default: 1
  • lengthnumber
    Example: 2
  • widthnumber
    Example: 2.5
  • heightnumber
    Example: 0.5
  • weightnumber
    Example: 20
  • unsure_dimensionsboolean
    Example: false
    Default: false
  • fragileboolean
    Example: false
    Default: false
  • blanket_wrapboolean
    Example: false
    Default: false
  • imagesstring[]
  • extra_detailsstring

QuoteRequest

  • referencestring · required
    Example: test_00006
  • itemsobject[] · required

QuoteResponse

  • statusstring · enum
    Enum values:
    success
    error
    Example: success
  • errorstring
  • total_itemsnumber
    Example: 1
  • quoted_itemsnumber
    Example: 1
  • totalnumber
    Example: 2191
  • partner_referencestring · uuid
    Example: test_00006
  • referencestring
    Example: BC99258E-C566-4EE1-BDC8-20ACA2832469
  • expiresstring
    Example: 2024-10-18 09:56:46 +00:00
  • listingsobject[]

ContactDetails

  • contact_namestring
    Example: Tom Smith
  • phonestring
    Example: 123456789

BookNowRequest

  • referencestring · uuid · required
    Example: BC99258E-C566-4EE1-BDC8-20ACA2832469
  • firstnamestring · required
    Example: Andrew
  • lastnamestring · required
    Example: Testing
  • emailstring · email · required
    Example: andrew.erikson@gmail.com
  • phonestring · required
    Example: 1300859859
  • collectobject · required
  • deliverobject · required
  • itemsobject[]

BookNowResponse

  • statusstring · enum
    Enum values:
    success
    error
    Example: success
  • errorstring
  • partner_referencestring · uuid
    Example: test_00006
  • referencestring
    Example: BC99258E-C566-4EE1-BDC8-20ACA2832469
  • listingsobject[]

CreateWebhookRequest

  • endpointstring · url · required
    Example: https://example.com/your-webhook-endpoint
  • entity_typestring · required
    Example: freight_listing

CreateWebhookResponse

  • webhook_idstring · uuid
    Example: f2040c8e-03b5-452f-b93c-02aefd887302
  • statusstring
    Example: active
  • signaturestring
    Example: 2183e73a8e84d4c6a05b37663b6865a86e937e5ab1d102b38a8274eaae139f57
  • updated_atstring · date
    Example: 2024-11-28

UpdateWebhookRequest

  • endpointstring · url
    Example: https://new-example.com/webhook
  • entity_typestring
    Example: freight_listing

UpdateWebhookResponse

  • statusstring
    Example: success
  • messagestring
    Example: Webhook updated successfully
  • dataobject

DeleteWebhookResponse

  • statusstring
    Example: success
  • messagestring
    Example: Webhook deleted successfully

ErrorResponse

  • statusstring · enum
    Enum values:
    error
    Example: error
  • messagestring
    Example: Webhook not found

TrackShipmentRequest

  • booking_referencestring · required
    Example: your_booking_reference

TrackShipmentResponse

  • statusstring
    Example: delivered
  • datestring · date
    Example: 2024-11-27

WebhookEventPayload

  • entity_idstring
    Example: 12345
  • dataobject
    Example: {"key1":"value1","key2":"value2"}

ConsignmentNoteRequest

  • referencestring · uuid · required
    Example: E9EAA715-A4DE-405F-BA69-87E35D00381F