API Documentation

Complete reference for ShippingToGo API endpoints, parameters, and examples.

GetToken

POST

Authentication Endpoint

https://api.shippingtogo.com/api/GetToken

Request Parameters

Parameter Type Required Description
email string Required User's email address
password string Required User's password
apiKey string Required API key for authentication and API access

Example Request

                                
{
    "email": "[email protected]",
    "password": "your_password",
    "apiKey": "your_api_key"
}

Example Response

{
    "data": [
        [
            {
                "token": "a0982e98-8475-4305-94dc-b4461662c7bc",
                "iTime": "2025-06-04T12:40:20.123"
            }
        ]
    ],
    "additionalInfo": null,
    "searchBy": null,
    "extensions": null,
    "errors": {
        "code": 0,
        "msg": ""
    }
}

Rates

POST

Rates

https://api.shippingtogo.com/api/Ver1/Rates/

Headers

Content-Type: application/json
accessToken: {{accessToken}}
apiKey: {{apiKey}}

Rate Details Parameters

Parameter Type Required Description
shippingTypeId string Required
Package Documents
unitOfMeasurement string Required
cm_kg in_lb

Shipper Information

Parameter Type Required Description
country string Required Shipper's country code (e.g., "IL")
state string Optional State or province (for countries like the US)
city string Required City name
street string Optional
postalCode string Required Postal/ZIP code

Recipient Information

Parameter Type Required Description
country string Required Shipper's country code (e.g., "IL")
state string Optional State or province (for countries like the US)
city string Required City name
street string Optional
postalCode string Required Postal/ZIP code

Package Information

Parameter Type Required Description
quantity string Required Package quantity
weight string Required Weight in selected units
length string Required Length
width string Required Width
height string Required Height

Estimated Delivery Date

Parameter Type Required Description
pickupDate string Required Pickup date (YYYY-MM-DD)
pickupTime string Required Start pickup time
endPickupTime string Required End pickup time

Example Request

                                
{    
    "shippingTypeId": "1",    
    "unitOfMeasurement": "CM_KG",
    "Shipper": {
        "country": "IL",
        "state": "",       
        "city": "Tel Aviv-Yafo",
        "street": "Allenby",
        "postalCode": "6713201"
    },
    "Recipient": {
        "country": "US",
        "state": "NY",
        "city": "Washington",       
        "street": "Emerald Street Northeast",
        "postalCode": "10170"
    },
    "Packages": [
        {
            "quantity": "1",
            "weight": "20",
            "length": "12",
            "width": "35",
            "height": "76"            
        }
    ]  
}

Example Response


{
    "data": [
        {
            "errMsg": null,
            "courierId": 601,
            "courierName": "IsraelPost EMS",
            "courierParentName": "IsraelPost",
            "originalPrice_USD": 660.09,
            "originalPrice_NIS": 2508.34,
            "price_USD": 660.09,
            "price_NIS": 2508.34,
            "totalPrice_USD": 660.09,
            "totalPrice_NIS": 2508.34,
            "fromCountry": "IL",
            "toCountry": "US",
            "fromCity": "Tel Aviv Yafo",
            "toCity": "Washington",
            "divideHR": "7",
            "pickupDate": "2025-06-05",
            "pickupTimes": "",
            "deliveryTime": "2-5 Days",
            "isDomestic": "false",
            "service": "IsraelPost EMS",
            "selectedTime": "",
            "showVat": "true",
            "usersType": "",
            "multipleAmount": "",
            "PreCommercialInvoice": "false",
            "logo": "https://shippingtogo.com/assets/images/courier_logos/IsraelPost.png",
            "pickupStartTimeRange": "10:00:00",
            "pickupEndTimeRange": "17:00:00",
            "shippingTypeId": 1
        }
    ],
    "additionalInfo": [
        {
            "weight": 20.0,
            "volumetricWeight": 6.384,
            "quantity": 1,
            "length": 12.0,
            "height": 76.0,
            "width": 35.0,
            "sizeMeasurement": "CM",
            "weightMeasurement": "KG",
            "shippingTypeId": "2",
            "weightToCharge": 20.0,
            "eligibleForDiscount": true
        }
    ],
    "searchBy": null,
    "extensions": null,
    "errors": {
        "code": 0,
        "msg": ""
    }
}

CreateShip

POST

Create Shipment

https://api.shippingtogo.com/api/Ver1/Ship/

Headers

Content-Type: application/json
accessToken: {{accessToken}}
apiKey: {{apiKey}}

Ship Details Parameters

Parameter Type Required Description
documentDescription string Optional General description of the shipment contents
Vat_TaxId string Optional Business or corporate tax ID
estimatePackageValue number Required Declared value of package contents for customs
estimatePackageValueCurrency string Required The currency declared for the package value for customs purposes
USD EUR GBP
currency string Required Currency used for shipping payment
USD ILS
reason string Required Purpose of the shipment
Gift Commercial Document Repair Sample Sold Personal Effects Not Sold
courierId number Required Courier service selection
403 - FedEx Priority (test) 404 - FedEx Priority 414 - FedEx Economy 424 - Priority Freight
shippingTypeId string Required
Package Documents
unitOfMeasurement string Required
cm_kg in_lb
insuranceAmount number Required Insurance amount if required
dutyAndTaxesType string Required
DDU DDP
federalIdentification string Required Indicates if shipment is business
vat ID
signature string Required
None 1 2
isBusiness boolean Required

Shipper Information

Parameter Type Required Description
name string Required Name of the shipper or company
contactPerson string Required Contact person representing the shipper
country string Required Shipper's country code (e.g., "IL")
state string Optional State or province (for countries like the US)
city string Required City name
street string Optional
houseNumber number Optional
postalCode string Required Postal/ZIP code
phonePrefix string Required International phone prefix (e.g., +972 for Israel)
phone string Required Phone number
email string Required Email address

Recipient Information

Parameter Type Required Description
name string Required Name of the Recipient or company
contactPerson string Required Contact person representing the Recipient
country string Required Shipper's country code (e.g., "IL")
state string Optional State or province (for countries like the US)
city string Required City name
street string Optional
houseNumber number Optional
postalCode string Required Postal/ZIP code
phonePrefix string Required International phone prefix (e.g., +972 for Israel)
phone string Required Phone number
email string Required Email address
isResident boolean Optional

Package Information

Parameter Type Required Description
quantity string Required Package quantity
weight string Required Weight in selected units
length string Required Length
width string Required Width
height string Required Height
customValue string Required Customs value
insuraceValue string Required Insurance value

Estimated Delivery Date

Parameter Type Required Description
pickupDate string Required Pickup date (YYYY-MM-DD)
pickupTime string Required Start pickup time
endPickupTime string Required End pickup time

Example Request

{
    "ShipDetails": {       
        "documentDescription": "Ring",
        "Vat_TaxId": "12345678",      
        "estimatePackageValue": 4,
        "currency": "USD",
        "reason": "Sample",
        "courierId": 403,     
        "shippingTypeId": "1",
        "unitOfMeasurement": "cm_kg",
        "insuranceAmount": 0,
        "dutyAndTaxesType": "DDU",
        "estimatePackageValueCurrency": "USD",
        "Shipper": {
            "name": "shippingtogo",
            "contactPerson": "kobi",
            "country": "IL",
            "state": "",
            "city": "Tel Aviv",
            "street": "Allenby Street",
            "houseNumber": "",
            "postalCode": "6713201",
            "phone": "444444444",
            "phonePrefix": "+972",
            "email": "[email protected]"
        },
        "Recipient": {
            "name": "shippingtogo",
            "contactPerson": "Sonja Hamilton",
            "country": "US",
            "state": "TN",
            "city": "Nashville",
            "street": "624 Grassmere Park Drive, Ste. 30",
            "houseNumber": "",
            "postalCode": "37211",
            "phone": "4445678943",
            "phonePrefix": "+1",
            "email": "[email protected]",
            "isResident": null
        },
        "federalIdentification": "vat",
        "signature": "None",
        "Packages": [
            {
                "quantity": "1",
                "weight": "1",
                "length": "2",
                "width": "2",
                "height": "2",
                "customValue": "4",
                "insuraceValue": "4"
            }
        ],
        "EstimatedDeliveryDate": {
            "pickupDate": "2025-5-25",
            "pickupTime": "11:30",
            "endPickupTime": "16:30"
        },
        "isBusiness": "true"
    }
}

Example Response


{
    "data": [
        {
            "errMsg": null,
            "courierId": 403,
            "courierName": "Fedex Priority",
            "courierParentName": "Fedex",
            "originalPrice_USD": 874.76,
            "originalPrice_NIS": 3324.09,
            "price_USD": 874.76,
            "price_NIS": 3324.09,
            "totalPrice_USD": 874.76,
            "totalPrice_NIS": 3324.09,
            "fromCountry": "IL",
            "toCountry": "US",
            "fromCity": "Tel Aviv",
            "toCity": "Nashville",
            "divideHR": "4",
            "pickupDate": "2025-06-04",
            "pickupTimes": [
                {
                    "FromTime": "14:30",
                    "ToTime": "19:30"
                },
                {
                    "FromTime": "15:00",
                    "ToTime": "20:00"
                }
            ],
            "isDomestic": "false",
            "service": "Fedex Priority",
            "selectedTime": "",
            "showVat": "true",
            "usersType": "",
            "multipleAmount": "",
            "PreCommercialInvoice": "false",
            "logo": "https://shippingtogo.com/assets/images/courier_logos/fedex.png",
            "shippingTypeId": 1
        }
    ],
    "additionalInfo": [
        {
            "weight": 1.0,
            "volumetricWeight": 0.0016,
            "quantity": 1,
            "length": 2.0,
            "height": 2.0,
            "width": 2.0,
            "sizeMeasurement": "CM",
            "weightMeasurement": "KG",
            "shippingTypeId": "1",
            "weightToCharge": 1.0,
            "eligibleForDiscount": true
        }
    ],
    "searchBy": null,
    "extensions": [
        {
            "pickupId": 150913,
            "trackingNumber": null,
            "labelURL": null,
            "instruction": "Shipment successfully created",
            "pickupDate": "2025-05-25T00:00:00",
            "pickupStartTimeRange": "11:30:00",
            "userId": 2,
            "pickupEndTimeRange": "17:30:00",
            "isExternalShip": false,
            "Only_CC": false
        }
    ],
    "errors": {
        "code": 0,
        "msg": ""
    }
}

CreatePickup

POST

Create Pickup

https://api.shippingtogo.com/api/Ver1/Pickup

Headers

apiKey: {{apiKey}}
accessToken: {{accessToken}}

Request Parameters

Parameter Type Required Description
depositType string Required
courierId number Required Courier ID to be used
pickupId number Required
processorId number Required ID of the processor handling the order
pickupType number Required Pickup type identifier (e.g., 4 = no pickup required)

Billing

Parameter Type Required Description
ccToken string Optional Credit card token (used if saved card)
Name string Required Name on the credit card
ID string Required ID number of the cardholder
ccNumber string Optional Full credit card number
cvv string Required CVV security code
expDate string Required Expiration date (MM/YY or YYYY-MM)
saveCard boolean Optional

ReceiptDetails

Parameter Type Required Description
vat string Optional VAT number
Name string Required Name to appear on the receipt
country string Required Country for the receipt address
address string Optional Billing address for receipt
sendToEmail string Required Email address to send the receipt

EstimatedDeliveryDate

Parameter Type Required Description
pickupDate string Optional Planned pickup date (YYYY-MM-DD)
pickupTime string Optional Time window for pickup start
deliveryDate string Optional Expected delivery date
endPickupTime string Optional End time for pickup window

Example Request


{
    "clientJson": {
        "depositType": "buy",
        "courierId": 403,
        "pickupId": 149195,
        "processorId": 1000,
        "Billing": {
            "ccToken": "",
            "Name": "",
            "ID": "",
            "ccNumber": "",
            "cvv": "02",
            "expDate": "",
            "saveCard": false
        },
        "ReceiptDetails": {
            "vat": "",
            "name": "",
            "country": "",
            "address": "",
            "sendToEmail": ""
        },
        "EstimatedDeliveryDate": {
            "pickupDate": "",
            "pickupTime": "",
            "deliveryDate": "",
            "endPickupTime": ""
        },
        "pickupType": 4
    }
}

Example Response


{
    "data": [
        [
            {
                "pickupId": 150913,
                "pickupAuthorization": "PickupNotSettled",
                "shippingAuthorization": null,
                "labelURL": null,
                "payment": 874.76,
                "currency": "USD",
                "weightToCharge": 1.00,
                "quantity": 1,
                "instruction": "pickup successfully created",
                "isNavigateToConfirmationPage": 1
            }
        ]
    ],
    "additionalInfo": null,
    "searchBy": null,
    "extensions": null,
    "errors": {
        "code": 0,
        "msg": ""
    }
}

TransmissionDocs

POST

Upload Document

https://api.shippingtogo.com/api/Ver1/TransmissionDocs

Headers

Content-Type: form-data
accessToken: {{accessToken}}
apiKey: {{apiKey}}

Form Data

Parameter Type Required Description
pickupId text Required ID of the pickup
doctype Enum Required Type of document
1 - COMMERCIAL INVOICE 2 - PROFORMA INVOICE 3 - CERTIFICATE OF ORIGIN 4 - USMCA CERTIFICATE OF ORIGIN 5 - OTHER
File file Required File to upload (PDF, etc.)

Example Response

                        
{
    "data": null,
    "additionalInfo": null,
    "searchBy": null,
    "extensions": null,
    "errors": {
        "code": 0,
        "msg": ""
    }
}

GetLabelByPickupId

POST

Get Label

https://api.shippingtogo.com/api/Ver1/GetLabelByPickupId/

Headers

Content-Type: application/json
accessToken: {{accessToken}}
apiKey: {{apiKey}}

Request Parameters

Parameter Type Required Description
pickupId number Required
step number Required A fixed value of 2

Example Request

                                
{
    "clientJson": {
        "pickupId": "149014",
        "step": "2"
    }
}

Example Response

                                
{
    "data": [
        [
            {
                "courierId": 403,
                "pickupId": 149014,
                "labelURL": "https://label.ShippingToGo.com/Label_149014_1ace134d-ac18-487e-9a07-f01857a66173.pdf",
                "trackingNumber": "794876388083",
                "isNeedTotransmit": 0,
                "step": 2,
                "userId": 2,
                "createLabel": false,
                "CommercialInvoiceTransmissionTypeId": 1,
                "needReceipt": false
            }
        ]
    ],
    "additionalInfo": null,
    "searchBy": null,
    "extensions": null,
    "errors": {
        "code": 0,
        "msg": ""
    }
}