Hooks

This module enables integration of other plataforms with the key API

Create a new order on the key API standards

post

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

Body

userobjectrequired

productsobject[]required

externalOrderIdstringoptionalExample: XPTO-0001

verificationTypestring · enumoptionalDefault: invisibleAvailable options:

Responses

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url '/integration/ecommerce/hooks/{companyId}/new-order' \
  --header 'x-w3block-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "user": {
      "email": "[e-mail]",
      "name": "John"
    },
    "products": [
      {
        "externalId": "XPTO-0001-43",
        "description": "Lorem..."
      }
    ],
    "externalOrderId": "XPTO-0001",
    "verificationType": "numeric"
  }'

201

401

201

No Content

Create a new order on woo commerce standards

post

Path parameters

companyIdstringrequired

Header parameters

x-wc-webhook-signaturestringoptional

Webhook signature

Body

billingobjectrequired

order_keystringrequiredExample: wc_order_602aevefa

line_itemsobject[]required

statusstringrequired

Responses

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url '/integration/ecommerce/hooks/{companyId}/woo-commerce' \
  --header 'Content-Type: application/json' \
  --data '{
    "billing": {
      "first_name": "John",
      "email": "[e-mail]"
    },
    "order_key": "wc_order_602aevefa",
    "line_items": [
      {
        "sku": "NFTXPTO",
        "quantity": 1
      }
    ],
    "status": "text"
  }'

201

201

No Content

Get status from created order

get

Authorizations

x-w3block-api-keyx-w3block-idx-w3block-secretbearer

Path parameters

companyIdstringrequired

externalOrderIdstringrequired

Responses

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url '/integration/ecommerce/hooks/{companyId}/external-order-id/{externalOrderId}' \
  --header 'x-w3block-api-key: YOUR_API_KEY'

200

401

200

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "externalOrderId": null,
  "products": [
    {
      "chainId": 1,
      "contractAddress": "0x1a17d9bCbC4b077C69d7f93155408995144A277F",
      "deliveredIn": null,
      "reason": null,
      "scheduledTo": null,
      "status": "waiting",
      "tokenId": null,
      "txHash": null,
      "externalId": "123",
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "reason": null,
  "status": "failed",
  "userStatus": "notFound"
}