Share via


Manage orders - Create a new cart

Creates a new cart.

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

URI 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

Microsoft.Partner.Core.Collections.ResourceAttributes

creationTimestamp

string (date-time)

expirationTimestamp

string (date-time)

id

string

lastModifiedTimestamp

string (date-time)

lastModifiedUser

string

lineItems

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

links

Microsoft.Partner.Core.Collections.ResourceLinks

status

string

Responses

Name Type Description
201 Created

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.ProductTerm
Microsoft.Partner.Services.Carts.V1.Models.PurchaseCommitment
Microsoft.Partner.Services.Carts.V1.Models.RenewsTo
Microsoft.Partner.Services.Carts.V1.Models.ScheduledNextTermInstructions
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 (date-time)

expirationTimestamp

string (date-time)

id

string

lastModifiedTimestamp

string (date-time)

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 (int32)
  • 10000 (int32)
  • 10002 (int32)
  • 10003 (int32)
  • 10004 (int32)
  • 10006 (int32)
  • 10007 (int32)
  • 10008 (int32)
  • 10009 (int32)
  • 10010 (int32)
  • 10011 (int32)
  • 10012 (int32)
  • 10013 (int32)
  • 10014 (int32)
  • 10015 (int32)
  • 10016 (int32)
  • 10017 (int32)
  • 10018 (int32)
  • 10019 (int32)
  • 10020 (int32)
  • 10021 (int32)
  • 10022 (int32)
  • 10023 (int32)
  • 10024 (int32)
  • 10025 (int32)
  • 10026 (int32)
  • 10027 (int32)
  • 400013 (int32)
  • 400019 (int32)
  • 400028 (int32)
  • 400041 (int32)
  • 400042 (int32)
  • 400075 (int32)
  • 400076 (int32)
  • 500600 (int32)
  • 800111 (int32)
  • 900312 (int32)
  • 900313 (int32)
  • 900314 (int32)
  • 900315 (int32)
  • 900317 (int32)
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 (int32)
  • monthly (int32)
  • none (int32)
  • one_time (int32)
  • triennial (int32)
  • unknown (int32)
catalogItemId

string

currencyCode

string

customTermEndDate

string (date-time)

error

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

friendlyName

string

id

integer (int32)

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 (int32)

renewsTo

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

scheduledNextTermInstructions

Microsoft.Partner.Services.Carts.V1.Models.ScheduledNextTermInstructions

termDuration

string

Microsoft.Partner.Services.Carts.V1.Models.ProductTerm

Name Type Description
availabilityId

string

billingCycle enum:
  • annual (int32)
  • biennial (int32)
  • monthly (int32)
  • none (int32)
  • one_time (int32)
  • triennial (int32)
  • unknown (int32)
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

Microsoft.Partner.Services.Carts.V1.Models.ProductTerm

quantity

number (int32)

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

Name Type Description
key enum:
  • consumption_reseller (int32)
  • transaction_reseller (int32)
  • unknown (int32)
value

string

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

Name Type Description
key

string

value

string