swagger: '2.0'
info:
  version: 2020-08-01-preview
  title: Microsoft Azure AccessControlClient AccessConnector OrderItems API
schemes:
- https
tags:
- name: OrderItems
paths:
  /subscriptions/{subscriptionId}/providers/Microsoft.EdgeOrder/orderItems:
    get:
      tags:
      - OrderItems
      description: List order items at subscription level.
      operationId: microsoftAzureOrderitemsListbysubscription
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: $filter
        in: query
        description: $filter is supported to filter based on order id. Filter supports only equals operation.
        required: false
        type: string
      - name: $expand
        in: query
        description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
        required: false
        type: string
      - name: $skipToken
        in: query
        description: $skipToken is supported on Get list of order items, which provides the next page in the list of order items.
        required: false
        type: string
      - name: $top
        in: query
        description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: List of order items available under the subscription.
          schema:
            $ref: '#/definitions/OrderItemResourceList'
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListOrderItemsAtSubscriptionLevel:
          $ref: ./examples/ListOrderItemsAtSubscriptionLevel.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Providers Microsoft Edgeorder Orderitems
  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems:
    get:
      tags:
      - OrderItems
      description: List order items at resource group level.
      operationId: microsoftAzureOrderitemsListbyresourcegroup
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: $filter
        in: query
        description: $filter is supported to filter based on order id. Filter supports only equals operation.
        required: false
        type: string
      - name: $expand
        in: query
        description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
        required: false
        type: string
      - name: $skipToken
        in: query
        description: $skipToken is supported on Get list of order items, which provides the next page in the list of order items.
        required: false
        type: string
      - name: $top
        in: query
        description: $top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.
        required: false
        type: integer
        format: int32
      responses:
        '200':
          description: List of order items available under the resource group.
          schema:
            $ref: '#/definitions/OrderItemResourceList'
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-pageable:
        nextLinkName: nextLink
      x-ms-examples:
        ListOrderItemsAtResourceGroupLevel:
          $ref: ./examples/ListOrderItemsAtResourceGroupLevel.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}
  : get:
      tags:
      - OrderItems
      description: Get an order item.
      operationId: microsoftAzureOrderitemsGet
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/orderItemNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: $expand
        in: query
        description: $expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
        required: false
        type: string
      responses:
        '200':
          description: Order item object.
          schema:
            $ref: '#/definitions/OrderItemResource'
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        GetOrderItemByName:
          $ref: ./examples/GetOrderItemByName.json
      summary: Microsoft Azure Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems Orderitemname
    put:
      tags:
      - OrderItems
      description: Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item<br>API.
      operationId: microsoftAzureOrderitemsCreate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/orderItemNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: orderItemResource
        in: body
        description: Order item details from request body.
        required: true
        schema:
          $ref: '#/definitions/OrderItemResource'
      responses:
        '200':
          description: Order resource object.
          schema:
            $ref: '#/definitions/OrderItemResource'
        '202':
          description: Accepted request to create order item.
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        CreateOrderItem:
          $ref: ./examples/CreateOrderItem.json
      summary: Microsoft Azure Put Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems Orderitemname
    delete:
      tags:
      - OrderItems
      description: Delete an order item.
      operationId: microsoftAzureOrderitemsDelete
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/orderItemNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      responses:
        '200':
          description: Order item deleted.
        '202':
          description: Accepted delete request for an order item.
          headers:
            Location:
              description: The URL to track the status of the long running operation.
              type: string
        '204':
          description: No content. Order item deleted.
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        DeleteOrderItemByName:
          $ref: ./examples/DeleteOrderItemByName.json
      summary: Microsoft Azure Delete Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems Orderitemname
    patch:
      tags:
      - OrderItems
      description: Update the properties of an existing order item.
      operationId: microsoftAzureOrderitemsUpdate
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/orderItemNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: If-Match
        in: header
        description: Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.
        required: false
        type: string
      - name: orderItemUpdateParameter
        in: body
        description: Order item update parameters from request body.
        required: true
        schema:
          $ref: '#/definitions/OrderItemUpdateParameter'
      responses:
        '200':
          description: Order item resource object.
          schema:
            $ref: '#/definitions/OrderItemResource'
        '202':
          description: Accepted request for order item update.
          headers:
            Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        UpdateOrderItem:
          $ref: ./examples/UpdateOrderItem.json
      summary: Microsoft Azure Patch Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems Orderitemname
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/cancel
  : post:
      tags:
      - OrderItems
      description: Cancel order item.
      operationId: microsoftAzureOrderitemsCancel
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/orderItemNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: cancellationReason
        in: body
        description: Reason for cancellation.
        required: true
        schema:
          $ref: '#/definitions/CancellationReason'
      responses:
        '200':
          description: Order item cancelled.
        '204':
          description: No content.
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-examples:
        CancelOrderItem:
          $ref: ./examples/CancelOrderItem.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems Orderitemname Cancel
  ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EdgeOrder/orderItems/{orderItemName}/return
  : post:
      tags:
      - OrderItems
      description: Return order item.
      operationId: microsoftAzureOrderitemsReturn
      consumes:
      - application/json
      produces:
      - application/json
      parameters:
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/SubscriptionIdParameter
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ResourceGroupNameParameter
      - $ref: '#/parameters/orderItemNameParameter'
      - $ref: ../../../../../common-types/resource-management/v2/types.json#/parameters/ApiVersionParameter
      - name: returnOrderItemDetails
        in: body
        description: Return order item details.
        required: true
        schema:
          $ref: '#/definitions/ReturnOrderItemDetails'
      responses:
        '200':
          description: Success.
        '202':
          description: Return order item request accepted.
          headers:
            Location:
              description: The URL to track the status of the long running operation.
              type: string
        default:
          description: Error response describing reason for operation failure.
          schema:
            $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorResponse
      x-ms-long-running-operation: true
      x-ms-examples:
        ReturnOrderItem:
          $ref: ./examples/ReturnOrderItem.json
      summary: Microsoft Azure Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Edgeorder Orderitems Orderitemname Return
definitions:
  ForwardShippingDetails:
    description: Forward shipment details.
    type: object
    properties:
      carrierName:
        description: Name of the carrier.
        type: string
        readOnly: true
      carrierDisplayName:
        description: Carrier Name for display purpose. Not to be used for any processing.
        type: string
        readOnly: true
      trackingId:
        description: TrackingId of the package.
        type: string
        readOnly: true
      trackingUrl:
        description: TrackingUrl of the package.
        type: string
        readOnly: true
  DeviceDetails:
    description: Device details.
    type: object
    properties:
      serialNumber:
        description: Device serial number.
        type: string
        readOnly: true
      managementResourceId:
        description: Management Resource Id.
        type: string
        readOnly: true
      managementResourceTenantId:
        description: Management Resource Tenant ID.
        type: string
        readOnly: true
  AdditionalConfiguration:
    description: Additional Configuration details.
    required:
    - hierarchyInformation
    - quantity
    type: object
    properties:
      hierarchyInformation:
        $ref: '#/definitions/HierarchyInformation'
        description: Hierarchy of the product which uniquely identifies the configuration.
      quantity:
        format: int32
        description: Quantity of the product.
        type: integer
  OrderItemProperties:
    description: Represents order item properties.
    required:
    - orderItemDetails
    - addressDetails
    - orderId
    type: object
    properties:
      orderItemDetails:
        $ref: '#/definitions/OrderItemDetails'
        description: Represents order item details.
      addressDetails:
        $ref: '#/definitions/AddressDetails'
        description: Represents shipping and return address for order item.
      startTime:
        format: date-time
        description: Start time of order item.
        type: string
        readOnly: true
      orderId:
        description: Id of the order to which order item belongs to.
        type: string
  ResourceProviderDetails:
    description: Management RP details.
    type: object
    properties:
      resourceProviderNamespace:
        description: Resource provider namespace.
        type: string
        readOnly: true
  OrderItemDetails:
    description: Order item details.
    required:
    - productDetails
    - orderItemType
    type: object
    properties:
      productDetails:
        $ref: '#/definitions/ProductDetails'
        description: Unique identifier for configuration.
      orderItemType:
        description: Order item type.
        enum:
        - Purchase
        - Rental
        type: string
        x-ms-enum:
          name: OrderItemType
          modelAsString: true
          values:
          - value: Purchase
            description: Purchase OrderItem.
          - value: Rental
            description: Rental OrderItem.
      orderItemMode:
        description: Defines the mode of the Order item.
        enum:
        - Default
        - DoNotFulfill
        type: string
        x-ms-enum:
          name: OrderMode
          modelAsString: true
          values:
          - value: Default
            description: Default Order mode.
          - value: DoNotFulfill
            description: Mode in which the Order will not be fulfilled.
      currentStage:
        $ref: '#/definitions/StageDetails'
        description: Current Order item Status.
        readOnly: true
      orderItemStageHistory:
        description: Order item status history.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/StageDetails'
        readOnly: true
        x-ms-identifiers: []
      preferences:
        $ref: '#/definitions/Preferences'
        description: Customer notification Preferences.
      forwardShippingDetails:
        $ref: '#/definitions/ForwardShippingDetails'
        description: Forward Package Shipping details.
        readOnly: true
      reverseShippingDetails:
        $ref: '#/definitions/ReverseShippingDetails'
        description: Reverse Package Shipping details.
        readOnly: true
      notificationEmailList:
        description: Additional notification email list.
        uniqueItems: false
        type: array
        items:
          type: string
      cancellationReason:
        description: Cancellation reason.
        type: string
        readOnly: true
      cancellationStatus:
        description: Describes whether the order item is cancellable or not.
        enum:
        - Cancellable
        - CancellableWithFee
        - NotCancellable
        type: string
        readOnly: true
        x-ms-enum:
          name: OrderItemCancellationEnum
          modelAsString: true
          values:
          - value: Cancellable
            description: Order item can be cancelled without fee.
          - value: CancellableWithFee
            description: Order item can be cancelled with fee.
          - value: NotCancellable
            description: Order item not cancellable.
      deletionStatus:
        description: Describes whether the order item is deletable or not.
        enum:
        - Allowed
        - NotAllowed
        type: string
        readOnly: true
        x-ms-enum:
          name: ActionStatusEnum
          modelAsString: true
          values:
          - value: Allowed
            description: Allowed flag.
          - value: NotAllowed
            description: Not Allowed flag.
      returnReason:
        description: Return reason.
        type: string
        readOnly: true
      returnStatus:
        description: Describes whether the order item is returnable or not.
        enum:
        - Returnable
        - ReturnableWithFee
        - NotReturnable
        type: string
        readOnly: true
        x-ms-enum:
          name: OrderItemReturnEnum
          modelAsString: true
          values:
          - value: Returnable
            description: Order item can be returned without fee.
          - value: ReturnableWithFee
            description: Order item can be returned with fee.
          - value: NotReturnable
            description: Order item not returnable.
      managementRpDetailsList:
        description: List of parent RP details supported for configuration.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ResourceProviderDetails'
        readOnly: true
        x-ms-identifiers: []
      error:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/ErrorDetail
        description: Top level error for the job.
        readOnly: true
  ContactDetails:
    description: Contact Details.
    required:
    - contactName
    - phone
    - emailList
    type: object
    properties:
      contactName:
        description: Contact name of the person.
        type: string
      phone:
        description: Phone number of the contact person.
        type: string
      phoneExtension:
        description: Phone extension number of the contact person.
        type: string
      mobile:
        description: Mobile number of the contact person.
        type: string
      emailList:
        description: List of Email-ids to be notified about job progress.
        uniqueItems: false
        type: array
        items:
          type: string
  ProductDetails:
    description: Represents product details.
    required:
    - hierarchyInformation
    type: object
    properties:
      displayInfo:
        $ref: '#/definitions/DisplayInfo'
        description: Display details of the product.
      hierarchyInformation:
        $ref: '#/definitions/HierarchyInformation'
        description: Hierarchy of the product which uniquely identifies the product.
      productDoubleEncryptionStatus:
        description: Double encryption status of the configuration. Read-only field.
        enum:
        - Disabled
        - Enabled
        type: string
        readOnly: true
        x-ms-enum:
          name: DoubleEncryptionStatus
          modelAsString: true
          values:
          - value: Disabled
            description: Double encryption is disabled.
          - value: Enabled
            description: Double encryption is enabled.
      identificationType:
        description: Identification type of the configuration.
        enum:
        - NotSupported
        - SerialNumber
        type: string
        readOnly: true
        x-ms-enum:
          name: IdentificationType
          modelAsString: true
          values:
          - value: NotSupported
            description: Product does not have any explicit identifier.
          - value: SerialNumber
            description: Product is identifiable by serial number.
      parentDeviceDetails:
        $ref: '#/definitions/DeviceDetails'
        description: Device details of the parent configuration.
        readOnly: true
      optInAdditionalConfigurations:
        description: List of additional configurations customer wants in the order item apart from the ones included in the base configuration.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/AdditionalConfiguration'
        x-ms-identifiers: []
      childConfigurationDeviceDetails:
        description: Details of all child configurations that are part of the order item.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/ConfigurationDeviceDetails'
        readOnly: true
        x-ms-identifiers: []
  HierarchyInformation:
    description: Holds details about product hierarchy information.
    type: object
    properties:
      productFamilyName:
        description: Represents product family name that uniquely identifies product family.
        type: string
      productLineName:
        description: Represents product line name that uniquely identifies product line.
        type: string
      productName:
        description: Represents product name that uniquely identifies product.
        type: string
      configurationName:
        description: Represents configuration name that uniquely identifies configuration.
        type: string
  EncryptionPreferences:
    description: Preferences related to the double encryption.
    type: object
    properties:
      doubleEncryptionStatus:
        description: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
        enum:
        - Disabled
        - Enabled
        type: string
        x-ms-enum:
          name: DoubleEncryptionStatus
          modelAsString: true
          values:
          - value: Disabled
            description: Double encryption is disabled.
          - value: Enabled
            description: Double encryption is enabled.
  CancellationReason:
    description: Reason for cancellation.
    required:
    - reason
    type: object
    properties:
      reason:
        description: Reason for cancellation.
        type: string
  ReverseShippingDetails:
    description: Reverse shipment details.
    type: object
    properties:
      sasKeyForLabel:
        description: SAS key to download the reverse shipment label of the package.
        type: string
        readOnly: true
      carrierName:
        description: Name of the carrier.
        type: string
        readOnly: true
      carrierDisplayName:
        description: Carrier Name for display purpose. Not to be used for any processing.
        type: string
        readOnly: true
      trackingId:
        description: TrackingId of the package.
        type: string
        readOnly: true
      trackingUrl:
        description: TrackingUrl of the package.
        type: string
        readOnly: true
  DisplayInfo:
    description: Describes product display information.
    type: object
    properties:
      productFamilyDisplayName:
        description: Product family display name.
        type: string
        readOnly: true
      configurationDisplayName:
        description: Configuration display name.
        type: string
        readOnly: true
  OrderItemUpdateParameter:
    description: Updates order item parameters.
    type: object
    properties:
      properties:
        $ref: '#/definitions/OrderItemUpdateProperties'
        description: Order item update properties.
        x-ms-client-flatten: true
      tags:
        description: The list of key value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups).
        type: object
        additionalProperties:
          type: string
  ManagementResourcePreferences:
    description: Management resource preference to link device.
    type: object
    properties:
      preferredManagementResourceId:
        description: Customer preferred Management resource ARM ID.
        type: string
  ShippingAddress:
    description: Shipping address where customer wishes to receive the device.
    required:
    - streetAddress1
    - country
    type: object
    properties:
      streetAddress1:
        description: Street Address line 1.
        type: string
      streetAddress2:
        description: Street Address line 2.
        type: string
      streetAddress3:
        description: Street Address line 3.
        type: string
      city:
        description: Name of the City.
        type: string
      stateOrProvince:
        description: Name of the State or Province.
        type: string
      country:
        description: Name of the Country.
        type: string
      postalCode:
        description: Postal code.
        type: string
      zipExtendedCode:
        description: Extended Zip Code.
        type: string
      companyName:
        description: Name of the company.
        type: string
      addressType:
        description: Type of address.
        enum:
        - None
        - Residential
        - Commercial
        type: string
        x-ms-enum:
          name: AddressType
          modelAsString: true
          values:
          - value: None
            description: Address type not known.
          - value: Residential
            description: Residential Address.
          - value: Commercial
            description: Commercial Address.
  OrderItemResource:
    description: Represents order item resource.
    required:
    - properties
    type: object
    allOf:
    - $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/TrackedResource
    properties:
      properties:
        $ref: '#/definitions/OrderItemProperties'
        description: Order item properties.
        x-ms-client-flatten: true
      systemData:
        $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData
        description: Represents resource creation and update time.
        readOnly: true
  NotificationPreference:
    description: Notification preference for a job stage.
    required:
    - stageName
    - sendNotification
    type: object
    properties:
      stageName:
        description: Name of the stage.
        enum:
        - Shipped
        - Delivered
        type: string
        x-ms-enum:
          name: NotificationStageName
          modelAsString: true
          values:
          - value: Shipped
            description: Notification at order item shipped from microsoft datacenter.
          - value: Delivered
            description: Notification at order item delivered to customer.
      sendNotification:
        description: Notification is required or not.
        type: boolean
  AddressDetails:
    description: Address details for an order item.
    required:
    - forwardAddress
    type: object
    properties:
      forwardAddress:
        $ref: '#/definitions/AddressProperties'
        description: Customer address and contact details.
      returnAddress:
        $ref: '#/definitions/AddressProperties'
        description: Return shipping address.
        readOnly: true
  ConfigurationDeviceDetails:
    description: Device details for configuration.
    type: object
    properties:
      displayInfo:
        $ref: '#/definitions/DisplayInfo'
        description: Display details of the product.
      hierarchyInformation:
        $ref: '#/definitions/HierarchyInformation'
        description: Hierarchy of the product which uniquely identifies the configuration.
        readOnly: true
      quantity:
        format: int32
        description: Quantity of the product.
        type: integer
        readOnly: true
      identificationType:
        description: Identification type of the configuration.
        enum:
        - NotSupported
        - SerialNumber
        type: string
        readOnly: true
        x-ms-enum:
          name: IdentificationType
          modelAsString: true
          values:
          - value: NotSupported
            description: Product does not have any explicit identifier.
          - value: SerialNumber
            description: Product is identifiable by serial number.
      deviceDetails:
        description: List of device details.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/DeviceDetails'
        readOnly: true
        x-ms-identifiers: []
  StageDetails:
    description: Resource stage details.
    type: object
    properties:
      stageStatus:
        description: Stage status.
        enum:
        - None
        - InProgress
        - Succeeded
        - Failed
        - Cancelled
        - Cancelling
        type: string
        readOnly: true
        x-ms-enum:
          name: StageStatus
          modelAsString: true
          values:
          - value: None
            description: No status available yet.
          - value: InProgress
            description: Stage is in progress.
          - value: Succeeded
            description: Stage has succeeded.
          - value: Failed
            description: Stage has failed.
          - value: Cancelled
            description: Stage has been cancelled.
          - value: Cancelling
            description: Stage is cancelling.
      stageName:
        description: Stage name.
        enum:
        - Placed
        - InReview
        - Confirmed
        - ReadyToShip
        - Shipped
        - Delivered
        - InUse
        - ReturnInitiated
        - ReturnPickedUp
        - ReturnedToMicrosoft
        - ReturnCompleted
        - Cancelled
        type: string
        readOnly: true
        x-ms-enum:
          name: StageName
          modelAsString: true
          values:
          - value: Placed
            description: Currently in draft mode and can still be cancelled.
          - value: InReview
            description: Order is currently in draft mode and can still be cancelled.
          - value: Confirmed
            description: Order is confirmed.
          - value: ReadyToShip
            description: Order is ready to ship.
          - value: Shipped
            description: Order is in transit to customer.
          - value: Delivered
            description: Order is delivered to customer.
          - value: InUse
            description: Order is in use at customer site.
          - value: ReturnInitiated
            description: Return has been initiated by customer.
          - value: ReturnPickedUp
            description: Order is in transit from customer to Microsoft.
          - value: ReturnedToMicrosoft
            description: Order has been received back to Microsoft.
          - value: ReturnCompleted
            description: Return has now completed.
          - value: Cancelled
            description: Order has been cancelled.
      displayName:
        description: Display name of the resource stage.
        type: string
        readOnly: true
      startTime:
        format: date-time
        description: Stage start time.
        type: string
        readOnly: true
  ReturnOrderItemDetails:
    description: Return order item request body.
    required:
    - returnReason
    type: object
    properties:
      returnAddress:
        $ref: '#/definitions/AddressProperties'
        description: Customer return address.
      returnReason:
        description: Return Reason.
        type: string
      serviceTag:
        description: Service tag (located on the bottom-right corner of the device).
        type: string
      shippingBoxRequired:
        description: Shipping Box required.
        default: false
        type: boolean
  OrderItemUpdateProperties:
    description: Order item update properties.
    type: object
    properties:
      forwardAddress:
        $ref: '#/definitions/AddressProperties'
        description: Updates forward shipping address and contact details.
      preferences:
        $ref: '#/definitions/Preferences'
        description: Customer preference.
      notificationEmailList:
        description: Additional notification email list.
        uniqueItems: false
        type: array
        items:
          type: string
  Preferences:
    description: Preferences related to the order.
    type: object
    properties:
      notificationPreferences:
        description: Notification preferences.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/NotificationPreference'
        x-ms-identifiers: []
      transportPreferences:
        $ref: '#/definitions/TransportPreferences'
        description: Preferences related to the shipment logistics of the order.
      encryptionPreferences:
        $ref: '#/definitions/EncryptionPreferences'
        description: Preferences related to the Encryption.
      managementResourcePreferences:
        $ref: '#/definitions/ManagementResourcePreferences'
        description: Preferences related to the Management resource.
  OrderItemResourceList:
    description: List of order items.
    type: object
    properties:
      value:
        description: List of order item resources.
        uniqueItems: false
        type: array
        items:
          $ref: '#/definitions/OrderItemResource'
        readOnly: true
      nextLink:
        description: Link for the next set of order item resources.
        type: string
  AddressProperties:
    description: Address Properties.
    required:
    - contactDetails
    type: object
    properties:
      shippingAddress:
        $ref: '#/definitions/ShippingAddress'
        description: Shipping details for the address.
      contactDetails:
        $ref: '#/definitions/ContactDetails'
        description: Contact details for the address.
      addressValidationStatus:
        description: Status of address validation.
        enum:
        - Valid
        - Invalid
        - Ambiguous
        type: string
        readOnly: true
        x-ms-enum:
          name: AddressValidationStatus
          modelAsString: true
          values:
          - value: Valid
            description: Address provided is valid.
          - value: Invalid
            description: Address provided is invalid or not supported.
          - value: Ambiguous
            description: Address provided is ambiguous, please choose one of the alternate addresses returned.
  TransportPreferences:
    description: Preferences related to the shipment logistics of the sku.
    required:
    - preferredShipmentType
    type: object
    properties:
      preferredShipmentType:
        description: Indicates Shipment Logistics type that the customer preferred.
        enum:
        - CustomerManaged
        - MicrosoftManaged
        type: string
        x-ms-enum:
          name: TransportShipmentTypes
          modelAsString: true
          values:
          - value: CustomerManaged
            description: Shipment Logistics is handled by the customer.
          - value: MicrosoftManaged
            description: Shipment Logistics is handled by Microsoft.
parameters:
  orderItemNameParameter:
    name: orderItemName
    in: path
    description: The name of the order item.
    required: true
    type: string
    x-ms-parameter-location: method
x-ms-parameterized-host:
  hostTemplate: '{endpoint}'
  useSchemePrefix: false
  parameters:
  - $ref: '#/parameters/Endpoint'