Connector API (1.13.0)

Download OpenAPI specification:

E-mail: info@organi.be

accounts

/accounts

Get all accounts

Responses

Response samples

200
default

Content type

application/json

{"current_page": 0,
"data": [{"id": 0,
"name": "string",
"slug": "string",
"locales": "string",
"uri_auth": "string",
"uri_livecalls": "string",
"uri_sync": "string",
"active": true,
"queued": true,
"syncing": true,
"last_sync_started": "2019-08-24T14:15:22Z",
"last_sync_completed": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"first_page_url": "string",
"from": 0,
"last_page": 0,
"last_page_url": "string",
"next_page_url": "string",
"path": "string",
"per_page": 0,
"prev_page_url": "string",
"to": 0,
"total": 0
}

/accounts

Create an account

Request Body schema: application/json
required

id	integer <int64>
name	string
slug	string
locales	string
uri_auth	string
uri_livecalls	string
uri_sync	string

Responses

Request samples

Payload

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"locales": "string",
"uri_auth": "string",
"uri_livecalls": "string",
"uri_sync": "string"
}

Response samples

200
default

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"locales": "string",
"uri_auth": "string",
"uri_livecalls": "string",
"uri_sync": "string",
"active": true,
"queued": true,
"syncing": true,
"last_sync_started": "2019-08-24T14:15:22Z",
"last_sync_completed": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

/accounts/{id}

Get a single account

path Parameters

id

required

integer <int64>

ID of account to fetch

Responses

Response samples

200
default

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"locales": "string",
"uri_auth": "string",
"uri_livecalls": "string",
"uri_sync": "string",
"active": true,
"queued": true,
"syncing": true,
"last_sync_started": "2019-08-24T14:15:22Z",
"last_sync_completed": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

sync

/sync/trigger

Trigger a synchronisation check.

Responses

Response samples

200

Content type

application/json

{"version": "string"
}

/sync/version

Get the api's version.

Responses

Response samples

200

Content type

application/json

{"version": "string"
}

callback

/callback/get-stores

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{"code": "string",
"name": "string"
}
]
}

/callback/get-delivery-methods

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{"code": "0020",
"label": {"nl": "string",
"fr": "string",
"en": "string"
},
"type": "delivery"
}
]
}

/callback/get-customer-authenticate

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-shipping-times

header Parameters

x-webshop-id required	string webshop code
date	string <date (ISO 8601)>

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{"code": "0020",
"label": {"nl": "string",
"fr": "string",
"en": "string"
}
}
]
}

/callback/get-is-pickup-location-open

header Parameters

x-webshop-id

required

string

webshop code

Request Body schema: application/json
required

store	string
date	string

Responses

Request samples

Payload

Content type

application/json

{"store": "string",
"date": "string"
}

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": {"success": true
}
}

/callback/get-order-types

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{"code": "string",
"label": "string",
"sendMailBeforeOfflinePayment": true,
"sendMailBeforeOnlinePayment": true,
"enablePayment": true,
"allowBackorder": true,
"checkWithQuantity": true,
"description": "string",
"enableExtraConfirm": true,
"confirmTitle": "string",
"confirmDescription": "string",
"labelCheckoutButton": "string",
"labelOrderCode": "string",
"labelStep": "string",
"labelStepConfirmation": "string",
"confirmationText": "string",
"tender": true
}
]
}

/callback/get-price-detail

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-product-lists

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-product-list

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-stock-status

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-user-exists

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-unit-calculation

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/set-new-password

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-transport-cost

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-additional-cart-lines

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-delivery-date

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-representative-customers

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-customer

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-related-apps

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-customer-autologin

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-users-list

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/set-user-status

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/delete-user

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-user-attributes

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/set-user-data

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-customer-delivery-addresses

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/set-customer-delivery-addresses

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-document

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-documents

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-document-preview

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-sync-status

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/restart-sync

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/document-download

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-customer-data

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/activate-customer

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/check-vat

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/start-sync

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/callback/get-price-bulk

header Parameters

x-webshop-id

required

string

webshop code

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

webhook

/webhook/set-image-exists

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/webhook/push-event

Responses

Response samples

200

Content type

application/json

{"success": true,
"code": 200,
"data": [{ }
]
}

/webhook/push-order

Responses

Response samples

200

Content type

application/json

{ }

Connector API (1.13.0)

accounts

/accounts

Responses

Response samples

/accounts

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/accounts/{id}

path Parameters

Responses

Response samples

sync

/sync/trigger

Responses

Response samples

/sync/version

Responses

Response samples

callback

/callback/get-stores

header Parameters

Responses

Response samples

/callback/get-delivery-methods

header Parameters

Responses

Response samples

/callback/get-customer-authenticate

header Parameters

Responses

Response samples

/callback/get-shipping-times

header Parameters

Responses

Response samples

/callback/get-is-pickup-location-open

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

/callback/get-order-types

header Parameters

Responses

Response samples

/callback/get-price-detail

header Parameters

Responses

Response samples

/callback/get-product-lists

header Parameters

Responses

Response samples

/callback/get-product-list

header Parameters

Responses

Response samples

/callback/get-stock-status

header Parameters

Responses

Response samples

/callback/get-user-exists

header Parameters

Responses

Response samples

/callback/get-unit-calculation

header Parameters

Responses

Response samples

/callback/set-new-password

header Parameters

Responses

Response samples

/callback/get-transport-cost

header Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required