Oli Docs
01. Getting Started SDK02. Getting Started SDK-VOD03. Getting Started SDK-SHORT04. Vtex05. ShopifyRequirementsPermissions keysRoutes IntegrationsCart CheckoutLive sharing initialize or finishGet productsSold Hook06. Woocommerce07. Braavo08. Linx09. Vipcommerce10. Vnda11. Jetcommerce12. Magento13. Webstorm

Getting Started Oli-Checkout

Integrations API from multiples platforms

Requirements

- Domain page administrator
- X-Shopify-Access-Token

Permissions keys

- Hook orders
- Draft_orders
- Orders
- Products
- Inventory

Routes Integrations

- Router GET - /admin/api/2022-01/products.json
- Router GET - /admin/api/2022-01/draft_orders.json
- Router GET - /admin/api/2021-10/products/123321132/variants.json
- Router GET - /admin/api/2021-10/draft_orders/1233211.json
- Router GET - /admin/api/2021-10/products/1233211123.json
- Router GET - /admin/api/2020-04/products.json?title=<title product>
- Router POST - /admin/api/2022-01/webhooks.json
- Router GET - /admin/api/2022-01/webhooks.json
- Router DELETE - /admin/api/2022-01/webhooks/123321123.json

Cart Checkout

Simple generate url to redirect users from shopping cart using identification Utm_Source.

POST Router:

https://Domain/checkout/cart

Request:

{
  "items": {
    "id": "string",
    "quantity": 0,
  },
  "clientProfileData": {
    "liveId": "fake-ab1c-4b59-a65e-38283984ed46"
  }
}

Response:

{
  "message": "string",
  "status": "string",
  "data": {
    "url": "https://domainClient.vtexcommercestable.com.br/checkout/cart/add?sku=1233&qty=1&seller=1&sku=1233&qty=1&seller=1&utm_source=Oli_DayMonthYear
  }
}

Live sharing initialize or finish

Initialize live configure webhook order.

POST Router:

https://Domain/checkout/status/live

Request:

Example start live

{
    "isNewStartLive": true,
    "clientProfileData": {
        "liveId": "fake-ab1c-4b59-a65e-38283984ed46",
    }
}

Response:

Response start live

{
    "message": null,
    "statusCode": 201,
    "status": "CREATED",
}

Request:

End live delete webhook

{
    "isNewStartLive": false,
    "clientProfileData": {
        "liveId": "fake-ab1c-4b59-a65e-38283984ed46"
    }
}

Response:

Example end live sharing

{
    "message": null,
    "statusCode": 200,
    "status": "SUCCESS",
}

Get products

Choice products from live

POST Router:

https://Domain/checkout/get/products

Request:

{
    "keyword": "title product",
    "clientProfileData": {
        "liveId": "1b929f5d-ab1c-4b59-a6e5-38283984ed46"
    }
}

Response:

{
    "data": [
        {
            "product": {
                "productId": "19356",
                "title": "Camisa Example in store",
                "description": "Description keyWord",
                "Items": [
                    {
                        "images": [
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            },
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            },
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            },
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            }
                        ],
                        "skuId": "23326",
                        "variantName": "Camisa Example in store - P",
                        "cores": [
                            "Rosa"
                        ],
                        "size": [
                            "P"
                        ]
                    },
                    {
                        "images": [
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            },
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            },
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            },
                            {
                                "imageUrl": "https://store/arquivos/ids/166128/image.jpg?v=637595567273300000"
                            }
                        ],
                        "skuId": "19357",
                        "variantName": "Camisa Example in store - M",
                        "cores": [
                            "Rosa"
                        ],
                        "size": [
                            "M"
                        ]
                    }
                ]
            }
        }
    ],
    "status": "SUCCESS",
    "statusCode": 200
}

Sold Hook

Sold product alert live

Socket Emit: soldInLive

{
    "data": {
        "id": "5abb01e3-0637-4029-b78b-179315796f48",
        "fullName": "JulianaWerner"
    },
    "status": "SUCCESS",
    "statusCode": 200
}