Skip to main content
POST
Create integration exception logs
OAuth2 scopes required: write:integration. See Scopes for OAuth apps.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Scopes

write:integration

Connect and manage integrations

Path Parameters

id
integer
required

The id of the integration

Body

application/json

Request body for creating an integration exception log.

base_url
string
required

Base shop URL

Minimum string length: 1
Example:

"https://example.com"

full_url
string | null

Full path to resource where error happened

Example:

"https://example.com/order-note.json"

method
string | null
default:""

HTTP method that caused an error

Example:

"POST"

response_code
integer | null

Standard HTTP error code

Required range: x >= 0
Example:

495

response
Response object · object | null

Response JSON containing response body and headers

request
Request object · object | null

Request JSON containing request body and headers

created_at
string<date-time> | null

Timestamp indicating when an exception occurred. If not provided, the current date will be used.

Example:

"2023-03-01T02:02:00+01:00"

exception_type
string | null

Internal field to store Python exception type. We use this field to suggest to our users how they can fix issues.

Example:

"requests.exceptions.SSLError"

exception
string | null

Human readable description of exception

Example:

"An SSL error occurred"

Response

Created

data
Integration Log Object · object

An integration exception log record containing information about a failed API request to a shop system.