Order

post

https://www.pelcro.com/api/v1/sdk/ecommerce/order

Create a new e-commerce order for the customer on-session.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

site_id

int32

required

The unique identifier of the site associated with your account.

Body Params

items

array of objects

required

A list produt sksu and quantities to add to the order. Always required.

items*

source_id

int32

required

The unique identifier of an existing chargeable payment method already attached to the customer, which will be used to attempt payments for the order. Always required.

address_id

int32

The shipping address identifier. Always required.

coupon_code

string

An optional coupon code to apply a discount to the order. If you associated a customer segment to the coupon, a validation will be performed. Therefore, it is recommended to validate against eligible coupons for the customer first.

campaign_key

string

An optional campaign key associated to the subscription. If the key does not already exist, it will be created. The campaign key must be between 3 and 191 characters in length and include only letters, numbers, dashes and underscores without space.

payment_gateway

string

enum

Defaults to stripe

The optional payment gateway, one of stripe, vantiv, tap or cybersource. Always defaults to stripe.

Allowed:

gateway_token

string

The single-use token that represents the payment method details. Typically generated using the payment gateway's tools and libraries. This payment method will be used to attempt payments for this newly created order.

Headers

Authorization

string

required

Defaults to Bearer eyJ***

string

Defaults to application/json

Responses

Language

Credentials

Query

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400