Share via

Manage orders - Get a cart by ID

  • Reference
Service:
Partner Center Rest
API Version:
v1

Gets a specific cart using a ID.

GET https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/carts/{cart_id}

URI Parameters

Name In Required Type Description
cart_id
 path True

string

The cart identifier.
customer_id
 path True

string

The customer identifier.
version
 path True

string

Request Header

Name Required Type Description
Authorization True

string

Authorization Bearer token
ms-correlationid

string

Used for tracking requests internally. If a ms-correlationid is not provided, the server will generate a new one for each request
ms-cv

string

Used for tracking requests internally. If a ms-cv is not provided, the server will generate a new one for each request
ms-requestid

string

Used for idempotency of requests. If a ms-requestid is not provided, the server will generate a new one for each request

Responses

Name Type Description
200 OK

Microsoft.Partner.Services.Carts.V1.Models.Cart

The request was successful. The response body contains the cart information.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
400 Bad Request

There was a missing or an invalid input. The response body will provide the error details.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
401 Unauthorized

The request was not authenticated. The client needs to authenticate with the partner API service first.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
403 Forbidden

The request was authenticated but was refused since the caller does not have the rights to invoke it.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
404 Not Found

The resource is not found or not available with the given input parameters.

Media Types: "application/json", "text/json", "application/xml", "text/xml"
500 Internal Server Error

The partner API service or one of its dependencies failed to fulfill the request. Callers may retry this.

Media Types: "application/json", "text/json", "application/xml", "text/xml"

Definitions

Name Description
Microsoft.Partner.Core.Collections.Link
Microsoft.Partner.Core.Collections.ResourceAttributes
Microsoft.Partner.Core.Collections.ResourceLinks
Microsoft.Partner.Services.Carts.V1.Models.Cart
Microsoft.Partner.Services.Carts.V1.Models.CartError
Microsoft.Partner.Services.Carts.V1.Models.CartLineItem
Microsoft.Partner.Services.Carts.V1.Models.PurchaseCommitment
Microsoft.Partner.Services.Carts.V1.Models.RenewsTo
System.Collections.Generic.KeyValuePair[Microsoft.Partner.Services.Carts.V1.Models.ParticipantType,System.String]
System.Collections.Generic.KeyValuePair[System.String,System.String]
Name Type Description
body

string

headers

System.Collections.Generic.KeyValuePair[System.String,System.String][]

method

string

uri

string

Microsoft.Partner.Core.Collections.ResourceAttributes

Name Type Description
etag

string

objectType

string

Name Type Description
next

Microsoft.Partner.Core.Collections.Link

previous

Microsoft.Partner.Core.Collections.Link

self

Microsoft.Partner.Core.Collections.Link

Microsoft.Partner.Services.Carts.V1.Models.Cart

Name Type Description
attributes

Microsoft.Partner.Core.Collections.ResourceAttributes

creationTimestamp

string

expirationTimestamp

string

id

string

lastModifiedTimestamp

string

lastModifiedUser

string

lineItems

Microsoft.Partner.Services.Carts.V1.Models.CartLineItem[]

links

Microsoft.Partner.Core.Collections.ResourceLinks

status

string

Microsoft.Partner.Services.Carts.V1.Models.CartError

Name Type Description
errorCode enum:
  • 0
  • 10000
  • 10002
  • 10003
  • 10004
  • 10006
  • 10007
  • 10008
  • 10009
  • 10010
  • 10011
  • 10012
  • 400013
  • 400019
  • 400028
  • 400041
  • 400042
  • 400075
  • 400076
  • 900312
  • 900314
  • 900315
  • 900317
errorDescription

string

Microsoft.Partner.Services.Carts.V1.Models.CartLineItem

Name Type Description
addonItems

Microsoft.Partner.Services.Carts.V1.Models.CartLineItem[]

attestationAccepted

boolean

billingCycle enum:
  • annual
  • monthly
  • none
  • one_time
  • triennial
  • unknown
catalogItemId

string

currencyCode

string

customTermEndDate

string

error

Microsoft.Partner.Services.Carts.V1.Models.CartError

friendlyName

string

id

integer

orderGroup

string

participants

System.Collections.Generic.KeyValuePair[Microsoft.Partner.Services.Carts.V1.Models.ParticipantType,System.String][]

promotionId

string

provisioningContext

object

purchaseCommitment

Microsoft.Partner.Services.Carts.V1.Models.PurchaseCommitment

quantity

integer

renewsTo

Microsoft.Partner.Services.Carts.V1.Models.RenewsTo

termDuration

string

Microsoft.Partner.Services.Carts.V1.Models.PurchaseCommitment

Name Type Description
amount

number

currency

string

grain

string

Microsoft.Partner.Services.Carts.V1.Models.RenewsTo

Name Type Description
termDuration

string

System.Collections.Generic.KeyValuePair[Microsoft.Partner.Services.Carts.V1.Models.ParticipantType,System.String]

Name Type Description
key enum:
  • consumption_reseller
  • transaction_reseller
  • unknown
value

string

System.Collections.Generic.KeyValuePair[System.String,System.String]

Name Type Description
key

string

value

string