Store Order Use Cases

Store Order Request

The storeOrderRequest API enables the client to place orders for New Devices (New), Upgrade existing Devices (Upgrade / Upgrade Device Only), Port a Number from another carrier (LNP), activate your own device (COAM), and purchase Accessories (Accessory Only).

The storeOrderRequest returns a Response that either confirms that your order was received or contains an error code if there is an issue with the order. To track the Order Status, please consult the Order Status API instructions.

Store Orders use SKUs from the catalog to identify Devices, Accessories, Rate Plans, and Data Plans. To check the Premier catalog for product Availability, Compatibility, and Pricing information before you submit your order, consult the Store Order SKU Availability and Price Quote API references under the API References / Store Orders menu item.

Use Cases

New Device Activation (NEW)

Suppose you hired a new employee that is eligible to purchase a new Device with the AT&T mobility service.  The storeOrderRequest API, with lineOfService/Type set to New, will allow the employee to order a New Device with a compatible Rate Plan, Data Plan, Feature, and Accessory and activate the Device on the AT&T network.

Upgrade Device (Upgrade) (Upgrade Device Only)

Suppose your employee would like to upgrade their existing AT&T device.  The storeOrderRequest API, with linesOfService/Type set to "Upgrade", will allow the employee to Upgrade their existing wireless Device with a compatible Rate Plan, Data Plan, Feature, and Accessory.  Once the Device is shipped and received, it can be activated on the AT&T network. The"UpgradeDeviceOnly" option is used when you Upgrade a Device without any other changes to the Rate Plan, Features, etc.

Customer Owned and Maintained Equipment (COAM)

Suppose your employee would like to bring their own Device and activate that Device on the AT&T network.  To use the storeOrderRequest to order Rate Plans, Data Plans, and Accessories for a Customer-Owned and Managed (COAM) Device, set linesOfService/Type to "COAM".

When activating a Device with a SIM, you can include the ICCID in the Request to use your current Sim. If you do not include the ICCID in the Request, a new physical Sim will be shipped to you, or a new eSim will be activated.

Local Number Portability (LNP)

Suppose your employee would like to port (transfer) a Number from another carrier to a New Device and activate that Device on the AT&T network.  To use the storeOrderRequest to port (transfer) a Wireless Number from another provider to AT&T, set linesOfService/Type to "LNP".

Accessory Only

Suppose your employee would like to purchase a standalone accessory, apart from ordering a device.  To use the storeOrderRequest to order only an accessory, set linesOfService/Type to "Accessory Only".  You should not include any SKUs that are not an "accessory".