Praecise Platform
Menu

Rivier/ Reference/ shop

Place the order and, unless told not to, start the payment

post/public/shop/checkout

Place the order and, unless told not to, start the payment; answers with the order, its link and the payment address.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:read
Sdk
shop.publicCheckout.place
Cli
shop public checkout place
Publishable
yes

Request bodyapplication/json, required

  • cartIdstring (uuid)required
  • contactobjectrequired
    • emailstring (email)required
      At most 254 characters.
    • namestringrequired
      At most 200 characters.
    • phonestring
      At most 40 characters.
  • shippingAddressobject
    • namestringrequired
      At most 200 characters.
    • line1stringrequired
      At most 200 characters.
    • line2string
      At most 200 characters.
    • citystringrequired
      At most 120 characters.
    • regionstring
      Default: . At most 10 characters.
    • postalCodestringrequired
      At most 20 characters.
    • countrystringrequired
      Pattern: ^[A-Z]{2}$.
    • phonestring
      At most 40 characters.
  • billingAddressobject
    • namestringrequired
      At most 200 characters.
    • line1stringrequired
      At most 200 characters.
    • line2string
      At most 200 characters.
    • citystringrequired
      At most 120 characters.
    • regionstring
      Default: . At most 10 characters.
    • postalCodestringrequired
      At most 20 characters.
    • countrystringrequired
      Pattern: ^[A-Z]{2}$.
    • phonestring
      At most 40 characters.
  • shippingRateIdstring (uuid)
  • idempotencyKeystringrequired
    At most 120 characters.
  • returnUrlstring (uri)
    At most 500 characters.
  • agentobject
    • namestringrequired
      At most 100 characters.
    • modelstring
      At most 100 characters.
    • runIdstring
      At most 100 characters.
  • payboolean

Responses

  • 201application/json
    Success
    • 400application/json
      The request was malformed
      • errorstringrequired
      • messagestring
    • 401application/json
      No valid credential
      • errorstringrequired
      • messagestring
    • 403application/json
      The credential lacks the scope, origin or address
      • errorstringrequired
      • messagestring
    • 429application/json
      Over the key's rate limit; see Retry-After
      • errorstringrequired
      • messagestring

    This page as Markdown