Shipping to a Single Address (Console)

The information in Requesting Shipment: Introduction applies to shipping to a single address using the console; see the Restrictions section, which lists the limits on field content (Shipment Request Field Limitations) and gives guidance on format.

Note

Although Console users can specify the inventory they want to draw from for individual shipment requests, this option is not available for bulk shipments. Bulk shipment requests for Subscription (1.0) allow only the selection of initial, replacement, or buffer stock. When inventory is not specified or cannot be specified, the system uses the “first in, first out” rule, which means it will deduct from the oldest purchase order first.

Procedure

To use the Console to request shipping of keys from your inventory to an individual address, click either:

  • CREATE SHIPMENT REQUEST in the card for the appropriate subscription on the Dashboard, or
  • The Create shipment request button on the Shipments tab.

The New shipping request popup appears. The tab on the left, Single shipment, is shown on top by default. CREATE SHIPMENT REQUEST takes you directly to the appropriate subscription, whereas if you use the Create shipment request button on the Shipments tab, you must specify which subscription inventory you want to use.

Field Names

This section describes what the form expects in each field.

Channel Partner = Seller

Even if the entity that sold YubiKeys to you was Yubico itself, the Channel partner name must be selected. The Channel partner ID field is automatically populated when the Channel partner name is selected.

Name

First Line

In the Console, First name and Last name and in the CSV file, recipient_firstname and recipient_lastname map to the first line on the shipping label.

Long recipient names can be problematic for all methods of requesting shipment, because the shipment request will fail if the contents of the First name / Last name fields and/or Company or recipient fields exceed the maximum number of characters permitted in these fields (shown in the table below). Workaround: When a recipient’s full name or company name exceeds the fields’ maximum lengths, split the names across the three fields, for example:

Location Field (limit=15) Limit Field (limit=20) Limit Field (limit=20) Limit
API recipient_firstname 15 recipient_lastname 20 recipient 20
CSV recipient_firstname 15 recipient_lastname 20 recipient_company 20
Console First name 15 Last name 20 Company 20
Example of an overly long name before adjustment to fit the fields
  Johannes-Maximilian   von Derschowitz-Dampfloch zu Querdenker
Example after adjustment
  Joh.-Maximilian   v.DerschowitzDampfloch   zu Querdenker  

Second Line

The second line on the shipping label maps to the name of the recipient’s company if the address is not residential. For example, the system’s address verification function recognizes that Yubico’s Santa Clara facility is in a commercial building, therefore the company name is expected in:

  • The Company field in the Console

  • The recipient_company column in the CSV.

  • The recipient field in the API

    Note

    API: Do not use the /shipments recipient field to specify the name of the individual to whom products are to be shipped. For this, use the recipient_firstname and recipient_last name fields instead.

If the address is residential, leave empty:

  • The Company field in the Console
  • The recipient_company cell in the CSV file
  • The recipient field in the API.
Examples of Bad Usage of Company Name Field

For example, entering the following information for a shipment request would result in failure because USPS recognizes that there are multiple companies in the building whose address is 530 Lytton Avenue:

Jan Lindberg
530 Lytton Avenue
Palo Alto, CA 94301
USA

Similarly, entering the following information for a shipment request would result in failure because a residential address would not be associated with a company.

Jan Lindberg
Yubico Inc.
6 Lea Rd
Dronfield S18 1SB
UK

Address Fields/Lines

Fill in the address field(s) - Address line 1 (and 2 and 3 if applicable) - using the address formats provided by Google Maps (for more detailed information on this, see the note in Troubleshooting). The limits on the various fields and the options for the dropdown are given in Shipment Request Field Limitations.

Contact Phone

This field is for the telephone number of the shipment recipient. It is used by the carrier to complete the last stage of delivery. Submitting an invalid phone number may result in the order being returned to the sender.

Delivery Type

For the Delivery Type dropdown, select one of the two shipment types, Normal or Expedited. Your selection determines the shipping fee, which is calculated after you complete the shipping request.

From Stock: Inventory

Select the inventory that you are drawing on in the From stock dropdown list by clicking on the dropdown to display the options, then on the appropriate checkbox(es). Select as many inventories as you want: a separate “box” or field for each inventory will be shown.

For a complete list and explanations of the options, see Inventory Matters. In the screenshot below, the number 4 on the right in the From stock field shows that four inventories were selected - those shown below the field. (The field itself is not wide enough to display the names of more than one of them; the three dots following in the field indicate that further selections were made).

_images/ship-request-single-from-stock.png

As soon as you have selected the stock and clicked in the Shipping quantity field for a key, any quantities you previously entered in that field are displayed.

_images/from-stock-quantities.png

Enter the desired quantities in the appropriate fields.

Note

If you select an inventory, but do not indicate Shipping quantity in any of the Product type fields, no shipment request is created.

Finish Request

Click Create shipment request. The Shipment confirmation popup appears:

_images/shipment-confirmation.png

Click Confirm. If all went well, you are notified that your request was accepted:

_images/request-accepted.png

The Console provides some information on the reasons for shipping requests not succeeding; the API provides more detailed information.

These error messages accessible via the API tell you why a given shipment request was unsuccessful. It is worth reviewing them before making any shipping requests in order to see what sort of issues might arise and thereby avoid them in the first place.

Note

As the following table is wide, you might need to scroll horizontally.

In the Explanation column, the source of the message is given: YubiEnterprise Delivery system for internal messages, US Validation for the US Postal Service, and finally, International Validation. Messages originating from the last two are simply passed on to you by YubiEnterprise Delivery.

YubiEnterprise Delivery API /shipment_exact Status Messages
Message Explanation
InventoryProductId not specified for ProductId %d - ShipmentStateError
YubiEnterprise Delivery system
Too many keys in shipment - TotalKeysShipped %d > %d - ShipmentStateError
YubiEnterprise Delivery system
Not enough Inventory for Shipment - ShipmentStateError
YubiEnterprise Delivery system
Re-enter the address differently; some parts of it are invalid. See
the YubiEnterprise documentation for more guidance.
US Validation
The address is invalid. See the YubiEnterprise documentation for more
guidance.
US Validation
The address is valid.
No further explanation required
US Validation
Remove the ‘secondary unit designator’ (apt, suite, department, etc.)
because it is superfluous.
Remove the apartment number, unit, etc.:
it is considered wrong or unnecessary
US Validation
Enter second line information (apartment, unit, etc.).
The information in the primary line is not specific enough.
Add the apartment number, unit, etc.
US Validation
The address is a valid military address.
No further explanation required
US Validation
The address is a valid General Delivery address where individuals without
permanent addresses can receive mail.
No further explanation required
US Validation
The address is valid. An organization such as a government agency can
can have its own zipcode because it receives a large volume of mail.
No further explanation required
US Validation
Enter a street number; for example, for Yubico ‘Lytton Ave’ alone is not
sufficient, it needs to be ‘530 Lytton Ave’.
The number on the primary line, e.g., the
“185” in “185 Berry Street” is missing
Enter a valid street number.
The number on the primary line, e.g., the
“185” in “185 Berry Street” is not valid
US Validation
Enter a PO Box, Rural Route, or Highway Contract box number.
US Validation
Enter a valid PO Box, Rural Route, or Highway Contract box number.
US Validation
Enter the Private Mailbox (PMB) identifier or the # sign, followed by the
PMB number.
PMB number is Private Mailbox Number
US Validation
This address is not eligible to receive mail.
US Validation
The address is that of a Commercial Mail Receiving Agency (CMRA) a private
business that accepts mail for recipients, and the required private
mailbox information is present.
US Validation
The address is missing some important secondary line information
(apartment, unit, etc).
No further explanation required
International Validation
Mail is unlikely to arrive at this destination - please verify input.
No further explanation required
International Validation
This street could not be found within the city or postal code.
No further explanation required
International Validation
Invalid OrganizationId for Shipment YubiEnterprise Delivery system
Country Code not set for Shipment YubiEnterprise Delivery system
Country could not be found from CountryCode2: %s
Country code entered is not in
YubiEnterprise Delivery system list
Shipment has no shipment items YubiEnterprise Delivery system
DeliveryType not set for Shipment, defaulting to 1 - normal YubiEnterprise Delivery system
Invalid DeliveryType %s for Shipment YubiEnterprise Delivery system
InventoryType not set for Shipment, defaulting to 1 YubiEnterprise Delivery system
InventoryType %s not valid set for Shipment
You cannot use this InventoryType for this
shipment - YubiEnterprise Delivery system
Negative quantity entered for ShipmentItem with ProductId=%d defaulting to 0
You set the quantity of the specified
ProductID to be shipped to less than zero.
YubiEnterprise Delivery system
Invalid ShipmentProductQuantity for ShipmentItem %d
You probably do not have sufficient
inventory - YubiEnterprise Delivery system
Invalid ShipmentProductLineCost for ShipmentItem %d YubiEnterprise Delivery system
Invalid Shipment - Total keys in shipment greater than 500
You cannot ship more than 500 items at
once - YubiEnterprise Delivery system
Shipment has zero total item quantity
The number of items to be shipped must be
> than 0 - YubiEnterprise Delivery system
US Address is missing the state name/abbreviation in region field
No further explanation required
YubiEnterprise Delivery system
Bad ProductId in ShipmentProduct for NewShipmentProduct
ProductID is wrongly specified or invalid
YubiEnterprise Delivery system
Input for %s exceeded limit of %d characters
Specified field cannot accept the number
of characters that were entered.
YubiEnterprise Delivery system
Shipment of these products to this country using this delivery type is
not supported. For more information, see Delivery Policies.
Shipment request contravenes one or more
business rules. YubiEnterprise Delivery
system.

Shipment Request Field Limitations

In the table below, all fields not marked as mandatory are optional. The Limit column displays the maximum number of alphanumeric characters permitted per field/table cell.

Shipment Request Fields
 
Console: Field Label
CSV: Column Heading
Description Limit
 
Country code
country_code_2
Mandatory. Country code from available_countries.csv 2
1 Company recipient Mandatory if name of recipient is not provided 20
First name
recipient_firstname
Name of recipient. Mandatory if company name not given 15
Last name
recipient_lastname
Recipient’s family name. Mandatory, absent company name 20
 
Address 1
street_line1
Mandatory. First line of address 60
 
Address 2
street_line2
Mandatory if address undeliverable without (e.g. suite #) 60
 
Address 3
street_line3
Not supported for expedited/rush orders 60
  City Mandatory. City, town, or township 60
2
Region/State
region



For the US and Canada, USPS codes are mandatory. See
USPS Codes for US and Canada. (Console users: Select code
from dropdown). For other countries, region or state is
mandatory if the address is not deliverable without it.
To check address deliverability, see footnote to table.
50
 
Postcode
postal_code
Zip code or postal code 50
 
RecipientEmail
recipient_email
Recipient’s email address 80
3
Contact Phone
RecipientTelephone
recipient_telephone


Mandatory. Telephone number of shipment recipient
The limit is 40 of the alphanumeric characters
“0-9+-( )” unless the country code is IN, in which
case the limit is 255. Any format is acceptable,
with or without spaces
40
4
DeliveryType
delivery_type
Type of shipping, “Normal” (1) or “Expedited” (2).
Integers (mandatory for API) OR words
5 InventoryType
Mandatory. Console users select from dropdown. For bulk
orders and API users, see Product ID and Inventory Product ID.
6
ChannelPartnerId
channel_partner_ID
Mandatory. If inventory was purchased directly from
Yubico, enter “1”; if not, enter the ChannelPartnerId
3
  Yubikey 5 NFC Number of keys to be shipped 3
  YubiKey 5 Nano Number of keys to be shipped 3
  YubiKey 5C Number of keys to be shipped 3
  YubiKey 5C Nano Number of keys to be shipped 3
  YubiKey 5Ci Number of keys to be shipped 3
  YubiKey 5Ci FIPS Number of keys to be shipped 3
  YubiKey 5C NFC FIPS Number of keys to be shipped 3
  YubiKey 5C Nano FIPS Number of keys to be shipped 3
  YubiKey 5C FIPS Number of keys to be shipped 3
  YubiKey 5 NFC FIPS Number of keys to be shipped 3
  YubiKey 5 Nano FIPS Number of keys to be shipped 3
 
YubiKey C Bio -
FIDO Edition
Number of keys to be shipped 3
  YubiKey Bio - FIDO Edition Number of keys to be shipped 3
 
Security Key NFC
by Yubico (Black)
Number of keys to be shipped 3
 
Security Key C NFC
by Yubico (Black)
Number of keys to be shipped 3
 
Security Key NFC
by Yubico -
Enterprise Edition
Number of keys to be shipped 3
 
Security Key C NFC
by Yubico -
Enterprise Edition
Number of keys to be shipped 3

Note

To find out if an address is deliverable, make a shipment request and see what status code or message it gets. Deliverability is determined by our shipping partners, and it is their codes and messages we display when it comes to questions of deliverability. For a fuller explanation, see Troubleshooting.

Shipment Status Messages

These error messages accessible via the API tell you why a given shipment request was unsuccessful. It is worth reviewing them before making any shipping requests in order to see what sort of issues might arise and thereby avoid them in the first place.

Note

As the following table is wide, you might need to scroll horizontally.

In the Explanation column, the source of the message is given: YubiEnterprise Delivery system for internal messages, US Validation for the US Postal Service, and finally, International Validation. Messages originating from the last two are simply passed on to you by YubiEnterprise Delivery.

YubiEnterprise Delivery API /shipment_exact Status Messages
Message Explanation
InventoryProductId not specified for ProductId %d - ShipmentStateError
YubiEnterprise Delivery system
Too many keys in shipment - TotalKeysShipped %d > %d - ShipmentStateError
YubiEnterprise Delivery system
Not enough Inventory for Shipment - ShipmentStateError
YubiEnterprise Delivery system
Re-enter the address differently; some parts of it are invalid. See
the YubiEnterprise documentation for more guidance.
US Validation
The address is invalid. See the YubiEnterprise documentation for more
guidance.
US Validation
The address is valid.
No further explanation required
US Validation
Remove the ‘secondary unit designator’ (apt, suite, department, etc.)
because it is superfluous.
Remove the apartment number, unit, etc.:
it is considered wrong or unnecessary
US Validation
Enter second line information (apartment, unit, etc.).
The information in the primary line is not specific enough.
Add the apartment number, unit, etc.
US Validation
The address is a valid military address.
No further explanation required
US Validation
The address is a valid General Delivery address where individuals without
permanent addresses can receive mail.
No further explanation required
US Validation
The address is valid. An organization such as a government agency can
can have its own zipcode because it receives a large volume of mail.
No further explanation required
US Validation
Enter a street number; for example, for Yubico ‘Lytton Ave’ alone is not
sufficient, it needs to be ‘530 Lytton Ave’.
The number on the primary line, e.g., the
“185” in “185 Berry Street” is missing
Enter a valid street number.
The number on the primary line, e.g., the
“185” in “185 Berry Street” is not valid
US Validation
Enter a PO Box, Rural Route, or Highway Contract box number.
US Validation
Enter a valid PO Box, Rural Route, or Highway Contract box number.
US Validation
Enter the Private Mailbox (PMB) identifier or the # sign, followed by the
PMB number.
PMB number is Private Mailbox Number
US Validation
This address is not eligible to receive mail.
US Validation
The address is that of a Commercial Mail Receiving Agency (CMRA) a private
business that accepts mail for recipients, and the required private
mailbox information is present.
US Validation
The address is missing some important secondary line information
(apartment, unit, etc).
No further explanation required
International Validation
Mail is unlikely to arrive at this destination - please verify input.
No further explanation required
International Validation
This street could not be found within the city or postal code.
No further explanation required
International Validation
Invalid OrganizationId for Shipment YubiEnterprise Delivery system
Country Code not set for Shipment YubiEnterprise Delivery system
Country could not be found from CountryCode2: %s
Country code entered is not in
YubiEnterprise Delivery system list
Shipment has no shipment items YubiEnterprise Delivery system
DeliveryType not set for Shipment, defaulting to 1 - normal YubiEnterprise Delivery system
Invalid DeliveryType %s for Shipment YubiEnterprise Delivery system
InventoryType not set for Shipment, defaulting to 1 YubiEnterprise Delivery system
InventoryType %s not valid set for Shipment
You cannot use this InventoryType for this
shipment - YubiEnterprise Delivery system
Negative quantity entered for ShipmentItem with ProductId=%d defaulting to 0
You set the quantity of the specified
ProductID to be shipped to less than zero.
YubiEnterprise Delivery system
Invalid ShipmentProductQuantity for ShipmentItem %d
You probably do not have sufficient
inventory - YubiEnterprise Delivery system
Invalid ShipmentProductLineCost for ShipmentItem %d YubiEnterprise Delivery system
Invalid Shipment - Total keys in shipment greater than 500
You cannot ship more than 500 items at
once - YubiEnterprise Delivery system
Shipment has zero total item quantity
The number of items to be shipped must be
> than 0 - YubiEnterprise Delivery system
US Address is missing the state name/abbreviation in region field
No further explanation required
YubiEnterprise Delivery system
Bad ProductId in ShipmentProduct for NewShipmentProduct
ProductID is wrongly specified or invalid
YubiEnterprise Delivery system
Input for %s exceeded limit of %d characters
Specified field cannot accept the number
of characters that were entered.
YubiEnterprise Delivery system
Shipment of these products to this country using this delivery type is
not supported. For more information, see Delivery Policies.
Shipment request contravenes one or more
business rules. YubiEnterprise Delivery
system.

To file a support ticket for YubiEnterprise Delivery, click Support.