Update Order Item - Update Order Item

Service:: Edge Hardware Center

API Version:: 2021-12-01

Updates the properties of an existing order item.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}?api-version=2021-12-01

URI Parameters

Name	In	Required	Type	Description
orderItemName	path	True	string	The name of the order item
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Header

Name	Required	Type	Description
If-Match		string	Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.

Request Body

Name	Type	Description
properties.forwardAddress	AddressProperties	Updates forward shipping address and contact details.
properties.notificationEmailList	string[]	Additional notification email list.
properties.preferences	Preferences	Customer preference.
tags	object	The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).

Responses

Name	Type	Description
200 OK	OrderItemResource	Order item resource object.
202 Accepted		Accepted request for order item update.
Other Status Codes	ErrorResponse	Error response describing reason for operation failure.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

UpdateOrderItem

Sample request

HTTP

PATCH https://management.azure.com/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3?api-version=2021-12-01

{
  "properties": {
    "preferences": {
      "transportPreferences": {
        "preferredShipmentType": "CustomerManaged"
      }
    }
  }
}

Sample response

Status code:: 200

{
  "properties": {
    "orderItemDetails": {
      "productDetails": {
        "displayInfo": {
          "productFamilyDisplayName": "Azure Stack Edge",
          "configurationDisplayName": "Azure Stack Edge Pro - 1 GPU"
        },
        "hierarchyInformation": {
          "productFamilyName": "azurestackedge",
          "productLineName": "azurestackedge",
          "productName": "azurestackedgegpu",
          "configurationName": "edgep_base"
        },
        "count": 0,
        "productDoubleEncryptionStatus": "Disabled"
      },
      "orderItemType": "Purchase",
      "currentStage": {
        "stageStatus": "Succeeded",
        "stageName": "Placed",
        "startTime": "2022-03-04T11:30:31.5838042+05:30"
      },
      "orderItemStageHistory": [
        {
          "stageStatus": "Succeeded",
          "stageName": "Placed",
          "startTime": "2022-03-04T11:30:31.5838042+05:30"
        },
        {
          "stageStatus": "None",
          "stageName": "Confirmed"
        },
        {
          "stageStatus": "None",
          "stageName": "ReadyToShip"
        },
        {
          "stageStatus": "None",
          "stageName": "Shipped"
        },
        {
          "stageStatus": "None",
          "stageName": "Delivered"
        },
        {
          "stageStatus": "None",
          "stageName": "InUse"
        }
      ],
      "preferences": {
        "transportPreferences": {
          "preferredShipmentType": "CustomerManaged"
        }
      },
      "notificationEmailList": [],
      "cancellationStatus": "Cancellable",
      "deletionStatus": "NotAllowed",
      "returnStatus": "NotReturnable",
      "managementRpDetailsList": [
        {
          "resourceProviderNamespace": "Microsoft.DataBoxEdge"
        }
      ]
    },
    "addressDetails": {
      "forwardAddress": {
        "shippingAddress": {
          "streetAddress1": "16 TOWNSEND ST",
          "streetAddress2": "UNIT 1",
          "city": "San Francisco",
          "stateOrProvince": "CA",
          "country": "US",
          "postalCode": "94107",
          "companyName": "Microsoft",
          "addressType": "None"
        },
        "contactDetails": {
          "contactName": "XXXX XXXX",
          "phone": "0000000000",
          "phoneExtension": "",
          "emailList": [
            "xxxx@xxxx.xxx"
          ]
        },
        "addressValidationStatus": "Valid"
      }
    },
    "startTime": "2022-03-04T11:29:47.3483197+05:30",
    "orderId": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderName3"
  },
  "systemData": {
    "createdAt": "0001-01-01T05:30:00+05:30",
    "lastModifiedAt": "0001-01-01T05:30:00+05:30"
  },
  "location": "eastus",
  "tags": {},
  "name": "TestOrderItemName3",
  "id": "/subscriptions/YourSubscriptionId/resourceGroups/YourResourceGroupName/providers/Microsoft.EdgeOrder/orderItems/TestOrderItemName3",
  "type": "Microsoft.EdgeOrder/orderItems"
}

Status code:: 202

Definitions

Name	Description
ActionStatusEnum	Describes whether the order item is deletable or not.
AddressDetails	Address details for an order item.
AddressProperties	Address Properties
AddressType	Type of address.
AddressValidationStatus	Status of address validation
ContactDetails	Contact Details.
createdByType	The type of identity that created the resource.
DeviceDetails	Device details.
DisplayInfo	Describes product display information
DoubleEncryptionStatus	Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
EncryptionPreferences	Preferences related to the double encryption
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ForwardShippingDetails	Forward shipment details.
HierarchyInformation	Holds details about product hierarchy information
ManagementResourcePreferences	Management resource preference to link device
NotificationPreference	Notification preference for a job stage.
NotificationStageName	Name of the stage.
OrderItemCancellationEnum	Describes whether the order item is cancellable or not.
OrderItemDetails	Order item details
OrderItemResource	Represents order item contract
OrderItemReturnEnum	Describes whether the order item is returnable or not.
OrderItemType	Order item type.
OrderItemUpdateParameter	Updates order item parameters.
Preferences	Preferences related to the order
ProductDetails	Represents product details
ResourceProviderDetails	Management RP details
ReverseShippingDetails	Reverse shipment details.
ShippingAddress	Shipping address where customer wishes to receive the device.
StageDetails	Resource stage details.
StageName	Stage name
StageStatus	Stage status.
systemData	Metadata pertaining to creation and last modification of the resource.
TransportPreferences	Preferences related to the shipment logistics of the sku
TransportShipmentTypes	Indicates Shipment Logistics type that the customer preferred.

ActionStatusEnum

Enumeration

Describes whether the order item is deletable or not.

Value	Description
Allowed	Allowed flag.
NotAllowed	Not Allowed flag.

AddressDetails

Object

Address details for an order item.

Name	Type	Description
forwardAddress	AddressProperties	Customer address and contact details. It should be address resource
returnAddress	AddressProperties	Return shipping address

AddressProperties

Object

Address Properties

Name	Type	Description
addressValidationStatus	AddressValidationStatus	Status of address validation
contactDetails	ContactDetails	Contact details for the address
shippingAddress	ShippingAddress	Shipping details for the address

AddressType

Enumeration

Type of address.

Value	Description
None	Address type not known.
Residential	Residential Address.
Commercial	Commercial Address.

AddressValidationStatus

Enumeration

Status of address validation

Value	Description
Valid	Address provided is valid.
Invalid	Address provided is invalid or not supported.
Ambiguous	Address provided is ambiguous, please choose one of the alternate addresses returned.

ContactDetails

Object

Contact Details.

Name	Type	Description
contactName	string	Contact name of the person.
emailList	string[]	List of Email-ids to be notified about job progress.
mobile	string	Mobile number of the contact person.
phone	string	Phone number of the contact person.
phoneExtension	string	Phone extension number of the contact person.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeviceDetails

Object

Device details.

Name	Type	Description
managementResourceId	string	Management Resource Id
managementResourceTenantId	string	Management Resource Tenant ID
serialNumber	string	device serial number

DisplayInfo

Object

Describes product display information

Name	Type	Description
configurationDisplayName	string	Configuration display name
productFamilyDisplayName	string	Product family display name

DoubleEncryptionStatus

Enumeration

Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.

Value	Description
Disabled	Double encryption is disabled
Enabled	Double encryption is enabled

EncryptionPreferences

Object

Preferences related to the double encryption

Name	Type	Description
doubleEncryptionStatus	DoubleEncryptionStatus	Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ForwardShippingDetails

Object

Forward shipment details.

Name	Type	Description
carrierDisplayName	string	Carrier Name for display purpose. Not to be used for any processing.
carrierName	string	Name of the carrier.
trackingId	string	TrackingId of the package
trackingUrl	string	TrackingUrl of the package.

HierarchyInformation

Object

Holds details about product hierarchy information

Name	Type	Description
configurationName	string	Represents configuration name that uniquely identifies configuration
productFamilyName	string	Represents product family name that uniquely identifies product family
productLineName	string	Represents product line name that uniquely identifies product line
productName	string	Represents product name that uniquely identifies product

ManagementResourcePreferences

Object

Management resource preference to link device

Name	Type	Description
preferredManagementResourceId	string	Customer preferred Management resource ARM ID

NotificationPreference

Object

Notification preference for a job stage.

Name	Type	Description
sendNotification	boolean	Notification is required or not.
stageName	NotificationStageName	Name of the stage.

NotificationStageName

Enumeration

Name of the stage.

Value	Description
Shipped	Notification at order item shipped from microsoft datacenter.
Delivered	Notification at order item delivered to customer.

OrderItemCancellationEnum

Enumeration

Describes whether the order item is cancellable or not.

Value	Description
Cancellable	Order item can be cancelled without fee.
CancellableWithFee	Order item can be cancelled with fee.
NotCancellable	Order item not cancellable.

OrderItemDetails

Object

Order item details

Name	Type	Description
cancellationReason	string	Cancellation reason.
cancellationStatus	OrderItemCancellationEnum	Describes whether the order item is cancellable or not.
currentStage	StageDetails	Current Order item Status
deletionStatus	ActionStatusEnum	Describes whether the order item is deletable or not.
error	ErrorDetail	Top level error for the job.
forwardShippingDetails	ForwardShippingDetails	Forward Package Shipping details
managementRpDetails	ResourceProviderDetails	Parent RP details - this returns only the first or default parent RP from the entire list
managementRpDetailsList	ResourceProviderDetails[]	List of parent RP details supported for configuration.
notificationEmailList	string[]	Additional notification email list
orderItemStageHistory	StageDetails[]	Order item status history
orderItemType	OrderItemType	Order item type.
preferences	Preferences	Customer notification Preferences
productDetails	ProductDetails	Unique identifier for configuration.
returnReason	string	Return reason.
returnStatus	OrderItemReturnEnum	Describes whether the order item is returnable or not.
reverseShippingDetails	ReverseShippingDetails	Reverse Package Shipping details

OrderItemResource

Object

Represents order item contract

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The geo-location where the resource lives
name	string	The name of the resource
properties.addressDetails	AddressDetails	Represents shipping and return address for order item
properties.orderId	string	Id of the order to which order item belongs to
properties.orderItemDetails	OrderItemDetails	Represents order item details.
properties.startTime	string (date-time)	Start time of order item
systemData	systemData	Represents resource creation and update time
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

OrderItemReturnEnum

Enumeration

Describes whether the order item is returnable or not.

Value	Description
Returnable	Order item can be returned without fee.
ReturnableWithFee	Order item can be returned with fee.
NotReturnable	Order item not returnable.

OrderItemType

Enumeration

Order item type.

Value	Description
Purchase	Purchase OrderItem.
Rental	Rental OrderItem.

OrderItemUpdateParameter

Object

Updates order item parameters.

Name	Type	Description
properties.forwardAddress	AddressProperties	Updates forward shipping address and contact details.
properties.notificationEmailList	string[]	Additional notification email list.
properties.preferences	Preferences	Customer preference.
tags	object	The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).

Preferences

Object

Preferences related to the order

Name	Type	Description
encryptionPreferences	EncryptionPreferences	Preferences related to the Encryption.
managementResourcePreferences	ManagementResourcePreferences	Preferences related to the Management resource.
notificationPreferences	NotificationPreference[]	Notification preferences.
transportPreferences	TransportPreferences	Preferences related to the shipment logistics of the order.

ProductDetails

Object

Represents product details

Name	Type	Description
count	integer (int32)	Quantity of the product
deviceDetails	DeviceDetails[]	list of device details
displayInfo	DisplayInfo	Display details of the product
hierarchyInformation	HierarchyInformation	Hierarchy of the product which uniquely identifies the product
productDoubleEncryptionStatus	DoubleEncryptionStatus	Double encryption status of the configuration. Read-only field.

ResourceProviderDetails

Object

Management RP details

Name	Type	Description
resourceProviderNamespace	string	Resource provider namespace

ReverseShippingDetails

Object

Reverse shipment details.

Name	Type	Description
carrierDisplayName	string	Carrier Name for display purpose. Not to be used for any processing.
carrierName	string	Name of the carrier.
sasKeyForLabel	string	SAS key to download the reverse shipment label of the package.
trackingId	string	TrackingId of the package
trackingUrl	string	TrackingUrl of the package.

ShippingAddress

Object

Shipping address where customer wishes to receive the device.

Name	Type	Description
addressType	AddressType	Type of address.
city	string	Name of the City.
companyName	string	Name of the company.
country	string	Name of the Country.
postalCode	string	Postal code.
stateOrProvince	string	Name of the State or Province.
streetAddress1	string	Street Address line 1.
streetAddress2	string	Street Address line 2.
streetAddress3	string	Street Address line 3.
zipExtendedCode	string	Extended Zip Code.

StageDetails

Object

Resource stage details.

Name	Type	Description
displayName	string	Display name of the resource stage.
stageName	StageName	Stage name
stageStatus	StageStatus	Stage status.
startTime	string (date-time)	Stage start time

StageName

Enumeration

Stage name

Value	Description
Placed	Currently in draft mode and can still be cancelled
InReview	Order is currently in draft mode and can still be cancelled
Confirmed	Order is confirmed
ReadyToShip	Order is ready to ship
Shipped	Order is in transit to customer
Delivered	Order is delivered to customer
InUse	Order is in use at customer site
ReturnInitiated	Return has been initiated by customer.
ReturnPickedUp	Order is in transit from customer to microsoft.
ReturnedToMicrosoft	Order has been received back to microsoft.
ReturnCompleted	Return has now completed.
Cancelled	Order has been cancelled.

StageStatus

Enumeration

Stage status.

Value	Description
None	No status available yet.
InProgress	Stage is in progress.
Succeeded	Stage has succeeded.
Failed	Stage has failed.
Cancelled	Stage has been cancelled.
Cancelling	Stage is cancelling.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

TransportPreferences

Object

Preferences related to the shipment logistics of the sku

Name	Type	Description
preferredShipmentType	TransportShipmentTypes	Indicates Shipment Logistics type that the customer preferred.

TransportShipmentTypes

Enumeration

Indicates Shipment Logistics type that the customer preferred.

Value	Description
CustomerManaged	Shipment Logistics is handled by the customer.
MicrosoftManaged	Shipment Logistics is handled by Microsoft.

Share via

Update Order Item - Update Order Item

URI Parameters

Request Header

Request Body

Responses

Security

azure_auth

Scopes

Examples

UpdateOrderItem

Sample request

Sample response

Definitions

ActionStatusEnum

AddressDetails

AddressProperties

AddressType

AddressValidationStatus

ContactDetails

createdByType

DeviceDetails

DisplayInfo

DoubleEncryptionStatus

EncryptionPreferences

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ForwardShippingDetails

HierarchyInformation

ManagementResourcePreferences

NotificationPreference

NotificationStageName

OrderItemCancellationEnum

OrderItemDetails

OrderItemResource

OrderItemReturnEnum

OrderItemType

OrderItemUpdateParameter

Preferences

ProductDetails

ResourceProviderDetails

ReverseShippingDetails

ShippingAddress

StageDetails

StageName

StageStatus

systemData

TransportPreferences

TransportShipmentTypes