Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Inventory Update API Endpoint

Purpose:

Allow to update stock level real time.

...

Code Block
{
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "detail": "Validation errors.",
    "errors": [
        {
            "field": "Id",
            "message": "Id is required."
        },
        {
            "field": "VariantId",
            "message": "VariantId is required."
        }
    ]
}

...

Price Update API Endpoint

Purpose:

Allow to delete update product variant price real time.

API Endpoint Details:

Method

Endpoint

POST

https://dev-greenback-fn-importerwebhook.azurewebsites.net/api/webhooks/

deletes

updates/

product

price

Request Headers:

Header

Required

Description

tenantId

Yes

Tenant Id

X-API-KEY

Yes

API key for authentication

Request Payload (JSON):

Code Block
{
  "id": "1622203826274",
  "variantId": "14607116304482",
  "price": 500.32,
  "originalPrice": 700.53
}

Field Description:

  • id (string, required) - The product id.

  • variantId (string, required) - The variant id.

  • Price (decimal, required) - The new variant price.

  • OriginalPrice (decimal, required) - The new original price for sale.

Response:

  • Status code 200 (Automatically send the response if API key is valid and process the update in queue).

  • Status code 401 Unauthorised

...

Code Block
{
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "detail": "Validation errors.",
    "errors": [
        {
            "field": "Id",
            "message": "Id is required."
        },
        {
            "field": "VariantId",
            "message": "VariantId is required."
        }
    ]
}

...

Product Delete API Endpoint (advanced)

Purpose:

Allow to update delete product variant price real time.

API Endpoint Details:

Method

Endpoint

POST

/api/webhooks/

updates

deletes/

price

product

Request Headers:

Header

Required

Description

tenantId

Yes

Tenant Id

X-API-KEY

Yes

API key for authentication

Request Payload (JSON):

Code Block
{
  "id": "1622203826274",
  "variantId": "14607116304482",
  "price": 500.32,
  "originalPrice": 700.53
}

Field Description:

  • id (string, required) - The product id.variantId (string, required) - The variant id.

  • Price (decimal, required) - The new variant price.

  • OriginalPrice (decimal, required) - The new original price for sale.

Response:

  • Status code 200 (Automatically send the response if API key is valid and process the update in queue).

  • Status code 401 Unauthorised

...

Code Block
{
    "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
    "title": "One or more validation errors occurred.",
    "status": 400,
    "detail": "Validation errors.",
    "errors": [
        {
            "field": "Id",
            "message": "Id is required."
        },
        {
            "field": "VariantId",
            "message": "VariantId is required."
        }
    ]
}

Product Create API Endpoint (Advanced)

Purpose:

Allow to create product real time.

API Endpoint Details:

Method

Endpoint

POST

https://dev-greenback-fn-importerwebhook.azurewebsites.net/api/webhooks/creates/product?

Request Headers:

Header

Required

Description

tenantId

Yes

Tenant Id

X-API-KEY

Yes

API key for authentication

...