CourierCloud Web API Help Page

Introduction

Use this API to interface with CourierCloud.com shipper features.

Common

API	Description
GET api/{ext}/common/getCurrentDate	No documentation available.
GET api/{ext}/common/GetSystemMessages	No documentation available.
GET api/{ext}/common/GetCountries	No documentation available.
GET api/{ext}/common/GetCurrencies	Use this method to get a list of all currencies
GET api/{ext}/common/GetTimezones	Use this method to get a list of all timezones
GET api/{ext}/common/GetAirports	Use this method to get a list of airports
GET api/{ext}/common/GetDefaultAirport?postalCode={postalCode}&countryID={countryID}	Use this method to get a default airport
GET api/{ext}/common/GetOffices	Use this method to get offices
GET api/{ext}/common/GetStatuses	No documentation available.
GET api/{ext}/common/GetUOMList	No documentation available.
GET api/{ext}/common/GetSizeUOMList	No documentation available.
GET api/{ext}/common/GetWeightUOMList	No documentation available.
GET api/{ext}/common/GetLimits	No documentation available.
GET api/{ext}/common/GetBillingToTypes	No documentation available.
GET api/{ext}/common/GetCommodityItems	Use this method to get a list of all UN#
GET api/{ext}/common/GetProductList	No documentation available.
GET api/{ext}/common/MySettings	Used to retrieve the contacts
POST api/{ext}/common/MySettings/Update	Use this method to update a MySettings
GET api/{ext}/common/GetContentsList	No documentation available.
POST api/{ext}/common/UpdateContentsList	No documentation available.
POST api/{ext}/common/DeleteContentsList	No documentation available.
DELETE api/{ext}/common/DeleteContentsList	No documentation available.
GET api/{ext}/common/CompanyLogo?CompanyID={CompanyID}	No documentation available.
GET api/{ext}/common/getAppParams	No documentation available.
POST api/Common?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Address

API	Description
GET api/{ext}/address/GetList?CompanyName={CompanyName}&CityName={CityName}&StateProvID={StateProvID}&AddressCode={AddressCode}&CountryID={CountryID}&PostalCode={PostalCode}	Used to retrieve the addresses
POST api/{ext}/address/SearchAddressList	Used to retrieve the addresses
POST api/{ext}/address/Create	Use this method to create an address
POST api/{ext}/address/Update	Use this method to update an address
POST api/{ext}/address/Delete	Use this method to delete an address
POST api/{ext}/address/PostalLookup	No documentation available.
POST api/{ext}/address/AddressCodeLookup	No documentation available.
GET api/{ext}/address/GetDistance?addressCode={addressCode}&airportID={airportID}&distanceUOM={distanceUOM}	No documentation available.
GET api/{ext}/address/GetDistanceUtility?postalCode={postalCode}&countryId={countryId}&airport={airport}&dropOrRecover={dropOrRecover}	Use this method to get a distance utility
POST api/Address?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

RoutingOptions

API	Description
POST api/{ext}/routing-options/getAirports	No documentation available.
POST api/{ext}/routing-options/getRouteOptions	No documentation available.
POST api/RoutingOptions?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

ItemMaster

API	Description
GET api/{ext}/itemmaster/GetList?ItemSKU={ItemSKU}&ItemName={ItemName}&ShowAll={ShowAll}	Used to retrieve the ItemMasters
POST api/{ext}/itemmaster/GetList	Used to get export data run results
POST api/{ext}/itemmaster/Create	Use this method to create an ItemMaster
POST api/{ext}/itemmaster/Update	Use this method to update an ItemMaster
POST api/{ext}/itemmaster/Delete	Use this method to delete an ItemMaster
GET api/{ext}/itemmaster/LookupPart?ItemSKU={ItemSKU}	No documentation available.
POST api/ItemMaster?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Ship

Use this controller to access the method used to create a shipment in ShipSameday.com

API	Description
POST api/Ship	Used to create a new shipment in ShipSameday. The method is secure and requires a UserGUID to be assigned.
POST api/Ship/Update	Use to update an order, it's pickup and delivery addresses
POST api/Ship/ActivateOrder	Use to activate an order from a quote status, you can also update contents
POST api/Ship/CancelOrder	Use this method to cancel an order that has not shipped yet

Invoice

Use to manage invoices

API	Description
GET api/Invoice/Detail/{UserGUID}/{InvoiceNumber}	Retrieve the details for an invoice including file data
GET api/{ext}/invoice/GetList?dePostDate={dePostDate}&orderNumber={orderNumber}	Used to get invoice list
GET api/{ext}/invoice/Print?invoiceGuid={invoiceGuid}	Used to print an invoice
POST api/Invoice?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

SearchOrdersLayout

API	Description
GET api/{ext}/searchOrdersLayout/GetList	No documentation available.
POST api/{ext}/searchOrdersLayout/Delete	No documentation available.
POST api/{ext}/searchOrdersLayout/Create	No documentation available.
POST api/{ext}/searchOrdersLayout/Update	No documentation available.
POST api/SearchOrdersLayout?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Contact

This controller is used to provide Contact information.

API	Description
GET api/{ext}/contact/GetContacts	Used to retrieve the contacts
POST api/Contact?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

OntimePerformance

This controller is used to provide OnTimePerformance information.

API	Description
GET api/{ext}/ontimePerformance/GetList?StartDate={StartDate}&EndDate={EndDate}&ServiceId={ServiceId}&AccountNumber={AccountNumber}&ShowLateOnly={ShowLateOnly}	Used to retrieve the OnTimePerformances
POST api/{ext}/ontimePerformance/GetList	Used to retrieve the OnTimePerformances
POST api/{ext}/ontimePerformance/DownloadReport	Used to retrieve the Download Report
POST api/OntimePerformance?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

WillCall

Use this controller to access the method used to create a shipment in ShipSameday.com

API	Description
POST api/WillCall/Activate	Use to activate an order from a quote status, you can also update contents
GET api/WillCall/{UserGUID}	Retruns Orders list which status is set to "WILL CALL"

RateEstimate

API	Description
POST api/{ext}/rateEstimate/GetChargedRateList	No documentation available.
POST api/{ext}/rateEstimate/Create	No documentation available.
POST api/RateEstimate?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Tracking

API	Description
GET api/{ext}/track/{companyId}/{trackingNumber}	Should be compared with .aspx code
GET api/{ext}/track/Orders/{TrackingNumber}/{ShipmentGUID}/Routes	Used to provide tracking route information.
GET api/{ext}/track/Orders/{TrackingNumber}/{ShipmentGUID}/Notes	Used to provide tracking note information.
GET api/{ext}/track/Orders/{ShipmentGUID}/Charges	Used to provide tracking charge information.
GET api/{ext}/track/Orders/{ShipmentGUID}/References	Used to provide tracking references information.
GET api/{ext}/track/FlightMap/{ShipmentGUID}	Used tp retrieve FlightAware flight map of the shipment route which is on the air
GET api/{ext}/track/GetCurrentNotes?trackingNumber={trackingNumber}&shipmentGUID={shipmentGUID}	No documentation available.
GET api/{ext}/track/PrintOrder?shipmentGUID={shipmentGUID}&invoiceGUID={invoiceGUID}&formType={formType}	No documentation available.
GET api/{ext}/track/LookupTrackingNumber/{TrackingNumber}	No documentation available.
POST api/{ext}/track/downloadOrder	No documentation available.
GET api/{ext}/track/GetItinerary?trackingNumber={trackingNumber}&shipmentGUID={shipmentGUID}	No documentation available.
GET api/{ext}/track/GetShipmentDetail/{shipmentGUID}	No documentation available.
POST api/Tracking?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Order

API	Description
POST api/{ext}/order/CreateShipperOrder	No documentation available.
POST api/{ext}/order/InsertInventory	No documentation available.
POST api/{ext}/order/Update	No documentation available.
GET api/{ext}/order/GetActiveOrders?accountNumber={accountNumber}&period={period}	No documentation available.
GET api/{ext}/order/GetRecentDeliveries?accountNumber={accountNumber}&period={period}	No documentation available.
GET api/{ext}/order/GetCreateShipperOrderPredefinedValues/{mode}	No documentation available.
POST api/{ext}/order/GetShipperServices	Use this method to get a list of services based on their availability type and other parameters
GET api/{ext}/order/GetServiceAttributeList?serviceID={serviceID}	No documentation available.
POST api/{ext}/order/Search	No documentation available.
GET api/{ext}/order/DownloadAirbill?shipmentGUID={shipmentGUID}	No documentation available.
GET api/{ext}/order/DownloadInvoice?shipmentGuid={shipmentGuid}	No documentation available.
GET api/{ext}/order/DownloadPODForm?shipmentGuid={shipmentGuid}	No documentation available.
GET api/{ext}/order/DownloadDangerousGoods?shipmentGuid={shipmentGuid}	No documentation available.
POST api/{ext}/order/GetAvailableServices	Use this method to get a list of available services and estimated rates
GET api/{ext}/order/GetServices	No documentation available.
POST api/{ext}/order/AAA	No documentation available.
GET api/{ext}/order/AAA	No documentation available.
POST api/Order?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

OrderPiece

API	Description
GET api/{ext}/orderpiece/GetList?orderGUID={orderGUID}	Use this method to get Order Piece list
POST api/{ext}/orderpiece/Create	Use this method to create an Order Piece
POST api/{ext}/orderpiece/Update	Use this method to update an Order Piece
POST api/{ext}/orderpiece/Delete	Use this method to delete an Order Piece item
POST api/OrderPiece?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

ExportData

API	Description
GET api/{ext}/exporter/getExport?name={name}&desciption={desciption}	No documentation available.
POST api/{ext}/exporter/run	No documentation available.
POST api/ExportData?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Track

This controller is used to provide tracking information and status for shipments.

API	Description
GET api/Track/{CompanyID}/{TrackingNumber}	Used to provide tracking information on public facing web site (non secure). Limited information is provided since the method can be access outside of the security restrictions.
GET api/Track/Info/{CompanyID}/{TrackingNumber}/{AccountNumber}	Used to provide tracking information on public facing web site (non secure). Limited information is provided since the method can be access outside of the security restrictions.
GET api/Track/{UserGUID}/{TrackingNumber}/{TimeFormat}	Use this method to get detailed status information regarding your shipment. This is a secure method that requires a UserGUID parameter for authentication.
GET api/Track/GetActiveOrders/{UserGUID}	Used to retrieve the current active orders
GET api/Track/GetRecentDeliveries/{UserGUID}	Used to retrieve the recent deliveries

ShipmentPiece

API	Description
GET api/{ext}/shipmentpiece/GetList?shipmentGUID={shipmentGUID}	Use this method to get Shipment Piece list
POST api/{ext}/shipmentpiece/Create	Use this method to create a Shipment Piece
POST api/{ext}/shipmentpiece/Update	Use this method to update a Shipment Piece
POST api/{ext}/shipmentpiece/Delete	Use this method to delete a Shipment Piece
POST api/ShipmentPiece?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Account

API	Description
GET api/{ext}/account/loginpassthrough/{PassthroughGUID}	No documentation available.
POST api/{ext}/account/loginpassthrough/{PassthroughGUID}	No documentation available.
POST api/{ext}/account/signin	Use this method to authenticate a user and get profile information and auth. token
GET api/{ext}/account/GetUserAccounts?userAccountMode={userAccountMode}&includeAllItems={includeAllItems}	No documentation available.
GET api/{ext}/account/UserProfile	No documentation available.
POST api/{ext}/account/recover-password	No documentation available.
POST api/{ext}/account/change-password	No documentation available.
POST api/Account?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Inventory

API	Description
GET api/{ext}/inventory/GetInventories?shipmentGuid={shipmentGuid}	No documentation available.
GET api/{ext}/inventory/GetSites?itemMasterGUID={itemMasterGUID}	No documentation available.
GET api/{ext}/inventory/GetAvailableSerialValues?itemMasterGUID={itemMasterGUID}&siteGUID={siteGUID}	No documentation available.
POST api/Inventory?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

File

API	Description
GET api/json/getFileData?imageFileName={imageFileName}	No documentation available.
POST api/json/upload	No documentation available.
OPTIONS api/json/upload	No documentation available.
GET api/json/deleteFile?itemMasterGuid={itemMasterGuid}&imageFileName={imageFileName}	No documentation available.
POST api/File?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

InventoryItemMaster

InventoryItemMasterController

API	Description
GET api/{ext}/inventoryItemMaster/GetList?skuValue={skuValue}&name={name}	Getting itemMasterList
GET api/{ext}/inventoryItemMaster/Export	No documentation available.
GET api/{ext}/inventoryItemMaster/GetStockedItem/{itemMasterGuid}	No documentation available.
GET api/{ext}/inventoryItemMaster/GetStockedDetail/{stockedItemGuid}	No documentation available.
GET api/{ext}/inventoryItemMaster/GetSite/{siteGuid}	No documentation available.
GET api/{ext}/inventoryItemMaster/GetLocation/{zoneGuid}	No documentation available.
GET api/{ext}/inventoryItemMaster/GetReorderReport	No documentation available.
POST api/InventoryItemMaster?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Document

API	Description
GET api/{ext}/document/Types/GetList	Used to retrieve document types
GET api/{ext}/document/Shipment/{shipmentGUID}	Used to retrieve documents related to a shipment
POST api/{ext}/document/Create	No documentation available.
GET api/Document?imageFileName={imageFileName}	No documentation available.
POST api/Document	No documentation available.
OPTIONS api/Document	No documentation available.
GET api/Document?itemMasterGuid={itemMasterGuid}&imageFileName={imageFileName}	No documentation available.
POST api/Document?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

ReferenceGroup

API	Description
GET api/{ext}/referencegroup/GetReferenceGroupValueItems?referenceGroupGUID={referenceGroupGUID}
GET api/{ext}/referencegroup/GetList	Used to retrieve the Reference Groups
GET api/{ext}/referencegroup/GetReferenceTypes	No documentation available.
POST api/{ext}/referencegroup/Create	Use this method to create a picklist item
POST api/{ext}/referencegroup/Update	Use this method to update a picklist item
POST api/{ext}/referencegroup/Delete	Use this method to delete a picklist item
GET api/{ext}/referencegroup/Value/GetList?ReferenceGroupGUID={ReferenceGroupGUID}	Used to retrieve the Reference Group Values
POST api/{ext}/referencegroup/Value/Create	Use this method to create a picklist value item
POST api/{ext}/referencegroup/Value/Delete	Use this method to delete a picklist value item
GET api/{ext}/referencegroup/GetContents	No documentation available.
POST api/ReferenceGroup?message={message}&errorCode={errorCode}&statusCode={statusCode}	No documentation available.

Security

Contains the security methods related to Shipper API

API	Description
POST api/Security/UserInfo	Use this method to authenticate a user and get profile information