Checkout Session

When checking out, users may need to input a lot of information. The POST method can be used to input the necessary checkout details.

Endpoints

POST /api/v2/transaction/session# Create SessionPUT /api/v2/transaction/session/:session_id# Update SessionGET /api/v2/transaction/session/:session_id# Retrieve Checkout SessionPOST /api/v2/transaction/session/:session_id/checkout# Create Checkout SessionPOST /api/v2/transaction/session/:session_id/check-fulfillment# Create Checkout HistoryDEL /api/v2/transaction/session/:session_id# Delete Checkout SessionDEL /api/v2/transaction/session/:session_id/schedule# Delete Session ScheduleGET /api/v2/transaction/checkout-session/:session_id# Retrieve Checkout Status

Create Session

The session for checkout can be created by inputting the necessary information.

Headers

The JSON containing checkout data sends raw data in the request body. The "Origin" header is commonly used to secure cross-origin requests.

Parameters

No parameter required.

Attributes

id number

The id which the user has for checkout session.

session_id string

The session id which the user has.

payment_intent_id null

It is optional to use this.

order_no null

It is optional to use this.

transaction_date string

The date of the transaction occurred.

transaction_time string

The time of the transaction occurred.

store_id string

The id of the store.

customer_code null

It is optional to use this.

sales_person_id string

The id of salesperson during checkout session.

sales_person_name string

The name of the sales person.

delivery_method_id null

It is optional to use this.

delivery_method_name null

It is optional to use this.

subtotal string

The subtotal of the checkout price.

subsaving string

The saving amount of the checkout product.

tax string

The tax of the checkout price.

tax_price string

The tax price of the product.

warranty_charge string

The charge for warranty option.

install_charge string

The charge of the installation.

delivery_charge string

The charge for the delivery service.

item_delivery_charge string

The charge of item delivery.

discount null

It is optional to use.

discount_used null

It is optional to use.

total string

The total amount of the product price.

is_paid null

It is optional to use.

is_processed number

The option of being processed or not.

is_receive_text number

The option of receiving text or not.

read number

The option of read or not.

is_same_as_shipping number

The option of shipping.

created_at string

The date of checkout creation.

updated_at string

The date of checkout updated.

order_detail array of objects

The detail of the order.

id number

The id of checkout order.

session_id string

The session id of checkout.

product_id string

The id of the checkout product.

product_name string

The name of the product.

sku string

The stock keeping unit number of the product.

brand_id number

The id of the brand.

brand_name string

The name of the brand.

quantity number

The quantity of the product in checkout.

price string

The price of the product in checkout.

saving string

The saving amount of the product transaction.

original_price string

The original price of the product.

subtotal_price string

The subtotal price of the product.

has_install number

The installation option for the product in checkout.

has_warranty number

The option of having product warranty.

fulfillment_type number

The option of having fulfillment type.

delivery_option_id number

The option of having delivery.

delivery_charge string

The charge of delivery.

is_shcedule_later number

The option of scheduling later.

category_name string

The name of the product category.

subcategory_name string

The name of product subcategory.

detail_category_name string

The detail name of the product acategory.

category_slug string

The slug of product category.

subcategory_slug string

The slug of product subcategory.

detail_category_slug string

The slug of detail product category.

created_at string

The date of checkout creation.

updated_at string

The date of checkout update.

install empty string

It is optional to use this.

warranty empty string

It is optional to use this.

fulfillment_type_name string

The name of the fulfillment type.

delivery_option_name string

The name of delivery option.

image string

The image url of the product.

brand_image string

The image url of the brand image.

color string

The color description of the product.

is_in_stock number

The option of stock.

in_stock boolean

The availability of product stock.

in_active_status boolean

The active status of the product.

estimate_availability string

The estimation of product availability.

estimate_availability_desc string

The estimation of product availability description.

installation_availability null

The availability for the installation.

has_route_access boolean

The option of route access.

schedule_available boolean

The availability of the schedule.

is_schedule_all_available boolean

The availability of all schedules.

billing array of objects

It consists of billing details for the checkout.

first_name null

It is optional to include the billing details.

last_name null

It is optional to include the billing details.

company_name null

It is optional to include the billing details.

phone_number null

It is optional to include the billing details.

street_address null

It is optional to include the billing details.

shipping array of objects

It consists of shipping details for the checkout (the same details as billing)

email null

It is optional to include the billing details.

suite null

It is optional to include the billing details.

city null

It is optional to include the billing details.

state null

It is optional to include the billing details.

zip_code null

It is optional to include the billing details.

sales_person_extension_number string

The name of the sales person.

sales_person_image string

The name of the sales person.

original_total string

The original total price of the checkout.

is_tax_exempted number

The option of tax exemption.

POST /api/v2/transaction/session

curl --location 'https://appliance-api.com/api/v2/transaction/session' \
--header 'Origin: test.example.com/api/api/public' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data '{
    "sales_person_id" : "5d407bcf4f210",
    "zip_code": "63012",
    "products" : [
        {
            "product_id": 583,
            "product_name": "30-inch  Top-Freezer Refrigerator with Glass Shelves",
            "product_model": "ART318FFDW",
            "brand_id": 2,
            "brand_name": "Amana",
            "quantity": 1,
            "price": "666.00",
            "fulfillment_type": 1,
            "delivery_option_id": 2,
            "install": [],
            "warranty": [],
            "delivery_date": null,
            "haul_away_charge": 10,
            "qty_haul": 1,
            "haul_away_checked": 1
        }
    ]
}

'

{
  "code": "200",
  "message": "Success",
  "data": {
    "id": 1,
    "session_id": "V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==",
    "payment_intent_id": null,
    "order_no": null,
    "transaction_date": "2023-11-21",
    "transaction_time": "22:03:29",
    "store_id": "STORE0001",
    "customer_code": null,
    "sales_person_id": "5d407bcf4f210",
    "sales_person_name": "John Doe",
    "delivery_method_id": null,
    "delivery_method_name": null,
    "subtotal": "606.00",
    "subsaving": "353.00",
    "tax": "8.99",
    "tax_price": "0.00",
    "warranty_charge": "0.00",
    "install_charge": "0.00",
    "delivery_charge": "49.00",
    "item_delivery_charge": "10.00",
    "discount": null,
    "discount_used": null,
    "total": "606.00",
    "is_paid": null,
    "is_processed": 0,
    "is_receive_text": 0,
    "read": 0,
    "is_same_as_shipping": 1,
    "created_at": "2023-11-21 22:03:29",
    "updated_at": "2023-11-21 22:03:29",
    "order_detail": [
      {
        "id": 1,
        "session_id": "V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==",
        "product_id": "583",
        "product_name": "30-inch  Top-Freezer Refrigerator with Glass Shelves",
        "sku": "ART318FFDW",
        "brand_id": 2,
        "brand_name": "Amana",
        "quantity": 1,
        "price": "596.00",
        "saving": "353.00",
        "original_price": "949.00",
        "subtotal_price": "596.00",
        "has_install": 0,
        "has_warranty": 0,
        "fulfillment_type": 1,
        "delivery_option_id": 2,
        "delivery_charge": "10.00",
        "is_schedule_later": 0,
        "category_name": "Refrigeration",
        "subcategory_name": "Refrigerators",
        "detail_category_name": "Top Freezer Refrigerators",
        "category_slug": "refrigeration",
        "subcategory_slug": "refrigerators",
        "detail_category_slug": "top-freezer-refrigerators",
        "created_at": "2023-11-21 22:03:29",
        "updated_at": "2023-11-21 22:03:29",
        "install": [],
        "warranty": [],
        "fulfillment_type_name": "Local Delivery Only",
        "delivery_option_name": "Drop-off",
        "image": "https://dq5w511paquwy.cloudfront.net/assets/images/ART318FFDW-18175118.webp",
        "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/411933-amana.webp",
        "color": "White",
        "is_in_stock": 1,
        "in_stock": true,
        "in_active_status": false,
        "estimate_availability": "Tue, Nov 28th",
        "estimate_availability_desc": "Guaranteed by",
        "installation_availability": null,
        "pickup_time": "tomorrow",
        "delivery_date": null
      }
    ],
    "has_route_access": true,
    "schedule_available": true,
    "is_schedule_all_available": true,
    "schedule_alert": null,
    "billing": {
      "first_name": null,
      "last_name": null,
      "is_company": 0,
      "company_name": null,
      "phone_number": null,
      "email": null,
      "street_address": null,
      "suite": null,
      "city": null,
      "state": null,
      "zip_code": null
    },
    "shipping": {
      "first_name": null,
      "last_name": null,
      "is_company": 0,
      "company_name": null,
      "phone_number": null,
      "email": null,
      "street_address": null,
      "suite": null,
      "city": null,
      "state": null,
      "zip_code": "63012"
    },
    "sales_person_extension_number": "314-798-0301",
    "sales_person_image": "example.com/api/api/public",
    "is_valid_zip_code": 1,
    "original_total": "655.00",
    "is_tax_exempted": 0
  },
  "meta": null,
  "errors": null
}

Update Session

Modify or update checkout session data using the PUT method, ensuring accurate and up-to-date information.

Headers

The JSON containing checkout data sends raw data in the request body. The "Origin" header is commonly used to secure cross-origin requests.

Path Variables

session_id string

Fetching the specified user ID.

Parameters

No parameter required.

Attributes

message string

The success message.

data null

It is optional.

meta null

It is optional.

errors null

It is optional.

PUT /api/v2/transaction/session/:session_id

curl --location --request PUT 'https://appliance-api.com/api/v2/transaction/session/V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==' \
--header 'Origin: test.example.com/api/api/public' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data-raw '{
    "is_same_as_shipping": 1,
    "is_receive_text": 1,
    "customer_code" : null,
    "shipping" : {
        "first_name" : "John",
        "last_name" : "Doe",
        "company_name" : "",
        "street_address": "527 Oaktree Crossing Ct, Ballwin, MO 63021, USA",
        "suite": "Suite",
        "city": "Ballwin",
        "state": "Missouri",
        "zip_code": "63011",
        "phone_number": "",
        "email": "[email protected]"
    },
    "billing" : {
        "first_name" : "John",
        "last_name" : "Doe",
        "company_name" : "",
        "street_address": "527 Oaktree Crossing Ct, Ballwin, MO 63021, USA",
        "suite": "Suite",
        "city": "Ballwin",
        "state": "Missouri",
        "zip_code": "63011",
        "phone_number": "",
        "email": "[email protected]"
    }
}

'

{
  "code": "200",
  "message": "Success",
  "data": null,
  "meta": null,
  "errors": null
}

Retrieve Checkout Session

To retrieve data from the checkout session, the GET method can be used.

Headers

The JSON containing checkout data sends raw data in the request body. The "Origin" header is commonly used to secure cross-origin requests.

Path Variables

session_id string *

Fetching the specified user ID.

Parameters

step integer

It indicates the current step or stage of the session.

Attributes

id number

The id which the user has for checkout session.

session_id string

The session id which the user has.

payment_intent_id null

It is optional to use this.

order_no null

It is optional to use this.

transaction_date string

The date of the transaction occurred.

transaction_time string

The time of the transaction occurred.

store_id string

The id of the store.

customer_code nul

It is optional to use this.

sales_person_id string

The id of salesperson during checkout session.

sales_person_name string

The name of the sales person.

delivery_method_id null

It is optional to use this.

delivery_method_name null

It is optional to use this.

subtotal string

The subtotal of the checkout price.

subsaving string

The saving amount of the checkout product.

tax string

The tax of the checkout price.

tax_price string

The tax price of the product.

warranty_charge string

The charge for warranty option.

install_charge string

The charge of the installation.

delivery_charge string

The charge for the delivery service.

item_delivery_charge string

The charge of item delivery.

discount null

It is optional to use.

discount_used null

It is optional to use.

total string

The total amount of the product price.

is_paid null

It is optional to use.

is_processed number

The option of being processed or not.

is_receive_text number

The option of receiving text or not.

read number

The option of read or not.

is_same_as_shipping number

The option of shipping.

created_at string

The date of checkout creation.

updated_at string

The date of checkout updated.

order_detail array of objects

The detail of the order.

id number

The id of checkout order.

session_id string

The session id of checkout.

product_id string

The id of the checkout product.

product_name string

The name of the product.

sku string

The stock keeping unit number of the product.

brand_id number

The id of the brand.

brand_name string

The name of the brand.

quantity number

The quantity of the product in checkout.

price string

The price of the product in checkout.

saving string

The saving amount of the product transaction.

original_price string

The original price of the product.

subtotal_price string

The subtotal price of the product.

has_install number

The installation option for the product in checkout.

has_warranty number

The option of having product warranty.

fulfillment_type number

The option of having fulfillment type.

delivery_option_id number

The option of having delivery.

delivery_charge string

The charge of delivery.

is_schedule_later number

The option of scheduling later.

category_name string

The name of the product category.

subcategory_name string

The name of product subcategory.

detail_category_name string

The detail name of the product acategory.

category_slug string

The slug of product category.

subcategory_slug string

The slug of product subcategory.

detail_category_slug string

The slug of detail product category.

created_at string

The date of checkout creation.

updated_at string

The date of checkout update.

install empty string

It is optional to use this.

warranty empty string

It is optional to use this.

fulfillment_type_name string

The name of the fulfillment type.

delivery_option_name string

The name of delivery option.

image string

The image url of the product.

brand_image string

The image url of the brand image.

color string

The color description of the product.

is_in_stock number

The option of stock.

in_stock boolean

The availability of product stock.

in_active_status boolean

The active status of the product.

estimate_availability string

The estimation of product availability.

estimate_availability_desc string

The estimation of product availability description.

installation_availability null

The availability for the installation.

has_route_access boolean

The option of route access.

schedule_available boolean

The availability of the schedule.

is_schedule_all_available boolean

The availability of all schedules.

billing array of objects

It consists of billing details for the checkout.

first_name null

It is optional to include the billing details.

last_name null

It is optional to include the billing details.

company_name null

It is optional to include the billing details.

phone_number null

It is optional to include the billing details.

street_address null

It is optional to include the billing details.

shipping array of objects

It consists of shipping details for the checkout (the same details as billing)

email null

It is optional to include the billing details.

suite null

It is optional to include the billing details.

city null

It is optional to include the billing details.

state null

It is optional to include the billing details.

zip_code null

It is optional to include the billing details.

sales_person_extension_number string

The name of the sales person.

sales_person_image string

The name of the sales person.

original_total string

The original total price of the checkout.

is_tax_exempted number

The option of tax exemption.

GET /api/v2/transaction/session/:session_id?step=1

curl --location 'https://appliance-api.com/api/v2/transaction/session/V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==' \
--header 'Origin: test.example.com/api/api/public' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "code": "200",
  "message": "Success",
  "data": {
    "id": 1,
    "session_id": "V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==",
    "payment_intent_id": null,
    "order_no": null,
    "transaction_date": "2023-11-21",
    "transaction_time": "22:03:29",
    "store_id": "STORE0001",
    "customer_code": null,
    "sales_person_id": "5d407bcf4f210",
    "sales_person_name": "John Doe",
    "delivery_method_id": null,
    "delivery_method_name": null,
    "subtotal": "606.00",
    "subsaving": "353.00",
    "tax": "8.99",
    "tax_price": "53.57",
    "warranty_charge": "0.00",
    "install_charge": "0.00",
    "delivery_charge": "0.00",
    "item_delivery_charge": "10.00",
    "discount": null,
    "discount_used": null,
    "total": "606.00",
    "is_paid": null,
    "is_processed": 0,
    "is_receive_text": 1,
    "read": 0,
    "is_same_as_shipping": 1,
    "created_at": "2023-11-21 22:03:29",
    "updated_at": "2023-11-21 22:04:24",
    "order_detail": [
      {
        "id": 1,
        "session_id": "V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==",
        "product_id": "583",
        "product_name": "30-inch  Top-Freezer Refrigerator with Glass Shelves",
        "sku": "ART318FFDW",
        "brand_id": 2,
        "brand_name": "Amana",
        "quantity": 1,
        "price": "596.00",
        "saving": "353.00",
        "original_price": "949.00",
        "subtotal_price": "596.00",
        "has_install": 0,
        "has_warranty": 0,
        "fulfillment_type": 1,
        "delivery_option_id": 2,
        "delivery_charge": "10.00",
        "is_schedule_later": 0,
        "category_name": "Refrigeration",
        "subcategory_name": "Refrigerators",
        "detail_category_name": "Top Freezer Refrigerators",
        "category_slug": "refrigeration",
        "subcategory_slug": "refrigerators",
        "detail_category_slug": "top-freezer-refrigerators",
        "created_at": "2023-11-21 22:03:29",
        "updated_at": "2023-11-21 22:03:29",
        "install": [],
        "warranty": [],
        "fulfillment_type_name": "Local Delivery Only",
        "delivery_option_name": "Drop-off",
        "image": "https://dq5w511paquwy.cloudfront.net/assets/images/ART318FFDW-18175118.webp",
        "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/411933-amana.webp",
        "color": "White",
        "is_in_stock": 1,
        "in_stock": true,
        "in_active_status": false,
        "estimate_availability": "Wed, Nov 22nd",
        "estimate_availability_desc": "Guaranteed by",
        "installation_availability": null,
        "pickup_time": "tomorrow",
        "delivery_date": null
      }
    ],
    "has_route_access": true,
    "schedule_available": true,
    "is_schedule_all_available": true,
    "schedule_alert": null,
    "billing": {
      "first_name": "John",
      "last_name": "Doe",
      "is_company": 0,
      "company_name": "",
      "phone_number": "",
      "email": "[email protected]",
      "street_address": "527 Oaktree Crossing Ct, Ballwin, MO 63021, USA",
      "suite": "Suite",
      "city": "Ballwin",
      "state": "Missouri",
      "zip_code": "63011"
    },
    "shipping": {
      "first_name": "John",
      "last_name": "Doe",
      "is_company": 0,
      "company_name": "",
      "phone_number": "",
      "email": "[email protected]",
      "street_address": "527 Oaktree Crossing Ct, Ballwin, MO 63021, USA",
      "suite": "Suite",
      "city": "Ballwin",
      "state": "Missouri",
      "zip_code": "63011"
    },
    "sales_person_extension_number": "314-798-0301",
    "sales_person_image": "example.com/api/api/public",
    "is_valid_zip_code": 1,
    "original_total": "659.57",
    "is_tax_exempted": 0
  },
  "meta": null,
  "errors": null
}

Create Checkout Session

After checkout, the final step involves payment, which can trigger notifications regarding the order.

Headers

JSON, which contains payment intent id, sends raw data in the request body. The "Origin" header is commonly used to secure cross-origin requests.

Path Variables

session_id string *

Fetching the specified user ID.

Parameters

No parameter required.

Attributes

data array of objects

order_no string

The number of orders.

meta null

It is optional.

errors null

It is optional.

POST /api/v2/transaction/session/:session_id/checkout

curl --location 'https://appliance-api.com/api/v2/transaction/session/V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==/checkout' \
--header 'Origin: test.example.com/api/api/public' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data '{
    "payment_intent_id" : "pi_3N4ILAH3gegSOuXZ1ixuLEcy"
}

'

{
  "code": "200",
  "message": "Success",
  "data": {
    "order_no": "15-94357"
  },
  "meta": null,
  "errors": null
}

Create Checkout History

The order history needs to be displayed for users to track their orders.

Headers

JSON, which contains state and zipcode, sends raw data in the request body. The "Origin" header is commonly used to secure cross-origin requests.

Path Variables

session_id ?

Fetching the specified user ID.

Parameters

session_id ?

No parameter required.

Attributes

calculate_tax number

The tax calculation.

is_valid_fulfillment_type number

The fulfillment type option.

invalid_models empty string

It is optional to include this.

POST /api/v2/transaction/session/:session_id/check-fulfillment

curl --location 'https://appliance-api.com/api/v2/transaction/session/Nlc2clVUUlFSZTRYS01OdFJDRTJwQ3k2QzdmVWhMVll5dk5GWVVQSDlySVZ3V3JHK3pmajMzNm00TGg1STVqLw==/check-fulfillment' \
--header 'Origin: test.example.com/api/api/public' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id' \
--data '{
    "state": "Bandung",
    "zip_code": "63005"
}'

{
  "code": "200",
  "message": "Success",
  "data": {
    "calculate_tax": 0,
    "is_valid_fulfillment_type": 1,
    "invalid_models": []
  },
  "meta": null,
  "errors": null
}

Delete Checkout Session

Deleting the session may be necessary to remove unused data.

Headers

The authorization is using customer's token. The "Origin" header is commonly used to secure cross-origin requests.

Path Variables

session_id string

Fetching the specified user ID.

Parameters

No parameter required.

Attributes

Nothing in the API.

DEL /api/v2/transaction/session/:session_id

curl --location --request DELETE 'https://appliance-api.com/api/v2/transaction/session/ZksvaDZXSE1FMExYNEVJR3J6bVROK01qNCtOWTZSTHNKMHkvcWp4dE9sOD0=' \
--header 'Origin: test.example.com/api/api/public' \
--header 'Authorization: {{token}}' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

No response body.
This request doesn't return any response body.

Delete Session Schedule

Deleting the session schedule may be necessary to replace it with new data or if the session schedule is no longer needed.

Headers

The authorization is using customer's token. The "Origin" header is commonly used to secure cross-origin requests.

Path Variables

session_id string

Fetching the specified user ID.

Parameters

No parameter required.

Attributes

Nothing in the API.

DEL /api/v2/transaction/session/:session_id/schedule

curl --location --request DELETE 'https://appliance-api.com/api/v2/transaction/session/ZmVmRlBtOTFseER4cVNJdDNLZlU2TVAwUW1FQmJJUEZ6VmI4UVFtNUNCcz0=/schedule' \
--header 'Origin: test.example.com/api/api/public' \
--header 'Authorization: {{token}}' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

No response.
This request doesn't return any response body.

Retrieve Checkout Status

The checkout status will appear once the entire process is completed, displaying the order number and offering options such as continuing shopping or viewing the order.

Path Variables

session_id string *

Fetching the specified user ID.

Parameters

No parameter required.

Attributes

message string

data array of objects

id number

The id which the user has for checkout session.

session_id string

The session id which the user has.

transaction_no string

The transaction number.

document array of objects

It includes the details of the document.

sku string

The stock keeping unit number of the product.

basic_description string

The description of the checkout document.

image string

The url of the image.

brand_image string

The url of the brand image.

fulfillment_type number

The option of having fulfillment type.

delivery_charge string

The charge of delivery.

delivery_option_id number

The option of having delivery.

delivery_option_name number

The name of delivery option.

quantity number

The total of product quantity.

price string

The amount of product's price.

subtotal string

The subtotal of the payment.

documents array of objects

It is optional to use this.

id number

The id number of the order document.

product_id number

The product id of the order.

sku string

The code of the stock keeping unit.

type number

The type number of products.

url string

The url of the document retail about the product.

local_url null

It is optional.

aws_url null

It is optional.

aws_status null

It is optional.

role string

The name of the document order.

priority number

The option of setting priority.

content_length string

The size of the content order.

created_at string

The date of the order created.

updated_at string

The date of the updated order.

deleted_at null

It is optional.

aws_full_url string

The url of document source.

store array of objects

The details of the store.

store_id string

The id of the store.

store_name string

The name of the store.

store_address string

The name of the store.

store_phone_number string

The name of the store.

formatted_store_phone_number string

The name of the store.

sales_person array of objects

The details of the sales person.

first_name string

The first name of the salesperson.

last_name string

The last name of the salesperson.

extension_number string

The extension number of sales person.

email string

The email of sales person.

photo string

The photo of sales person.

customer array of objects

The details of the customer.

bill_name string

The name of the customer.

bill_email string

The email of the customer.

bill_address string

The email of the customer.

shipping array of objects

It consists of shipping details for the checkout.

first_name string

The first name of the customer.

last_name string

The first name of the customer.

email string

The email of the customer.

street_address string

The street address of the customer.

suite string

The suite address of the customer.

city string

The city of address.

state string

The state of address.

zip_code string

The zip code of address.

delivery_type number

The type of the delivery.

is_delivery number

The option of the delivery.

is_pickup number

The option of the pickup Option.

GET /api/v2/transaction/checkout-session/:session_id

curl --location 'https://appliance-api.com/api/v2/transaction/checkout-session/V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==' \
--header 'x-api-key: your_api_key' \
--header 'x-tenant-id: your_tenant_id'

{
  "status": "success",
  "status_code": 200,
  "read": 0,
  "message": "Transaction Success",
  "session_id": "V2ZuVUhHUG5ZaDdnTWJFSnhEZkplalJsaDBvRm95SG42M21MMG13bmNoeDVpNmdRVDkwY3FaZUptSXh0VlAvNQ==",
  "transaction_no": "15-94357",
  "is_valid": false,
  "data": {
    "document": [
      {
        "sku": "ART318FFDW",
        "basic_description": "30-inch Top-Freezer Refrigerator with Glass Shelves",
        "image": "https://dq5w511paquwy.cloudfront.net/assets/images/ART318FFDW-18175118.webp",
        "brand_image": "https://dq5w511paquwy.cloudfront.net/assets/brands/411933-amana.webp",
        "fulfillment_type": 1,
        "fulfillment_type_name": "Local Delivery Only",
        "delivery_charge": "10.00",
        "delivery_option_id": 2,
        "delivery_option_name": "Drop-off",
        "quantity": 1,
        "price": "596.00",
        "subtotal": "596.00",
        "delivery_date": null,
        "documents": [
          {
            "id": 77001955,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/201602/dimension-guide-W10684124-D-AM.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Dimension Guide",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001956,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/202304/energy-guide-w11643995-revB.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Energy Guide",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001957,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/202111/installation-instructions-2181913-reve.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Installation Instruction",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001958,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/202204/door-reversal-instructions-w11550093-revB.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Instruction Sheet",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001959,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://www.whirlpool.com/content/dam/global/documents/202204/door-reversal-instructions-w11550094-revB-sp.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Instruction Sheet",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001960,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/202104/owners-manual-w11507956-reva.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Owners Manual",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001961,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://www.whirlpool.com/content/dam/global/documents/202001/specification-sheet-art318ffdspecsheetv01.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Specifications Sheet",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001962,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/201708/WarrantyPage-W10885250-W.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Warranty",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          },
          {
            "id": 77001963,
            "product_id": 583,
            "sku": "ART318FFDW",
            "type": 1,
            "url": "https://whirlpool.com/content/dam/global/documents/202301/warranty-w11655305-revA.pdf",
            "local_url": null,
            "aws_url": null,
            "aws_status": null,
            "role": "Warranty",
            "priority": 0,
            "content_length": "0 kb",
            "created_at": "2023-08-30 22:17:25",
            "updated_at": "2023-08-30 22:17:25",
            "deleted_at": null,
            "aws_full_url": "https://dq5w511paquwy.cloudfront.net"
          }
        ],
        "install": []
      }
    ],
    "store": {
      "store_id": "STORE0001",
      "store_name": "Manchester, MO",
      "store_address": "14290 Manchester Rd, Ballwin, MO 63011",
      "store_phone_number": "(636) 277-9010",
      "formatted_store_phone_number": "(636) 277-9010",
      "chunked_store_address": [
        "14290 Manchester Rd",
        " Ballwin",
        " MO 63011"
      ],
      "format_store_name": "Manchester, MO",
      "store_name_only": "Manchester, MO"
    },
    "sales_person": {
      "first_name": "James",
      "last_name": "Doe",
      "extension_number": "314-798-0301",
      "email": "[email protected]/api/api/public",
      "photo": "[email protected]/api/api/public.jpg",
      "fullname": "James Doe",
      "image_asset": "example.com/api/api/public"
    },
    "customer": {
      "bill_name": "John Doe",
      "bill_email": "[email protected]",
      "bill_address": "527, Oaktree Crossing Ct, Ballwin, Suite, Missouri, 63011, USA",
      "bill_phone_number": "",
      "shipping": {
        "first_name": "John",
        "last_name": "Doe",
        "is_company": 0,
        "company_name": "",
        "phone_number": "",
        "email": "[email protected]",
        "street_address": "527 Oaktree Crossing Ct, Ballwin, MO 63021, USA",
        "suite": "Suite",
        "city": "Ballwin",
        "state": "Missouri",
        "zip_code": "63011"
      }
    },
    "transaction_detail": {
      "product": [
        {
          "sku": "ART318FFDW",
          "basic_description": "30-inch Top-Freezer Refrigerator with Glass Shelves",
          "image": "https://dq5w511paquwy.cloudfront.net/assets/images/ART318FFDW-18175118.webp",
          "product_id": "583",
          "product_name": "30-inch Top-Freezer Refrigerator with Glass Shelves",
          "category": "Refrigeration",
          "subcategory": "Refrigerators",
          "detail_category": "Top Freezer Refrigerators",
          "brand_id": 2,
          "brand_name": "Amana",
          "color": "White",
          "quantity": 1,
          "price": "596.00",
          "subtotal_price": "596.00",
          "install": [],
          "warranty": []
        }
      ],
      "tax": "53.57",
      "subtotal": "596.00",
      "total": "659.57",
      "delivery_charge": 10,
      "zipcode": "63011",
      "email": "[email protected]",
      "phone": "",
      "install": "0.00",
      "warranty": "0.00"
    },
    "delivery_type": 1,
    "is_delivery": 1,
    "is_pickup": 0
  }
}

Checkout Session

Create Session​

Headers​

Parameters​

Attributes​

Update Session​

Headers​

Path Variables​

Parameters​

Attributes​

Retrieve Checkout Session​

Headers​

Path Variables​

Parameters​

Attributes​

Create Checkout Session​

Headers​

Path Variables​

Parameters​

Attributes​

Create Checkout History​

Headers​

Path Variables​

Parameters​

Attributes​

Delete Checkout Session​

Headers​

Path Variables​

Parameters​

Attributes​

Delete Session Schedule​

Headers​

Path Variables​

Parameters​

Attributes​

Retrieve Checkout Status​

Path Variables​

Parameters​

Attributes​

Create Session

Headers

Parameters

Attributes

Update Session

Headers

Path Variables

Parameters

Attributes

Retrieve Checkout Session

Headers

Path Variables

Parameters

Attributes

Create Checkout Session

Headers

Path Variables

Parameters

Attributes

Create Checkout History

Headers

Path Variables

Parameters

Attributes

Delete Checkout Session

Headers

Path Variables

Parameters

Attributes

Delete Session Schedule

Headers

Path Variables

Parameters

Attributes

Retrieve Checkout Status

Path Variables

Parameters

Attributes