Webhook product action - OgnianApostolov/builderly-api-docs GitHub Wiki

Model

"ProductWebhook product_webhook": {
    "name": {
        "type": "string",
        "required": "true"
    },
    "ribbon": {
        "type": "string"
    },
    "striked": {
        "type": "string"
    },
    "medias": {
        "type": "string",
        "required": "true"
    },
    "price": {
        "type": "string",
        "required": "true"
    },
    "description": {
        "type": "string",
        "required": "true"
    },
    "product_options": {
        "type": "string",
        "required": "true"
    },
    "options_name": {
        "type": "string",
        "required": "true"
    },
    "collection": {
        "type": "string",
        "required": "true"
    },
    "requires_shipping": {
        "type": "string",
        "required": "true"
    },
    "weight": {
        "type": "string",
        "required": "true"
    },
    "reference_id": {
        "type": "string",
        "required": "true"
    }
}

#Methods

Methods

Create new

POST 'https://{{your-builderly-domain}}/webhook/product' req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/webhook/product',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: product_webhook
}

Responses Success - status 201

{ product_webhook }

Error - status 400

{
    error_message
}

Update

PATCH 'https://{{your-builderly-domain}}/webhook/product'

method: 'PATCH'
{
    url: 'https://{{your-builderly-domain}}/webhook/product',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: 
}

Responses Success - status 200

{ product_webhook }

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete

DELETE 'https://{{your-builderly-domain}}/webhook/product'

method: 'DELETE'
{
    url: 'https://{{your-builderly-domain}}/webhook/product',
    headers: {
        'X-API-KEY': api_key
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ product_webhook }

Not found - status 404

{}

Error - status 500

{
    error_message
}