{"version":1,"pages":[{"id":"-MdzayAH9RwenRITbeR0","title":"Introduction","pathname":"/tship","siteSpaceId":"sitesp_EwAzr","description":"Learn how to integrate logistics into your application with our APIs."},{"id":"LbZOIxT9qKWCgEMwiKui","title":"Ship with Code","pathname":"/tship/ship-with-code","siteSpaceId":"sitesp_EwAzr","description":"This is a general guide for anyone integrating delivery services. It provides a step guide to arrange your first delivery along with a description of the flow of events once your delivery is arranged."},{"id":"-MdzbS9q0jP1bj0hSoAR","title":"Authentication","pathname":"/tship/authentication","siteSpaceId":"sitesp_EwAzr","description":"Authenticate your API calls by including your access token in the Authorization header of every request you make. You can retrieve your access token under the settings tab on the dashboard."},{"id":"-MdzbhUG9vSaWWyB5eZy","title":"Errors","pathname":"/tship/errors","siteSpaceId":"sitesp_EwAzr","description":"This section describes the nature of errors you might encounter while interacting with the API."},{"id":"ehPH98vlSXl583rZjYOF","title":"Libraries & Plugins","pathname":"/tship/libraries-and-plugins","siteSpaceId":"sitesp_EwAzr","description":"In this section you can find a list of available libraries that could streamline your integration process."},{"id":"cWbnEbOCKxOOsSB37S7m","title":"Pickup Workflow","pathname":"/tship/guides/pickup-workflow","siteSpaceId":"sitesp_EwAzr","description":"Book shipments with Priority Pickup or arrange a Scheduled Pickup in a few requests.","breadcrumbs":[{"label":"GUIDES"}]},{"id":"-Mdzc2LvlR2tBBi487s4","title":"Addresses","pathname":"/tship/address","siteSpaceId":"sitesp_EwAzr","description":"The Addresses API allows you to create and manage pickup and delivery locations."},{"id":"-Me-CxO2ODoBadxERB7E","title":"Create Address","pathname":"/tship/address/create-address","siteSpaceId":"sitesp_EwAzr","description":"Create an address for getting rates or arranging pickup and delivery.","breadcrumbs":[{"label":"Addresses"}]},{"id":"-Me-D0p1OIaYkKu7lyBq","title":"Get Addresses","pathname":"/tship/address/get-addresses","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of addresses available for a user.","breadcrumbs":[{"label":"Addresses"}]},{"id":"-Me-D4VIjB-syDUhhEin","title":"Get Address","pathname":"/tship/address/get-address","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific address.","breadcrumbs":[{"label":"Addresses"}]},{"id":"uCGPQimPKvZZqIVKqHj3","title":"Get Default Address","pathname":"/tship/address/get-default-address","siteSpaceId":"sitesp_EwAzr","description":"Set an address a default address","breadcrumbs":[{"label":"Addresses"}]},{"id":"6nyJ3dsIlbAYr67yt9S0","title":"Set Default Address","pathname":"/tship/address/set-default-address","siteSpaceId":"sitesp_EwAzr","description":"Set an address a default address","breadcrumbs":[{"label":"Addresses"}]},{"id":"Ik05IJVTQgh0qHsg5nv5","title":"Update Address","pathname":"/tship/address/update-address","siteSpaceId":"sitesp_EwAzr","description":"Update information for an existing address.","breadcrumbs":[{"label":"Addresses"}]},{"id":"scwQatjwfndHWluwQlUe","title":"Validate Address","pathname":"/tship/address/validate-address","siteSpaceId":"sitesp_EwAzr","description":"Validate details for an address","breadcrumbs":[{"label":"Addresses"}]},{"id":"GotdCx39kbXsk5gcNdWs","title":"Verify Address","pathname":"/tship/address/verify-address","siteSpaceId":"sitesp_EwAzr","description":"Verify an existing Nigerian address with NIN.","breadcrumbs":[{"label":"Addresses"}]},{"id":"-MdzbuUaSI5UvfKhp8QW","title":"Carriers","pathname":"/tship/carrier","siteSpaceId":"sitesp_EwAzr","description":"The Carriers API allows you to manage information on available carriers for your account."},{"id":"-Me-DKJPcrn9VzTmvVJL","title":"Get Carriers","pathname":"/tship/carrier/get-carriers","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of all carriers available on TShip API.","breadcrumbs":[{"label":"Carriers"}]},{"id":"-Me-DPLz9qR5n64KoS_t","title":"Get Carrier","pathname":"/tship/carrier/get-carrier","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific carrier.","breadcrumbs":[{"label":"Carriers"}]},{"id":"-Me-DWnEgNziZk3CXgyi","title":"Enable Carrier","pathname":"/tship/carrier/enable-carrier","siteSpaceId":"sitesp_EwAzr","description":"Enable a specific carrier for a user.","breadcrumbs":[{"label":"Carriers"}]},{"id":"HFmdUKrmogNwCQkuxD5p","title":"Enable Multiple Carriers","pathname":"/tship/carrier/enable-multiple-carriers","siteSpaceId":"sitesp_EwAzr","description":"Enable multiple carriers for a user.","breadcrumbs":[{"label":"Carriers"}]},{"id":"-Me-D_2yonW5_c5CfRQG","title":"Disable Carrier","pathname":"/tship/carrier/disable-carrier","siteSpaceId":"sitesp_EwAzr","description":"Disable a specific carrier for a user.","breadcrumbs":[{"label":"Carriers"}]},{"id":"nuIp0pDIHNprxt7x0QHz","title":"Disable Multiple Carriers","pathname":"/tship/carrier/disable-multiple-carriers","siteSpaceId":"sitesp_EwAzr","description":"Disable multiple carriers for a user.","breadcrumbs":[{"label":"Carriers"}]},{"id":"xQHEm5UTINT8mqXqQDs7","title":"Drop-off Locations","pathname":"/tship/carrier/drop-off-locations","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of all carriers available on TShip API.","breadcrumbs":[{"label":"Carriers"}]},{"id":"3jsdd6nRTKkstIakim4S","title":"Duties","pathname":"/tship/duties","siteSpaceId":"sitesp_EwAzr","description":"The Duties API allows you to estimate and manage landed costs for deliveries."},{"id":"BkKh0IFriEraSDJP3Fcq","title":"Get Duties","pathname":"/tship/duties/get-duties","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of all claims available for a specific user.","breadcrumbs":[{"label":"Duties"}]},{"id":"bu0WMHgfvMBSKHI1JJyf","title":"Get Duty","pathname":"/tship/duties/get-duty","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific duty.","breadcrumbs":[{"label":"Duties"}]},{"id":"ZzsplWV8tWgeHDeGG4UA","title":"Estimate Duty","pathname":"/tship/duties/estimate-duty","siteSpaceId":"sitesp_EwAzr","description":"Estimate import duty required for a shipment.","breadcrumbs":[{"label":"Duties"}]},{"id":"21XDAAkRc9QVZLUypSVE","title":"HS Codes","pathname":"/tship/hs-codes","siteSpaceId":"sitesp_EwAzr","description":"The HS Codes API allows you generate accurate, customs ready descriptions for your items when you ship."},{"id":"FLsucnFgtnT3lBhDyoUV","title":"Add Favorite HS Code","pathname":"/tship/hs-codes/add-favorite-hs-code","siteSpaceId":"sitesp_EwAzr","icon":"plus","description":"Add specific HSCode to Favorite.","breadcrumbs":[{"label":"HS Codes"}]},{"id":"TMMWhOmchpXy3pE1ViYq","title":"Find a HS Code","pathname":"/tship/hs-codes/find-a-hs-code","siteSpaceId":"sitesp_EwAzr","emoji":"1f916","description":"Generate customs standard item descriptions and find accurate HS Codes - powered by AI.","breadcrumbs":[{"label":"HS Codes"}]},{"id":"cgsMJOk1WAtEqW3Ew9wD","title":"Get Favorite HSCodes","pathname":"/tship/hs-codes/get-favorite-hscodes","siteSpaceId":"sitesp_EwAzr","icon":"bone","description":"Fetch available Favorite HSCodes","breadcrumbs":[{"label":"HS Codes"}]},{"id":"KgueVEKSjQJ0uOOBX6Be","title":"Remove HSCode from Favorites","pathname":"/tship/hs-codes/remove-hscode-from-favorites","siteSpaceId":"sitesp_EwAzr","icon":"dumpster","description":"Remove specific HSCode from favorite","breadcrumbs":[{"label":"HS Codes"}]},{"id":"IiPy7MRaiW5oZivYFuHB","title":"Insurance","pathname":"/tship/insurance","siteSpaceId":"sitesp_EwAzr","description":"The Insurance API allows you to purchase and manage insurance premiums on parcels included in your shipment."},{"id":"RgTe5Aysb5s4D8PasaF8","title":"Get Insurance","pathname":"/tship/insurance/get-insurance","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific insurance.","breadcrumbs":[{"label":"Insurance"}]},{"id":"OqQxBV6vOH43ww5JnCDU","title":"Get Insurances List","pathname":"/tship/insurance/get-insurances-list","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of insurances available for a user.","breadcrumbs":[{"label":"Insurance"}]},{"id":"ictJl4zKiCipQH2kYZzu","title":"Get Insurance Premium","pathname":"/tship/insurance/get-insurance-premium","siteSpaceId":"sitesp_EwAzr","description":"Retrieves total premium for insurance on a specific parcel.","breadcrumbs":[{"label":"Insurance"}]},{"id":"hquvbFVeArA1qr1d8Ehh","title":"Get Insurance Premium Using Parcel Value","pathname":"/tship/insurance/get-insurance-premium-using-parcel-value","siteSpaceId":"sitesp_EwAzr","description":"Retrieves total premium for insurance on a specific parcel.","breadcrumbs":[{"label":"Insurance"}]},{"id":"lTOwpdcobDuvC7U9ibak","title":"Purchase Insurance","pathname":"/tship/insurance/purchase-insurance","siteSpaceId":"sitesp_EwAzr","description":"Purchase insurance for a specific shipment.","breadcrumbs":[{"label":"Insurance"}]},{"id":"-Mdzc6QDcN3oCiQYNUJH","title":"Packaging","pathname":"/tship/packaging","siteSpaceId":"sitesp_EwAzr","description":"The Packaging API allows you to create and manage packaging used on parcels."},{"id":"-Me-Dl-Xsisioy9X6_ST","title":"Create Packaging","pathname":"/tship/packaging/create-packaging","siteSpaceId":"sitesp_EwAzr","description":"Create new packaging for wrapping parcels","breadcrumbs":[{"label":"Packaging"}]},{"id":"-Me-DnrIu44lrHEkCOYq","title":"Get Packaging","pathname":"/tship/packaging/get-packaging","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of packaging available for a user.","breadcrumbs":[{"label":"Packaging"}]},{"id":"-Me-DqKCKEkUASbh0buT","title":"Get Specific Packaging","pathname":"/tship/packaging/get-specific-packaging","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific packaging.","breadcrumbs":[{"label":"Packaging"}]},{"id":"dGSMxh0VUPXX9T4CZf8C","title":"Terminal Default Packaging","pathname":"/tship/packaging/terminal-default-packaging","siteSpaceId":"sitesp_EwAzr","description":"Get Terminal Default Packaging","breadcrumbs":[{"label":"Packaging"}]},{"id":"pVN5NgudXlUXu6iHsxb6","title":"Update Packaging","pathname":"/tship/packaging/update-packaging","siteSpaceId":"sitesp_EwAzr","description":"Update information for an existing packaging.","breadcrumbs":[{"label":"Packaging"}]},{"id":"-MdzcAloo3unb2kJ6P0h","title":"Parcels","pathname":"/tship/parcel","siteSpaceId":"sitesp_EwAzr","description":"The Parcels API allows you to create and manage your parcels."},{"id":"-Me-EW_De9EhNguB5s_m","title":"Create Parcel","pathname":"/tship/parcel/create-parcel","siteSpaceId":"sitesp_EwAzr","description":"Create a parcel for a shipment.","breadcrumbs":[{"label":"Parcels"}]},{"id":"kbQeCSyDL2pHointjRdm","title":"Update Parcel","pathname":"/tship/parcel/update-parcel","siteSpaceId":"sitesp_EwAzr","description":"Update a parcel for a shipment.","breadcrumbs":[{"label":"Parcels"}]},{"id":"-Me-EZnjKeCZEkEw1WiW","title":"Get Parcels","pathname":"/tship/parcel/get-parcels","siteSpaceId":"sitesp_EwAzr","description":"Fetch a list of parcels available for a user.","breadcrumbs":[{"label":"Parcels"}]},{"id":"-Me-EbNtOrhR5tQ7OwuC","title":"Get Parcel","pathname":"/tship/parcel/get-parcel","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific parcel.","breadcrumbs":[{"label":"Parcels"}]},{"id":"8sNrQgsBMtl6h7nBMvQi","title":"Pickups","pathname":"/tship/pickups","siteSpaceId":"sitesp_EwAzr","description":"The Pickups API allows you to schedule and manage all pickup types."},{"id":"HMjYEK0P3NOgXpbgURZC","title":"Get Pickups","pathname":"/tship/pickups/get-pickups","siteSpaceId":"sitesp_EwAzr","description":"List Priority Pickup and Scheduled Pickup records together.","breadcrumbs":[{"label":"Pickups"}]},{"id":"w84zYHiNX6XQ9wEgo2Xo","title":"Get Pickup","pathname":"/tship/pickups/get-pickup","siteSpaceId":"sitesp_EwAzr","description":"Retrieve either a Priority Pickup or Scheduled Pickup by its ID.","breadcrumbs":[{"label":"Pickups"}]},{"id":"VPfFINc131eCwjC58OzZ","title":"Cancel Pickup","pathname":"/tship/pickups/cancel-pickup","siteSpaceId":"sitesp_EwAzr","description":"Cancel either pickup type through the same endpoint.","breadcrumbs":[{"label":"Pickups"}]},{"id":"yb7MzbyUiqNRLK7LtNFY","title":"Get Pickup Dates","pathname":"/tship/pickups/get-pickup-dates","siteSpaceId":"sitesp_EwAzr","description":"Fetch available collection dates for your shipment's address.","breadcrumbs":[{"label":"Pickups"}]},{"id":"4HNwqJssdmY4kHiwM7Va","title":"Schedule Pickup","pathname":"/tship/pickups/schedule-pickup","siteSpaceId":"sitesp_EwAzr","description":"Schedule a carrier collection for booked shipments.","breadcrumbs":[{"label":"Pickups"}]},{"id":"C2r1RwRP8mzewlzWH4R0","title":"Rate Cards","pathname":"/tship/rate-cards","siteSpaceId":"sitesp_EwAzr","description":"The Rate Cards API allows you to read the carrier rate cards your account is priced on and download them as a PDF or spreadsheet."},{"id":"7cjg3ioy7g2l3go6jfoe","title":"Get My Rate Cards","pathname":"/tship/rate-cards/get-my-rate-cards","siteSpaceId":"sitesp_EwAzr","description":"Fetch every carrier rate card currently assigned to your account.","breadcrumbs":[{"label":"Rate Cards"}]},{"id":"jC2EHoqPu4MdIvWXHiud","title":"Get My Rate Card","pathname":"/tship/rate-cards/get-my-rate-card","siteSpaceId":"sitesp_EwAzr","description":"Fetch the full price table for one of your rate cards.","breadcrumbs":[{"label":"Rate Cards"}]},{"id":"QIELjUSsi7T7cZlqu8EX","title":"Download Rate Card (PDF)","pathname":"/tship/rate-cards/download-rate-card-pdf","siteSpaceId":"sitesp_EwAzr","description":"Download one of your rate cards as a PDF price table.","breadcrumbs":[{"label":"Rate Cards"}]},{"id":"9X6Ub29akZxajRzihz6l","title":"Download Rate Card (Excel)","pathname":"/tship/rate-cards/download-rate-card-excel","siteSpaceId":"sitesp_EwAzr","description":"Download one of your rate cards as an Excel workbook.","breadcrumbs":[{"label":"Rate Cards"}]},{"id":"7tNIuMwcbL9hEBlZnYLB","title":"Download Rate Card Zones (PDF)","pathname":"/tship/rate-cards/download-rate-card-zones-pdf","siteSpaceId":"sitesp_EwAzr","description":"Download the zone coverage for one of your rate cards as a PDF.","breadcrumbs":[{"label":"Rate Cards"}]},{"id":"-MdzcEXEFybUJ81ij1VB","title":"Rates","pathname":"/tship/rate","siteSpaceId":"sitesp_EwAzr","description":"The Rates API allows you to retrieve shipping rates from available carriers."},{"id":"fB05K7C1HBuJus4ZUWJy","title":"Get Quotes for Shipment","pathname":"/tship/rate/get-quotes-for-shipment","siteSpaceId":"sitesp_EwAzr","description":"Fetch available shipping quotes for a shipment","breadcrumbs":[{"label":"Rates"}]},{"id":"-Me-EvxD8jjgAbTrEX0m","title":"Get Rate","pathname":"/tship/rate/get-rate","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific rate.","breadcrumbs":[{"label":"Rates"}]},{"id":"cIc173MhaLD3BqDLeofr","title":"Get Rates","pathname":"/tship/rate/get-rates","siteSpaceId":"sitesp_EwAzr","description":"Fetch a list of rates generated by a user.","breadcrumbs":[{"label":"Rates"}]},{"id":"Pqv0y2nMA3BSGux8sjfZ","title":"Get Rates for Multi-Parcel Shipment","pathname":"/tship/rate/get-rates-for-shipment","siteSpaceId":"sitesp_EwAzr","description":"Fetch available shipping rates for a multi-parcel shipment.","breadcrumbs":[{"label":"Rates"}]},{"id":"-Me-EtkEDM4m19aHuUtR","title":"Get Rates for Shipment","pathname":"/tship/rate/get-rates-for-shipment-1","siteSpaceId":"sitesp_EwAzr","description":"Fetch available shipping rates for a shipment.","breadcrumbs":[{"label":"Rates"}]},{"id":"GdERvh3HJ5bbJ1EqTDFs","title":"Get Rates for Shipment [STREAM]","pathname":"/tship/rate/get-rates-for-shipment-2","siteSpaceId":"sitesp_EwAzr","description":"Fetch available shipping rates for a shipment via stream endpoint.","breadcrumbs":[{"label":"Rates"}]},{"id":"efqiWRKb9uUtgwQO458I","title":"Reconciliation","pathname":"/tship/reconciliation","siteSpaceId":"sitesp_EwAzr","description":"The Reconciliation API allows you to read the weight and carrier-charge discrepancies raised against your shipments after booking."},{"id":"tOToewuxZge810y6XPru","title":"Get Reconciliations","pathname":"/tship/reconciliation/get-reconciliations","siteSpaceId":"sitesp_EwAzr","description":"Fetch a paginated list of reconciliation records for a specific user.","breadcrumbs":[{"label":"Reconciliation"}]},{"id":"ixPG8fNbTAqG8FAXkmex","title":"Get Reconciliation","pathname":"/tship/reconciliation/get-reconciliation","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific reconciliation record.","breadcrumbs":[{"label":"Reconciliation"}]},{"id":"BIBXoTR1UlnZY3QU4m2j","title":"Get Reconciliation by Shipment","pathname":"/tship/reconciliation/get-reconciliation-by-shipment","siteSpaceId":"sitesp_EwAzr","description":"Fetch the latest reconciliation record raised against a shipment.","breadcrumbs":[{"label":"Reconciliation"}]},{"id":"HSFcPbLMseaiRrNUsAF1","title":"Simulate Reconciliation Webhook","pathname":"/tship/reconciliation/simulate-reconciliation-webhook","siteSpaceId":"sitesp_EwAzr","description":"Queue a reconciliation webhook against one of your own shipments, for testing your integration.","breadcrumbs":[{"label":"Reconciliation"}]},{"id":"-MdzcG5qOo7zaY2XB0h0","title":"Shipments","pathname":"/tship/shipment","siteSpaceId":"sitesp_EwAzr","description":"The Shipments API allows you to create shipment tasks, track status of shipments and retrieve information about shipments."},{"id":"-Me-FEM-iXXkGty0rx4S","title":"Create Shipment","pathname":"/tship/shipment/create-shipment","siteSpaceId":"sitesp_EwAzr","description":"Create a shipment","breadcrumbs":[{"label":"Shipments"}]},{"id":"4Tu0dwIMIvy5OoF7uKwI","title":"Create Quick Shipment","pathname":"/tship/shipment/create-quick-shipment","siteSpaceId":"sitesp_EwAzr","description":"Create a quick shipment. Pass all required details, including address and parcel in a single API call.","breadcrumbs":[{"label":"Shipments"}]},{"id":"bfbT9e9CLA1l40s7k8T4","title":"Update Shipment","pathname":"/tship/shipment/update-shipment","siteSpaceId":"sitesp_EwAzr","description":"Update information for an existing draft shipment.","breadcrumbs":[{"label":"Shipments"}]},{"id":"Voc3Gp0ShtfmHGizCqF6","title":"Get Shipments v2","pathname":"/tship/shipment/get-shipments-1","siteSpaceId":"sitesp_EwAzr","description":"Fetch a list of all shipments available for a user.","breadcrumbs":[{"label":"Shipments"}]},{"id":"-Me-FK5NJ9BOEh4tWQVt","title":"Get Shipment","pathname":"/tship/shipment/get-shipment","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific shipment.","breadcrumbs":[{"label":"Shipments"}]},{"id":"-Me-FNEnNTGvNfg73FXs","title":"Track a Shipment","pathname":"/tship/shipment/track-a-shipment","siteSpaceId":"sitesp_EwAzr","description":"Get tracking details for a shipment.","breadcrumbs":[{"label":"Shipments"}]},{"id":"-Me-FU6s5lNX8H4h7JXx","title":"Cancel Shipment","pathname":"/tship/shipment/cancel-shipment","siteSpaceId":"sitesp_EwAzr","description":"Cancel pickup for a shipment.","breadcrumbs":[{"label":"Shipments"}]},{"id":"lUqCGRzQlMILaC7zeWBK","title":"Delete Shipment","pathname":"/tship/shipment/create-shipment-1","siteSpaceId":"sitesp_EwAzr","description":"Delete a shipment","breadcrumbs":[{"label":"Shipments"}]},{"id":"uCRy3yJvspnVOquxtpC5","title":"Duplicate Shipment","pathname":"/tship/shipment/duplicate","siteSpaceId":"sitesp_EwAzr","description":"Duplicate an existing shipment to create a new draft shipment.","breadcrumbs":[{"label":"Shipments"}]},{"id":"-Me-FacwZ_efgOJMyT5-","title":"Arrange Pickup & Delivery for Shipment","pathname":"/tship/shipment/arrange-pickup-and-delivery-for-shipment","siteSpaceId":"sitesp_EwAzr","description":"","breadcrumbs":[{"label":"Shipments"}]},{"id":"-MdzcJCL7uQ9YUXAx6k_","title":"Transactions","pathname":"/tship/transaction","siteSpaceId":"sitesp_EwAzr","description":"The Transactions API allows you to retrieve information on all charges and top-ups on your account."},{"id":"-Me-FlLNqB1g27P34pCV","title":"Get Transactions","pathname":"/tship/transaction/get-transactions","siteSpaceId":"sitesp_EwAzr","description":"Fetch a list of all transactions for an account.","breadcrumbs":[{"label":"Transactions"}]},{"id":"-Me-FoZcJuic1EcNBsHS","title":"Get Transaction","pathname":"/tship/transaction/get-transaction","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific transaction.","breadcrumbs":[{"label":"Transactions"}]},{"id":"-MdzcLOLTv5X_xS2sdc3","title":"Users","pathname":"/tship/user","siteSpaceId":"sitesp_EwAzr","description":"The Users API allows you to retrieve your account information."},{"id":"-Me-Fu5fDQRip1mDPvSU","title":"Get User","pathname":"/tship/user/get-user","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a user account.","breadcrumbs":[{"label":"Users"}]},{"id":"z6LZV7NQ0GYPwCaerRNn","title":"Get Wallet Info","pathname":"/tship/user/get-wallet-info","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a user's wallet","breadcrumbs":[{"label":"Users"}]},{"id":"-Me-G4rT7s8Z0uwHqOFp","title":"Get Wallet Balance","pathname":"/tship/user/get-wallet","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a user's wallet balance","breadcrumbs":[{"label":"Users"}]},{"id":"pcJByJ0o9crnfAdkwpR4","title":"Get User Carriers","pathname":"/tship/user/get-user-carriers","siteSpaceId":"sitesp_EwAzr","description":"Fetch list of all carriers available for a user.","breadcrumbs":[{"label":"Users"}]},{"id":"-MdzcOnwZN7hef_0Xc05","title":"Webhooks","pathname":"/tship/webhooks","siteSpaceId":"sitesp_EwAzr","description":"The Wallets API allows you to create and retrieve information on all webhooks on your account."},{"id":"-Me-GAE5OiPqZhyR4scP","title":"Create Webhook","pathname":"/tship/webhooks/create-webhook","siteSpaceId":"sitesp_EwAzr","description":"Add a webhook","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-Me-GDNhgR6a5XkE3WEu","title":"Delete Webhook","pathname":"/tship/webhooks/delete-webhook","siteSpaceId":"sitesp_EwAzr","description":"Delete an existing webhook.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-Me-GHDneCPTmlk_tedf","title":"Disable Webhook","pathname":"/tship/webhooks/disable-webhook","siteSpaceId":"sitesp_EwAzr","description":"Disable a webhook.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"-MeWaPkURDi8QGeXxg61","title":"Enable Webhook","pathname":"/tship/webhooks/enable-webhook","siteSpaceId":"sitesp_EwAzr","description":"Enable a webhook.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"Kn7csdwamUQlB4QKzyVu","title":"Get Webhooks","pathname":"/tship/webhooks/get-webhooks","siteSpaceId":"sitesp_EwAzr","description":"Fetch a list of all webhooks available for a user.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"nruGdmFogyJ6Vq5HjzzQ","title":"Get Webhook","pathname":"/tship/webhooks/get-webhook","siteSpaceId":"sitesp_EwAzr","description":"Fetch details of a specific webhook.","breadcrumbs":[{"label":"Webhooks"}]},{"id":"QIbhiQjbvbzxRQzcb1Zr","title":"Replay Webhook","pathname":"/tship/webhooks/replay-webhook","siteSpaceId":"sitesp_EwAzr","description":"Add a webhook","breadcrumbs":[{"label":"Webhooks"}]},{"id":"EK9mhQ2bhad6Is9Vzrqm","title":"Simulate Webhook","pathname":"/tship/webhooks/simulate-webhook","siteSpaceId":"sitesp_EwAzr","description":"","breadcrumbs":[{"label":"Webhooks"}]},{"id":"rBSl0gHpc9OQ6mzCEBjN","title":"Webhook Deliveries","pathname":"/tship/webhooks/webhook-deliveries","siteSpaceId":"sitesp_EwAzr","description":"Add a webhook","breadcrumbs":[{"label":"Webhooks"}]},{"id":"Wbocb51kZSkG87nX6GjR","title":"API Pricing","pathname":"/tship/miscallaneous/api-pricing","siteSpaceId":"sitesp_EwAzr","description":"You can find a full list of paid services available on the API as well as the charges that apply for using each service..","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"ZBHt27rusx3yoRcIAObE","title":"Carriers Available","pathname":"/tship/miscallaneous/carriers-available","siteSpaceId":"sitesp_EwAzr","description":"You can find a full list of carriers available on the API as well as which user countries can access each carrier.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"1MI38eLydWy6z6p1olic","title":"Carrier Object (Enable / Disable)","pathname":"/tship/miscallaneous/carrier-object-enable-disable","siteSpaceId":"sitesp_EwAzr","description":"Carrier object describes the carriers included in a multi enable / disable request.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"A5wQ4zygjIFxP0ZmCPPI","title":"Cities","pathname":"/tship/miscallaneous/cities","siteSpaceId":"sitesp_EwAzr","description":"Get list of cities available in a given country.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"VPiAgbJMwKKJ8ud9OIV9","title":"Countries","pathname":"/tship/miscallaneous/countries","siteSpaceId":"sitesp_EwAzr","description":"Get list of countries available for shipping.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"-Me-JkrnN41JjgaxVuIG","title":"Parcel Item","pathname":"/tship/miscallaneous/parcel-item","siteSpaceId":"sitesp_EwAzr","description":"Parcel item object describes the items included in a parcel.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"FGWy2zEj9ZibtptiXqB6","title":"Quick Shipments","pathname":"/tship/miscallaneous/quick-shipments","siteSpaceId":"sitesp_EwAzr","description":"Here you can find a description of the quick shipments process. This method allows you to complete all the tasks required to create a shipment in a single API call.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"x20R3MfqgX7jJfV6LtPk","title":"Parcel","pathname":"/tship/miscallaneous/quick-shipments/parcel","siteSpaceId":"sitesp_EwAzr","description":"Parcel object describes the attributes required for a parcel in a quick shipment.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Quick Shipments"}]},{"id":"IfO9QIDgWXEgLEF6xgiM","title":"Pickup / Delivery Address","pathname":"/tship/miscallaneous/quick-shipments/pickup-delivery-address","siteSpaceId":"sitesp_EwAzr","description":"Pickup and delivery address object describes the attributes required for pickup_address and delivery_address in quick shipment. For description of objects, please see the Address Object.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Quick Shipments"}]},{"id":"m4CDKzqPtH1v0zVipkVj","title":"Rate Card Directions","pathname":"/tship/miscallaneous/rate-card-directions","siteSpaceId":"sitesp_EwAzr","description":"A rate card entry carries a directions array, one entry per service direction the carrier prices for you. This section describes that object.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"H154yvKUBbo1pUz4Bal4","title":"Rate Card Pricing","pathname":"/tship/miscallaneous/rate-card-pricing","siteSpaceId":"sitesp_EwAzr","description":"The pricing object returned with a rate card holds the price matrix. This section describes that object.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"GtAvE92VtIeivWnUym4z","title":"Rates Stream Handling","pathname":"/tship/miscallaneous/rates-stream-handling","siteSpaceId":"sitesp_EwAzr","description":"Sample code for handling rates streaming in Node.js.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"jX2kCX9D7EqJupIipOwV","title":"Reconciliation Additional Charge","pathname":"/tship/miscallaneous/reconciliation-additional-charge","siteSpaceId":"sitesp_EwAzr","description":"A reconciliation record with charge_type additional_charge carries an additional_charge object. This section describes that object.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"m8GEGCy40V7dGk9S3ByT","title":"Reconciliation Shipment Data","pathname":"/tship/miscallaneous/reconciliation-shipment-data","siteSpaceId":"sitesp_EwAzr","description":"Every reconciliation record carries a shipment_data array describing the discrepancy per shipment. This section describes that object.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"QxY9LHKu10AkQrok3i8l","title":"Sample Webhook Event Payloads","pathname":"/tship/miscallaneous/sample-webhook-event-payloads","siteSpaceId":"sitesp_EwAzr","description":"The exact JSON delivered to your endpoint for every webhook event, grouped by resource.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"voBwx2PqdMQGnp0N36OO","title":"Address","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/address","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for address.created, address.updated and address.deleted.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"iZdsoCA3cZ33Zs5N33op","title":"Claim","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/claim","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for claim.success and claim.failed.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"4xR4W4cOSp2v3PvLaCCe","title":"Insurance","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/insurance","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for insurance.pending, insurance.success and insurance.failed.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"Nw64IGurP9ksT7u1v9CZ","title":"Pickup Events","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/pickup","siteSpaceId":"sitesp_EwAzr","description":"Pickup webhook payloads for booking, tracking, cancellation and failure recovery.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"GOV0KWZrG6iPTBhl7A48","title":"Packaging","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/packaging","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for packaging.created and packaging.updated.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"pk3SBFMYHLZ1jklZ8HXm","title":"Reconciliation","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/reconciliation","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for reconciliation.flagged, reconciliation.billed and reconciliation.corrected.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"6dYB0AhDmjWC5wWygcEL","title":"Regulatory Document","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/regulatory-document","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for regulatory_document.pending, regulatory_document.uploaded and regulatory_document.complete.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"SBJNO33GpbKcKPkRV5Uv","title":"Shipment","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/shipment","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for every shipment webhook event.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"kiBGU0QYeZJ8MdvU59nv","title":"Transaction","pathname":"/tship/miscallaneous/sample-webhook-event-payloads/transaction","siteSpaceId":"sitesp_EwAzr","description":"Sample payloads for transaction.success and transaction.failed.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Sample Webhook Event Payloads"}]},{"id":"-Me-OeCZsJtlLMh7aIRj","title":"Shipment Events","pathname":"/tship/miscallaneous/shipment-event","siteSpaceId":"sitesp_EwAzr","description":"Every shipment generated on the API has an event data point which provides information on the lifecycle of a shipment. This section describes the information contained within the shipment event object","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"-Me-P83sgD_jrazD-VHU","title":"Shipment Extras","pathname":"/tship/miscallaneous/shipment-extras","siteSpaceId":"sitesp_EwAzr","description":"The extras object attached to each shipment contains additional information relevant to each shipment outside the scope of the API such as carrier waybills, commercial invoices and much more.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"2tSKr2udpo72sezDK0Wa","title":"States","pathname":"/tship/miscallaneous/states","siteSpaceId":"sitesp_EwAzr","description":"Get states available for a given country.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"b1Dhs4kaUiZolm3Daw1P","title":"Validation Countries","pathname":"/tship/miscallaneous/validation-countries","siteSpaceId":"sitesp_EwAzr","description":"You can find a full list of countries where our APIs support address validation.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"vDKK9sf28FAuBW2X1287","title":"Webhook Events","pathname":"/tship/miscallaneous/webhook-events","siteSpaceId":"sitesp_EwAzr","description":"Here you can find a list of webhook event types along with descriptions of each event.","breadcrumbs":[{"label":"MISCALLANEOUS"}]},{"id":"R8HqfxYeE1RQRh7sUsNE","title":"Handling Webhook Events","pathname":"/tship/miscallaneous/webhook-events/handling-webhook-events","siteSpaceId":"sitesp_EwAzr","description":"Verify webhook signatures and process pickup event versions safely.","breadcrumbs":[{"label":"MISCALLANEOUS"},{"label":"Webhook Events"}]}]}