API Reference

Create a Checkout Conversation.

post
https://api.prtmb.com/api/v2/accounts//conversations/create-checkout

Create a Checkout Conversation.

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

This parameter indicates which Account owns the collections and resources reference by the request.

As a convenience, the slug me may be used in place of the account_id in any URL where it is
required. When me is used it will be replaced with the account_id of the current User.

Body Params

Success

audience_membership
object
required

Identify the AudienceMembership that should receive conversation.

conversation_graph
object
required

Identify the ConversationGraph that should be used. The slug should identify
the ConversationGraph as follows:

  • checkout - for a "checkout" Conversation where all line-items are known in
    advance, when the Conversation is created.

  • checkout-product - for a "checkout-product" Conversation where the Product options
    still need to be chosen in order to select a ProductVariant.

metadata
required

Additional metadata supplied to the Conversation that provides specific information
about exactly what is to be included in the checkout.

Response

Callback

Updated over 4 years ago

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

Updated over 4 years ago