Manage orders - Create a new cart
Creates a new cart.
POST https://api.partnercenter.microsoft.com/v{version}/customers/{customer_id}/cartsURI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
customer_id
|
path | True |
string |
The customer identifier. |
|
version
|
path | True |
string |
Request Header
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| 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 |
Request Body
Media Types: "application/json", "text/json", "application/xml", "text/xml", "application/x-www-form-urlencoded"
| Name | Type | Description |
|---|---|---|
| attributes | ||
| creationTimestamp |
string (date-time) |
|
| expirationTimestamp |
string (date-time) |
|
| id |
string |
|
| lastModifiedTimestamp |
string (date-time) |
|
| lastModifiedUser |
string |
|
| lineItems | ||
| links | ||
| status |
string |
Responses
| Name | Type | Description |
|---|---|---|
| 201 Created |
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
Microsoft.Partner.Core.Collections.Link
| Name | Type | Description |
|---|---|---|
| body |
string |
|
| headers |
System. |
|
| method |
string |
|
| uri |
string |
Microsoft.Partner.Core.Collections.ResourceAttributes
| Name | Type | Description |
|---|---|---|
| etag |
string |
|
| objectType |
string |
Microsoft.Partner.Core.Collections.ResourceLinks
| Name | Type | Description |
|---|---|---|
| next | ||
| previous | ||
| self |
Microsoft.Partner.Services.Carts.V1.Models.Cart
| Name | Type | Description |
|---|---|---|
| attributes | ||
| creationTimestamp |
string (date-time) |
|
| expirationTimestamp |
string (date-time) |
|
| id |
string |
|
| lastModifiedTimestamp |
string (date-time) |
|
| lastModifiedUser |
string |
|
| lineItems | ||
| links | ||
| status |
string |
Microsoft.Partner.Services.Carts.V1.Models.CartError
| Name | Type | Description |
|---|---|---|
| errorCode |
enum:
|
|
| errorDescription |
string |
Microsoft.Partner.Services.Carts.V1.Models.CartLineItem
| Name | Type | Description |
|---|---|---|
| addonItems | ||
| attestationAccepted |
boolean |
|
| billingCycle |
enum:
|
|
| catalogItemId |
string |
|
| currencyCode |
string |
|
| customTermEndDate |
string (date-time) |
|
| error | ||
| friendlyName |
string |
|
| id |
integer (int32) |
|
| orderGroup |
string |
|
| participants | ||
| promotionId |
string |
|
| provisioningContext |
object |
|
| purchaseCommitment |
Microsoft. |
|
| quantity |
integer (int32) |
|
| renewsTo | ||
| scheduledNextTermInstructions |
Microsoft. |
|
| termDuration |
string |
Microsoft.Partner.Services.Carts.V1.Models.ProductTerm
| Name | Type | Description |
|---|---|---|
| availabilityId |
string |
|
| billingCycle |
enum:
|
|
| productId |
string |
|
| skuId |
string |
|
| termDuration |
string |
Microsoft.Partner.Services.Carts.V1.Models.PurchaseCommitment
| Name | Type | Description |
|---|---|---|
| amount |
number (double) |
|
| currency |
string |
|
| grain |
string |
Microsoft.Partner.Services.Carts.V1.Models.RenewsTo
| Name | Type | Description |
|---|---|---|
| termDuration |
string |
Microsoft.Partner.Services.Carts.V1.Models.ScheduledNextTermInstructions
| Name | Type | Description |
|---|---|---|
| product | ||
| quantity |
number (int32) |
System.Collections.Generic.KeyValuePair[Microsoft.Partner.Services.Carts.V1.Models.ParticipantType,System.String]
| Name | Type | Description |
|---|---|---|
| key |
enum:
|
|
| value |
string |
System.Collections.Generic.KeyValuePair[System.String,System.String]
| Name | Type | Description |
|---|---|---|
| key |
string |
|
| value |
string |