Api ReferenceVersion: 0.0.1

Download OpenAPI specification:

API Support: contact@weshipyou.com URL: https://weshipyou.com/docs/api License: Apache 2.0 Terms of Service

The WeShipYou API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Find out how OpenAPI spec works.

Introduction

You can use the WeShipYou API in test mode, which doesn't affect your live data or interact with the banking networks. The API key you use to authenticate the request determines whether the request is live mode or test mode.

The WeShipYou API doesn't support bulk updates. You can work on only one object per request.

The WeShipYou API differs for every account as we release new versions and tailor functionality. Log in to see docs customized to your version of the API, with your test key and data.

OpenAPI Specification

This API is documented in OpenAPI format.
In addition to standard
OpenAPI syntax we use a few internal modifications to illustrated the documentation better, you can download and test in your postman or other OpenApi compatible software, also you can test right here all in live.

Authentication

This topic describes the different forms of authentication that are available in the WeShipYou API, and how to use them.

WeShipYou offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.

Secret API key: Use to make requests from the server side. Never share these keys. Keep them guarded and secure.
Publishable API key: Use in your client-side code to tokenize payment information.
JWT: Use to make short-life tokens that expire after a set period of time.

Authentication

Get an API Access Token

WeShipYou uses Bearer Authentication to authenticate requests. You will need to include Authorization: Bearer <API Access Token> in the header for all requests.

Before you get started, you will need to generate an API Access Token on our dashboard.

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Pet object that needs to be added to the store

username	string Default: "{{username}}" Username registered with WeShipYou
password	string Default: "{{password}}" Your password

Responses

Request samples

Code samples

Payload
application/json
{"username": "{{username}}",
"password": "{{password}}"
}

Response samples

application/json

{"accessToken": "string",
"iat": 0,
"exp": 0,
"user": {"id": 0,
"uid": "string",
"username": "string",
"email": "string",
"isEnabled": true,
"isVerified": true,
"invalidTokensBeforeAt": null,
"metadata": { },
"termsAgreementDate": null,
"termsAgreementVersion": "string",
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"roleId": 0,
"avatarId": 0,
"revision": 0,
"role": { },
"avatar": { },
"user_detail": {"id": 0,
"uid": "string",
"taxId": "88-1345985",
"phone": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"gender": "string",
"language": "string",
"birthday": null,
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"userId": 0
},
"accounts": [{"name": "string",
"displayName": "string",
"systemUnits": "imperial",
"email": "string",
"notificationEmail": "string",
"website": "string",
"phone": "string",
"emergencyPhone": "string",
"taxId": "string",
"taxIdCountry": {"isoCode": "string"
},
"uid": "string",
"accountNumber": "string",
"status": "string",
"language": "string",
"isBusiness": true,
"allowBankAccountPayments": true,
"metadata": { },
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"addressId": 0,
"billingAddressId": 0,
"defaultShipFromId": 0,
"defaultAddressOnLabelId": 0,
"defaultReturnAddressId": 0,
"primaryPaymentShipmentsId": 0,
"logoId": 0,
"pickupServiceFallbackId": 0,
"revision": 0,
"address": {"useExistingAddress": true,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
}
}
]
}
}

Shipments

Everything about your shipments

Calculate shipping rates

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

required	string or string
totalValue required	number <= 2999
insurance	boolean
incoterms required	string Enum: "DDU" "DDP"
required	object (RatesAddress)
required	object (RatesAddress)
required	Array of objects (parcels) [ 1 .. 100 ] items

Responses

Request samples

Code samples

Payload
application/json
{"accountId": "string",
"totalValue": 2999,
"insurance": true,
"incoterms": "DDU",
"sender": {"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"country": {"isoCode": "US"
}
},
"recipient": {"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"country": {"isoCode": "US"
}
},
"parcels": [{"dimUnit": "cm",
"width": 10,
"length": 10,
"height": 10,
"weightUnit": "gm",
"weight": 100,
"parcel_items": [{"sku": "SKU-WSY-EXAMPLE",
"description": "Play Station 4",
"category": {"slug": "board_games"
},
"price": 450,
"qty": 1,
"originCountry": {"isoCode": "JP"
},
"weight": 0,
"currency": "USD"
}
]
}
]
}

Add a new shipment to your account

Add new shipment to your account inventory.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

required	string or string
required	object (sender)
required	object (recipient)
totalValue required	number <= 2999
externalReferenceCode	string
externalCustomerId	string
insurance	boolean
incoterms required	string Enum: "DDU" "DDP"
required	Array of objects (parcels) [ 1 .. 100 ] items

Responses

Request samples

Code samples

Payload
application/json
{"accountId": "string",
"sender": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"recipient": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"totalValue": 2999,
"externalReferenceCode": "string",
"externalCustomerId": "string",
"insurance": true,
"incoterms": "DDU",
"parcels": [{"dimUnit": "cm",
"width": 10,
"length": 10,
"height": 10,
"weightUnit": "gm",
"weight": 100,
"parcel_items": [{"sku": "SKU-WSY-EXAMPLE",
"description": "Play Station 4",
"category": {"slug": "board_games"
},
"price": 450,
"qty": 1,
"originCountry": {"isoCode": "JP"
},
"weight": 0,
"currency": "USD"
}
]
}
]
}

Find shipments

Lookup shipments to your account inventory.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Get shipment info

Get shipment shipment to your account inventory.

Authorizations:

JWTSecretApiKey

path Parameters

shipmentId

required

string

ID of shipment

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Update an existing shipment

Authorizations:

JWTSecretApiKey

path Parameters

shipmentId

required

string

ID of shipment

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

required	string or string
required	object (sender)
required	object (recipient)
totalValue required	number <= 2999
externalReferenceCode	string
externalCustomerId	string
insurance	boolean
incoterms required	string Enum: "DDU" "DDP"
required	Array of objects (parcels) [ 1 .. 100 ] items

Responses

Request samples

Code samples

Payload
application/json
{"accountId": "string",
"sender": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"recipient": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"totalValue": 2999,
"externalReferenceCode": "string",
"externalCustomerId": "string",
"insurance": true,
"incoterms": "DDU",
"parcels": [{"dimUnit": "cm",
"width": 10,
"length": 10,
"height": 10,
"weightUnit": "gm",
"weight": 100,
"parcel_items": [{"sku": "SKU-WSY-EXAMPLE",
"description": "Play Station 4",
"category": {"slug": "board_games"
},
"price": 450,
"qty": 1,
"originCountry": {"isoCode": "JP"
},
"weight": 0,
"currency": "USD"
}
]
}
]
}

Delete / Cancel a shipment

Delete and cancel shipment when possible, shipments that are already handled by the carrier can not be canceled or refunded

Authorizations:

JWTSecretApiKey

path Parameters

shipmentId

required

string

Pet id to delete

header Parameters

Accept-Language	string Default: en-US Example: en-US The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT
x-api-key	string Example: Bearer <TOKEN>

Responses

Request samples

Get shipment categories

Get shipment categories.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Get country categories

Get specific country categories for customs purposes

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Services

WeShipYou Services

Find services

Find services available in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Forwarder

WeShipYou Forwarder Ooders

Find Forwarder Orders

Find Forwarder Orders Available in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"wsyOrderNumber": "WFO-7EB7DU",
"externalReferenceCode": "string",
"totalPrice": 0,
"totalItems": 0,
"sellerNotes": "string",
"buyerNotes": "string",
"personalShopperService": true,
"createdAt": null,
"updatedAt": null,
"destinationCountry": [{"id": 0,
"uid": "string",
"name": "string",
"slug": "string",
"isoCode": "string",
"isoCode3": "string",
"isoNumeric": 0,
"fips": "string",
"capital": "string",
"areaSqKm": 0,
"population": 0,
"continent": "string",
"tld": "string",
"currencyCode": "string",
"currencyName": "string",
"postalCodeFormat": "string",
"postalCodeRegex": "string",
"languages": "string",
"equivalentFipsCode": "string",
"phoneNumberPrefix": "string",
"allowShipFrom": true,
"allowShipTo": true,
"allowPickup": true,
"countryTax": 0,
"taxThresholdAmount": "string",
"dutyThresholdAmount": "string",
"thresholdMethod": "string",
"taxAndDutyCalculationMethod": "string",
"additionalDocuments": true,
"additionalInfoOda": null,
"additionalInfoNonWorkingDays": "string",
"additionalInfoHolidays": "string",
"customsPageUrl": "string",
"additionalInfoHolidaysUrl": "string",
"createdAt": null,
"updatedAt": null
}
],
"forwarding_order_items": [{"uid": "string",
"orderNumber": "string",
"sku": "string",
"description": "string",
"status": "string",
"url": "string",
"qty": 0,
"price": 0,
"shippingCost": 0,
"trackingNumber": "string",
"handlingCost": 0,
"weight": 0,
"color": "string",
"size": "string",
"alternativeColor": "string",
"alternativeSize": "string",
"observations": "string",
"imageUrl": "string",
"createdAt": null,
"updatedAt": null,
"currency": { },
"originCountry": { },
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"country_category": {"uid": "string",
"name": "string",
"slug": "string",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"containsDocuments": true,
"containsOtherDg": true,
"containsLiquids": true,
"containsBatteryPi967": true,
"containsBatteryPi966": true,
"containsBatteryPi965": true,
"customsValue": 0,
"qty": 0,
"maxWeight": 0,
"unitType": "string",
"observations": "string",
"isDiscontinued": true,
"createdAt": null,
"updatedAt": null,
"parentId": 0
}
}
]
}
]
}

Mobile Recharges

WeShipYou FoMobile Recharges

Find Mobile Recharge Providers

Find Mobile Recharge Providers in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"name": "Cubacel",
"externalCode": "CUCU",
"active": true,
"createdAt": null,
"updatedAt": null
}
]
}

Find Mobile Recharge Providers Descriptions

Find Mobile Recharge Providers Descriptions in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"displayName": "Cubacel",
"description": "string",
"localeId": 0,
"providerId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Find Mobile Recharge Products Descriptions

Find Mobile Recharge Products Descriptions in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"title": "EUR 10.00",
"descriptionMarkdown": "string",
"extendedDescriptionMarkdown": "string",
"localizationKey": "0ALULU96671",
"productId": 0,
"localeId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Find Mobile Recharges

Find Mobile Recharges in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"externalReferenceCode": "string",
"externalCustomerId": "string",
"status": "delivered",
"amount": 0,
"price": 0,
"notes": "string",
"scheduleDate": null,
"deliveredAt": null,
"accountId": 0,
"countryId": 0,
"rechargeableProductId": 0,
"rechargeableProviderPromotionId": 0,
"labelId": 0,
"couponId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Create Mobile Recharges

Create Mobile Recharges in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

paymentMethod	string The payment method to be used
accountUid	string The accountUid to be used, if you only have one, we will detect automatically
	object
scheduleDate	date or null
amount	number
	object

Responses

Request samples

Code samples

Payload
application/json
{"paymentMethod": "zelle",
"accountUid": "string",
"rechargeable_product": {"id": 0
},
"scheduleDate": null,
"amount": 0,
"account_rechargeable_contact": {"name": "string",
"accountNumber": "string"
}
}

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"externalReferenceCode": "string",
"externalCustomerId": "string",
"status": "delivered",
"amount": 0,
"price": 0,
"notes": "string",
"scheduleDate": null,
"deliveredAt": null,
"accountId": 0,
"countryId": 0,
"rechargeableProductId": 0,
"rechargeableProviderPromotionId": 0,
"labelId": 0,
"couponId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Add Funds

Add funds to your account

Add money to ypu account.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

paymentMethod	string Default: "zelle" The payment method to be used
accountUid	string The accountUid to be used, if you only have one, we will detect automatically
	object

Responses

Request samples

Code samples

Payload
application/json
{"paymentMethod": "zelle",
"accountUid": "string",
"transaction": {"zelleTransaction": "string",
"amount": 0
}
}

Response samples

application/json

{"result": true,
"transaction": {"id": 0,
"uid": "string",
"type": "debit",
"transType": "Shipment",
"state": "cleared",
"referenceNo": "string",
"description": "string",
"courierName": "string",
"amount": 0,
"balance": 0,
"accountId": 0,
"adjustmentTypeId": 0,
"createdAt": null,
"updatedAt": null
},
"transactionFee": {"id": 0,
"uid": "string",
"type": "debit",
"transType": "Shipment",
"state": "cleared",
"referenceNo": "string",
"description": "string",
"courierName": "string",
"amount": 0,
"balance": 0,
"accountId": 0,
"adjustmentTypeId": 0,
"createdAt": null,
"updatedAt": null
}
}

Add Sub Account

Add new customer to your account

Add new customer to your account with his own forwarding address.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

accountUid	string The accountUid to be used, if you only have one, we will detect automatically
externalAccountNumber	string
name required	string non-empty
displayName required	string non-empty
systemUnits required	string Enum: "imperial" "metric"
email required	string non-empty
notificationEmail required	string non-empty
website required	string
phone required	string non-empty
emergencyPhone required	string non-empty
taxId	string
	object or null
uid	string
accountNumber	string
status	string
language required	string
isBusiness required	boolean
allowBankAccountPayments	boolean
metadata	object
createdAt	date
updatedAt	date
deletedAt	date
addressId	number
billingAddressId	number
defaultShipFromId	number
defaultAddressOnLabelId	number
defaultReturnAddressId	number
primaryPaymentShipmentsId	number
logoId	number
pickupServiceFallbackId	number
revision	number
	object (AccountAddress)

Responses

Request samples

Code samples

Payload
application/json
{"accountUid": "string",
"externalAccountNumber": "string",
"name": "string",
"displayName": "string",
"systemUnits": "imperial",
"email": "string",
"notificationEmail": "string",
"website": "string",
"phone": "string",
"emergencyPhone": "string",
"taxId": "string",
"taxIdCountry": {"isoCode": "string"
},
"uid": "string",
"accountNumber": "string",
"status": "string",
"language": "string",
"isBusiness": true,
"allowBankAccountPayments": true,
"metadata": { },
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"addressId": 0,
"billingAddressId": 0,
"defaultShipFromId": 0,
"defaultAddressOnLabelId": 0,
"defaultReturnAddressId": 0,
"primaryPaymentShipmentsId": 0,
"logoId": 0,
"pickupServiceFallbackId": 0,
"revision": 0,
"address": {"useExistingAddress": true,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
}
}

Response samples

application/json

{"name": "string",
"displayName": "string",
"systemUnits": "imperial",
"email": "string",
"notificationEmail": "string",
"website": "string",
"phone": "string",
"emergencyPhone": "string",
"taxId": "string",
"taxIdCountry": {"isoCode": "string"
},
"uid": "string",
"accountNumber": "string",
"status": "string",
"language": "string",
"isBusiness": true,
"allowBankAccountPayments": true,
"metadata": { },
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"addressId": 0,
"billingAddressId": 0,
"defaultShipFromId": 0,
"defaultAddressOnLabelId": 0,
"defaultReturnAddressId": 0,
"primaryPaymentShipmentsId": 0,
"logoId": 0,
"pickupServiceFallbackId": 0,
"revision": 0,
"address": {"useExistingAddress": true,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
}
}

Api ReferenceVersion: 0.0.1

Download OpenAPI specification:

API Support: contact@weshipyou.com URL: https://weshipyou.com/docs/api License: Apache 2.0 Terms of Service

Find out how OpenAPI spec works.

Introduction

The WeShipYou API doesn't support bulk updates. You can work on only one object per request.

The WeShipYou API differs for every account as we release new versions and tailor functionality. Log in to see docs customized to your version of the API, with your test key and data.

OpenAPI Specification

Authentication

This topic describes the different forms of authentication that are available in the WeShipYou API, and how to use them.

WeShipYou offers four forms of authentication: secret key, publishable key, JSON Web Tokens, and public signature key.

Secret API key: Use to make requests from the server side. Never share these keys. Keep them guarded and secure.
Publishable API key: Use in your client-side code to tokenize payment information.
JWT: Use to make short-life tokens that expire after a set period of time.

Authentication

Get an API Access Token

WeShipYou uses Bearer Authentication to authenticate requests. You will need to include Authorization: Bearer <API Access Token> in the header for all requests.

Before you get started, you will need to generate an API Access Token on our dashboard.

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Pet object that needs to be added to the store

username	string Default: "{{username}}" Username registered with WeShipYou
password	string Default: "{{password}}" Your password

Responses

Request samples

Code samples

Payload
application/json
{"username": "{{username}}",
"password": "{{password}}"
}

Response samples

application/json

{"accessToken": "string",
"iat": 0,
"exp": 0,
"user": {"id": 0,
"uid": "string",
"username": "string",
"email": "string",
"isEnabled": true,
"isVerified": true,
"invalidTokensBeforeAt": null,
"metadata": { },
"termsAgreementDate": null,
"termsAgreementVersion": "string",
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"roleId": 0,
"avatarId": 0,
"revision": 0,
"role": { },
"avatar": { },
"user_detail": {"id": 0,
"uid": "string",
"taxId": "88-1345985",
"phone": "string",
"firstName": "string",
"lastName": "string",
"displayName": "string",
"gender": "string",
"language": "string",
"birthday": null,
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"userId": 0
},
"accounts": [{"name": "string",
"displayName": "string",
"systemUnits": "imperial",
"email": "string",
"notificationEmail": "string",
"website": "string",
"phone": "string",
"emergencyPhone": "string",
"taxId": "string",
"taxIdCountry": {"isoCode": "string"
},
"uid": "string",
"accountNumber": "string",
"status": "string",
"language": "string",
"isBusiness": true,
"allowBankAccountPayments": true,
"metadata": { },
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"addressId": 0,
"billingAddressId": 0,
"defaultShipFromId": 0,
"defaultAddressOnLabelId": 0,
"defaultReturnAddressId": 0,
"primaryPaymentShipmentsId": 0,
"logoId": 0,
"pickupServiceFallbackId": 0,
"revision": 0,
"address": {"useExistingAddress": true,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
}
}
]
}
}

Shipments

Everything about your shipments

Calculate shipping rates

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

required	string or string
totalValue required	number <= 2999
insurance	boolean
incoterms required	string Enum: "DDU" "DDP"
required	object (RatesAddress)
required	object (RatesAddress)
required	Array of objects (parcels) [ 1 .. 100 ] items

Responses

Request samples

Code samples

Payload
application/json
{"accountId": "string",
"totalValue": 2999,
"insurance": true,
"incoterms": "DDU",
"sender": {"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"country": {"isoCode": "US"
}
},
"recipient": {"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"country": {"isoCode": "US"
}
},
"parcels": [{"dimUnit": "cm",
"width": 10,
"length": 10,
"height": 10,
"weightUnit": "gm",
"weight": 100,
"parcel_items": [{"sku": "SKU-WSY-EXAMPLE",
"description": "Play Station 4",
"category": {"slug": "board_games"
},
"price": 450,
"qty": 1,
"originCountry": {"isoCode": "JP"
},
"weight": 0,
"currency": "USD"
}
]
}
]
}

Add a new shipment to your account

Add new shipment to your account inventory.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

required	string or string
required	object (sender)
required	object (recipient)
totalValue required	number <= 2999
externalReferenceCode	string
externalCustomerId	string
insurance	boolean
incoterms required	string Enum: "DDU" "DDP"
required	Array of objects (parcels) [ 1 .. 100 ] items

Responses

Request samples

Code samples

Payload
application/json
{"accountId": "string",
"sender": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"recipient": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"totalValue": 2999,
"externalReferenceCode": "string",
"externalCustomerId": "string",
"insurance": true,
"incoterms": "DDU",
"parcels": [{"dimUnit": "cm",
"width": 10,
"length": 10,
"height": 10,
"weightUnit": "gm",
"weight": 100,
"parcel_items": [{"sku": "SKU-WSY-EXAMPLE",
"description": "Play Station 4",
"category": {"slug": "board_games"
},
"price": 450,
"qty": 1,
"originCountry": {"isoCode": "JP"
},
"weight": 0,
"currency": "USD"
}
]
}
]
}

Find shipments

Lookup shipments to your account inventory.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Get shipment info

Get shipment shipment to your account inventory.

Authorizations:

JWTSecretApiKey

path Parameters

shipmentId

required

string

ID of shipment

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Update an existing shipment

Authorizations:

JWTSecretApiKey

path Parameters

shipmentId

required

string

ID of shipment

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

required	string or string
required	object (sender)
required	object (recipient)
totalValue required	number <= 2999
externalReferenceCode	string
externalCustomerId	string
insurance	boolean
incoterms required	string Enum: "DDU" "DDP"
required	Array of objects (parcels) [ 1 .. 100 ] items

Responses

Request samples

Code samples

Payload
application/json
{"accountId": "string",
"sender": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"recipient": {"useExistingAddress": false,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
},
"totalValue": 2999,
"externalReferenceCode": "string",
"externalCustomerId": "string",
"insurance": true,
"incoterms": "DDU",
"parcels": [{"dimUnit": "cm",
"width": 10,
"length": 10,
"height": 10,
"weightUnit": "gm",
"weight": 100,
"parcel_items": [{"sku": "SKU-WSY-EXAMPLE",
"description": "Play Station 4",
"category": {"slug": "board_games"
},
"price": 450,
"qty": 1,
"originCountry": {"isoCode": "JP"
},
"weight": 0,
"currency": "USD"
}
]
}
]
}

Delete / Cancel a shipment

Delete and cancel shipment when possible, shipments that are already handled by the carrier can not be canceled or refunded

Authorizations:

JWTSecretApiKey

path Parameters

shipmentId

required

string

Pet id to delete

header Parameters

Accept-Language	string Default: en-US Example: en-US The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT
x-api-key	string Example: Bearer <TOKEN>

Responses

Request samples

Get shipment categories

Get shipment categories.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Get country categories

Get specific country categories for customs purposes

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Services

WeShipYou Services

Find services

Find services available in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Forwarder

WeShipYou Forwarder Ooders

Find Forwarder Orders

Find Forwarder Orders Available in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"wsyOrderNumber": "WFO-7EB7DU",
"externalReferenceCode": "string",
"totalPrice": 0,
"totalItems": 0,
"sellerNotes": "string",
"buyerNotes": "string",
"personalShopperService": true,
"createdAt": null,
"updatedAt": null,
"destinationCountry": [{"id": 0,
"uid": "string",
"name": "string",
"slug": "string",
"isoCode": "string",
"isoCode3": "string",
"isoNumeric": 0,
"fips": "string",
"capital": "string",
"areaSqKm": 0,
"population": 0,
"continent": "string",
"tld": "string",
"currencyCode": "string",
"currencyName": "string",
"postalCodeFormat": "string",
"postalCodeRegex": "string",
"languages": "string",
"equivalentFipsCode": "string",
"phoneNumberPrefix": "string",
"allowShipFrom": true,
"allowShipTo": true,
"allowPickup": true,
"countryTax": 0,
"taxThresholdAmount": "string",
"dutyThresholdAmount": "string",
"thresholdMethod": "string",
"taxAndDutyCalculationMethod": "string",
"additionalDocuments": true,
"additionalInfoOda": null,
"additionalInfoNonWorkingDays": "string",
"additionalInfoHolidays": "string",
"customsPageUrl": "string",
"additionalInfoHolidaysUrl": "string",
"createdAt": null,
"updatedAt": null
}
],
"forwarding_order_items": [{"uid": "string",
"orderNumber": "string",
"sku": "string",
"description": "string",
"status": "string",
"url": "string",
"qty": 0,
"price": 0,
"shippingCost": 0,
"trackingNumber": "string",
"handlingCost": 0,
"weight": 0,
"color": "string",
"size": "string",
"alternativeColor": "string",
"alternativeSize": "string",
"observations": "string",
"imageUrl": "string",
"createdAt": null,
"updatedAt": null,
"currency": { },
"originCountry": { },
"category": {"id": 0,
"name": "string",
"sub": {"prop1": "string"
}
},
"country_category": {"uid": "string",
"name": "string",
"slug": "string",
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"containsDocuments": true,
"containsOtherDg": true,
"containsLiquids": true,
"containsBatteryPi967": true,
"containsBatteryPi966": true,
"containsBatteryPi965": true,
"customsValue": 0,
"qty": 0,
"maxWeight": 0,
"unitType": "string",
"observations": "string",
"isDiscontinued": true,
"createdAt": null,
"updatedAt": null,
"parentId": 0
}
}
]
}
]
}

Mobile Recharges

WeShipYou FoMobile Recharges

Find Mobile Recharge Providers

Find Mobile Recharge Providers in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"name": "Cubacel",
"externalCode": "CUCU",
"active": true,
"createdAt": null,
"updatedAt": null
}
]
}

Find Mobile Recharge Providers Descriptions

Find Mobile Recharge Providers Descriptions in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"displayName": "Cubacel",
"description": "string",
"localeId": 0,
"providerId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Find Mobile Recharge Products Descriptions

Find Mobile Recharge Products Descriptions in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"title": "EUR 10.00",
"descriptionMarkdown": "string",
"extendedDescriptionMarkdown": "string",
"localizationKey": "0ALULU96671",
"productId": 0,
"localeId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Find Mobile Recharges

Find Mobile Recharges in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Responses

Request samples

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"externalReferenceCode": "string",
"externalCustomerId": "string",
"status": "delivered",
"amount": 0,
"price": 0,
"notes": "string",
"scheduleDate": null,
"deliveredAt": null,
"accountId": 0,
"countryId": 0,
"rechargeableProductId": 0,
"rechargeableProviderPromotionId": 0,
"labelId": 0,
"couponId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Create Mobile Recharges

Create Mobile Recharges in WeShipYou.com

Authorizations:

JWTSecretApiKey

query Parameters

$limit

number [ 0 .. 500 ]

Default: 20

Limit a number of results

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

paymentMethod	string The payment method to be used
accountUid	string The accountUid to be used, if you only have one, we will detect automatically
	object
scheduleDate	date or null
amount	number
	object

Responses

Request samples

Code samples

Payload
application/json
{"paymentMethod": "zelle",
"accountUid": "string",
"rechargeable_product": {"id": 0
},
"scheduleDate": null,
"amount": 0,
"account_rechargeable_contact": {"name": "string",
"accountNumber": "string"
}
}

Response samples

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"uid": "vd7x0pekjjz5",
"externalReferenceCode": "string",
"externalCustomerId": "string",
"status": "delivered",
"amount": 0,
"price": 0,
"notes": "string",
"scheduleDate": null,
"deliveredAt": null,
"accountId": 0,
"countryId": 0,
"rechargeableProductId": 0,
"rechargeableProviderPromotionId": 0,
"labelId": 0,
"couponId": 0,
"createdAt": null,
"updatedAt": null
}
]
}

Add Funds

Add funds to your account

Add money to ypu account.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

paymentMethod	string Default: "zelle" The payment method to be used
accountUid	string The accountUid to be used, if you only have one, we will detect automatically
	object

Responses

Request samples

Code samples

Payload
application/json
{"paymentMethod": "zelle",
"accountUid": "string",
"transaction": {"zelleTransaction": "string",
"amount": 0
}
}

Response samples

application/json

{"result": true,
"transaction": {"id": 0,
"uid": "string",
"type": "debit",
"transType": "Shipment",
"state": "cleared",
"referenceNo": "string",
"description": "string",
"courierName": "string",
"amount": 0,
"balance": 0,
"accountId": 0,
"adjustmentTypeId": 0,
"createdAt": null,
"updatedAt": null
},
"transactionFee": {"id": 0,
"uid": "string",
"type": "debit",
"transType": "Shipment",
"state": "cleared",
"referenceNo": "string",
"description": "string",
"courierName": "string",
"amount": 0,
"balance": 0,
"accountId": 0,
"adjustmentTypeId": 0,
"createdAt": null,
"updatedAt": null
}
}

Add Sub Account

Add new customer to your account

Add new customer to your account with his own forwarding address.

Authorizations:

JWTSecretApiKey

header Parameters

Accept-Language

string

Default: en-US

Example: en-US

The language you prefer for messages. Supported values are en-AU, en-CA, en-GB, en-US, es-ES, es-US, pt-BR pt-PT

Request Body schema:
application/json

Shipment object that needs to be added to your account

accountUid	string The accountUid to be used, if you only have one, we will detect automatically
externalAccountNumber	string
name required	string non-empty
displayName required	string non-empty
systemUnits required	string Enum: "imperial" "metric"
email required	string non-empty
notificationEmail required	string non-empty
website required	string
phone required	string non-empty
emergencyPhone required	string non-empty
taxId	string
	object or null
uid	string
accountNumber	string
status	string
language required	string
isBusiness required	boolean
allowBankAccountPayments	boolean
metadata	object
createdAt	date
updatedAt	date
deletedAt	date
addressId	number
billingAddressId	number
defaultShipFromId	number
defaultAddressOnLabelId	number
defaultReturnAddressId	number
primaryPaymentShipmentsId	number
logoId	number
pickupServiceFallbackId	number
revision	number
	object (AccountAddress)

Responses

Request samples

Code samples

Payload
application/json
{"accountUid": "string",
"externalAccountNumber": "string",
"name": "string",
"displayName": "string",
"systemUnits": "imperial",
"email": "string",
"notificationEmail": "string",
"website": "string",
"phone": "string",
"emergencyPhone": "string",
"taxId": "string",
"taxIdCountry": {"isoCode": "string"
},
"uid": "string",
"accountNumber": "string",
"status": "string",
"language": "string",
"isBusiness": true,
"allowBankAccountPayments": true,
"metadata": { },
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"addressId": 0,
"billingAddressId": 0,
"defaultShipFromId": 0,
"defaultAddressOnLabelId": 0,
"defaultReturnAddressId": 0,
"primaryPaymentShipmentsId": 0,
"logoId": 0,
"pickupServiceFallbackId": 0,
"revision": 0,
"address": {"useExistingAddress": true,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
}
}

Response samples

application/json

{"name": "string",
"displayName": "string",
"systemUnits": "imperial",
"email": "string",
"notificationEmail": "string",
"website": "string",
"phone": "string",
"emergencyPhone": "string",
"taxId": "string",
"taxIdCountry": {"isoCode": "string"
},
"uid": "string",
"accountNumber": "string",
"status": "string",
"language": "string",
"isBusiness": true,
"allowBankAccountPayments": true,
"metadata": { },
"createdAt": null,
"updatedAt": null,
"deletedAt": null,
"addressId": 0,
"billingAddressId": 0,
"defaultShipFromId": 0,
"defaultAddressOnLabelId": 0,
"defaultReturnAddressId": 0,
"primaryPaymentShipmentsId": 0,
"logoId": 0,
"pickupServiceFallbackId": 0,
"revision": 0,
"address": {"useExistingAddress": true,
"nickname": "string",
"address": {"city": {"name": "Homestead",
"state": {"name": "Florida"
}
},
"street": "924 NW 36 Ave",
"postalCode": "33033"
},
"name": "Jhon Doe",
"companyName": "We Ship You Corp",
"taxId": "88-1345985",
"taxIdCountry": {"isoCode": "US"
},
"phone": "+1 (786) 651-0451",
"email": "jhon.doe@weshipyou.com",
"country": {"isoCode": "US"
}
}
}

Api ReferenceVersion: 0.0.1

Introduction

OpenAPI Specification

Cross-Origin Resource Sharing

Authentication

Authentication

Get an API Access Token

header Parameters

Request Body schema: application/json

Responses

Shipments

Calculate shipping rates

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Add a new shipment to your account

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Find shipments

Authorizations:

header Parameters

Responses

Get shipment info

Authorizations:

path Parameters

header Parameters

Responses

Update an existing shipment

Authorizations:

path Parameters

header Parameters

Request Body schema: application/json

Responses

Delete / Cancel a shipment

Authorizations:

path Parameters

header Parameters

Responses

Get shipment categories

Authorizations:

header Parameters

Responses

Get country categories

Authorizations:

header Parameters

Responses

Services

Find services

Authorizations:

query Parameters

header Parameters

Responses

Forwarder

Find Forwarder Orders

Authorizations:

query Parameters

header Parameters

Responses

Mobile Recharges

Find Mobile Recharge Providers

Authorizations:

query Parameters

header Parameters

Responses

Find Mobile Recharge Providers Descriptions

Authorizations:

query Parameters

header Parameters

Responses

Find Mobile Recharge Products Descriptions

Authorizations:

query Parameters

header Parameters

Responses

Find Mobile Recharges

Authorizations:

query Parameters

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json

Request Body schema:
application/json