Place Cart Order API

Place the order for a prepared cart (items, shipment and payment already set).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request Schema

ParameterTypeDescription
cartIdStringCart ID to place the order for.
poNumberStringUnique purchase order reference to prevent duplicate orders.
paymentDetailsString (JSON)JSON-encoded payment details, if not already applied via Update Payment API.
userUniqueKeyStringUnique identifier of the end user placing the order.

Response Schema

PathTypeDescription
dataobjectRoot response object.
data.placeCartOrderobjectContainer for the place order result.
data.placeCartOrder.statusnumberAPI execution status (1 = success).
data.placeCartOrder.dataobjectOrder details payload.
data.placeCartOrder.data.orderIdnumberUnique order ID generated by Xoxoday.

Implementation Notes

  1. Ensure items (Add or Update Item to Cart), shipment (Update Shipment) and payment (Update Payment) are set before calling this endpoint.
  2. Pass a unique poNumber for every order to avoid duplicates.
  3. Use Get Cart Order Details API with the returned orderId to fetch delivered vouchers and full order data.
  4. The response envelope shown is representative; confirm the exact payload against a live response.
Body Params
string
required
Defaults to plumProAPI.mutation.placeCartOrder

Please use 'plumProAPI.mutation.placeCartOrder' always in query

string
required
Defaults to plumProAPI

Please use 'plumProAPI' always in query

variables
object
required

List of primary parameter for placing an order request

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json