Start a hosted buyer checkout from a product URL

POST/api/v1/buyer-checkouts

Request body

requiredapplication/json

One of:

any

any

any

any

Responses

201Hosted checkout that collects buyer details and payment

checkoutobjectrequired

Show properties

lineItemsobject[]required

totalsobjectrequired

checkoutUrlstring<uri>required

expiresAtstring<date-time>required

mppobject

Show properties

endpointstring<uri>required

statusobjectrequired

Show properties

endpointstring<uri>required

tokenstringrequired

min length 1

Request

curl -X POST "https://dev.api.orderboost.org/api/v1/buyer-checkouts" \
  -H "Content-Type: application/json" \
  -d '"string"'

const response = await fetch("https://dev.api.orderboost.org/api/v1/buyer-checkouts", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify("string")
});

import requests

response = requests.post(
    "https://dev.api.orderboost.org/api/v1/buyer-checkouts",
    headers={
        "Content-Type": "application/json"
    },
    json="string",
)

Response

{
  "checkout": {
    "lineItems": [
      {}
    ],
    "totals": {}
  },
  "checkoutUrl": "<uri>",
  "expiresAt": "2024-01-01T00:00:00Z",
  "mpp": {
    "endpoint": "<uri>"
  },
  "status": {
    "endpoint": "<uri>",
    "token": "string"
  }
}