POST
/
v5
/
app
/
app_connections
Create an App Connection
curl --request POST \
  --url https://{defaultHost}/v5/app/app_connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "resource_id": "<string>",
  "resource_type": "product",
  "view_type": "customer_before_checkout_view"
}'
{
  "id": "<string>",
  "created_at": 123,
  "company_id": "<string>",
  "app_id": "<string>",
  "resource_id": "<string>",
  "resource_type": "<string>",
  "view_type": "customer_product_view"
}

Authorizations

​
Authorization
string
header
required

App API key for /v5/app and /v5/company endpoints

Body

application/json
​
resource_id
string
required

The ID of the polymorphic resource for the connection. Ex. a product ID like prod_*************.

​
resource_type
enum<string>
required

The type of the polymorphic resource for the connection. Ex. 'product'

Available options:
product
​
view_type
enum<string>
required

The type of view for the connection.

Available options:
customer_before_checkout_view

Response

201 - application/json

app connection created

​
id
string
required

The ID of the app connection, which will look like apco_*************

​
created_at
number
required

The date the app connection was created.

​
company_id
string
required

The ID of the company, which will look like biz_*************

​
app_id
string
required

The ID of the app, which will look like app_*************

​
resource_id
string
required

The ID of the polymorphic resource for the connection. Ex. a product ID like prod_*************.

​
resource_type
string
required

The type of the polymorphic resource for the connection. Ex. 'product'

​
view_type
enum<string>
required

The type of view for the connection.

Available options:
customer_product_view,
seller_product_view,
customer_before_checkout_view