Retriever icon

Retriever

Interact with Retriever API

Actions9

Deployment Order → Create Deployment Order

AI-generated

Summary

Creates a device deployment order in Retriever.

Inputs

  • ticketId — A unique value identifying this ticket
  • displayName — The display name of the company deploying the device
  • deviceId (required) — A unique value identifying this device
  • employeeName (required) — Employee name
  • employeeEmail (required) — Employee email
  • employeeAddressLine1 (required) — Employee address line 1
  • employeeAddressLine2 — Employee address line 2
  • employeeAddressCity (required) — Employee city
  • employeeAddressState (required) — Employee state
  • employeeAddressZip (required) — Employee ZIP/postal code
  • employeeAddressCountry (required) — Employee country
  • recipientReturnRecipientName — Required if return_order_type is deliver_to_another_address
  • recipientReturnAddressCompany — Recipient address company
  • recipientReturnAddressLine1 — Recipient address line 1
  • recipientReturnAddressLine2 — Recipient address line 2
  • recipientReturnAddressCity — Recipient address city
  • recipientReturnAddressState — Recipient address state
  • recipientReturnAddressZip — Recipient address ZIP/postal code
  • recipientReturnAddressCountry — Recipient address country
  • returnOrderType — The type of return order
  • notificationEmails — Email address to send notifications to
  • includeReturnLabel (required) — Whether to include a return label in the deployment order
  • notes — Notes for the deployment order
  • shippingSpeed — The shipping speed for the deployment order
  • requestOptions — Request options for batching
  • allowUnauthorizedCerts — Whether to accept the response even if SSL certificate validation is not possible
  • proxy — HTTP proxy to use
  • timeout — Time in ms to wait for server to send response headers before aborting

Output shape

object

The created deployment order object as returned by the Retriever API.

Examples

Example 1: Creating a standard deployment order with required employee info

Set deviceId, employeeName, employeeEmail, employeeAddressLine1, employeeAddressCity, employeeAddressState, employeeAddressZip, employeeAddressCountry. Optional: set ticketId, displayName, shippingSpeed, notes, includeReturnLabel, returnOrderType, and any recipient info if needed.

Links

Discussion