XPS ShipInstall

Summary

Create a new shipping order in XPS Ship by providing customer ID along with detailed sender, receiver, and package information.

Inputs

• Customer ID (required) — XPS Ship customer ID.
• Sender Information — Details about the sender including company, name, address lines, city, state/province, postal code, country (default US), phone, and email.
• Receiver Information — Details about the receiver including company, name, address lines, city, state/province, postal code, country (default US), phone, and email.
• Package Information — Details about the package including weight (in pounds), length, width, height (all in inches), and package type (custom, letter, tube, pak, express box).

Output shape

a single JSON object containing the created order's details as returned by the XPS Ship API.

The output includes the API response representing the created order. If the request fails, an error is thrown unless 'Continue On Fail' is enabled, in which case an error message is returned in the output.

Examples

Example 1: Create an order with mandatory customer ID and optional sender, receiver, and package details to initiate shipping via XPS Ship.

Set 'Customer ID' to your XPS Ship customer identifier. Optionally provide sender and receiver collections with address and contact details and package collection with dimensions and type to define the shipment.