CategoryService
GET /api/integrations/category
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/category
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/category
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/category[/:category_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/category[/:category_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/category[/:category_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | YES |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
BackendTasksService
GET /api/integrations/events/backend-tasks
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/events/backend-tasks
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/events/backend-tasks
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/events/backend-tasks[/:backend_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/events/backend-tasks[/:backend_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/events/backend-tasks[/:backend_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/integrations/events/backend-tasks[/:backend_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
request | NO | ||
result | NO | ||
source | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
JobTasksService
GET /api/integrations/events/job-tasks
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/events/job-tasks
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/events/job-tasks
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/events/job-tasks[/:job_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/events/job-tasks[/:job_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/events/job-tasks[/:job_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/integrations/events/job-tasks[/:job_task_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
name | NO | ||
timetable | NO | ||
extId | NO | ||
owner | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
JobsService
GET /api/integrations/events/jobs
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/events/jobs
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/events/jobs
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/events/jobs[/:job_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/events/jobs[/:job_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/events/jobs[/:job_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/json
application/vnd.orderadmin\integrations\api.v1+json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/integrations/events/jobs[/:job_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
data | NO | ||
result | NO | ||
jobTask | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
RequestService
GET /api/integrations/event-request
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
name | NO | ||
source | NO | ||
request | NO | ||
result | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/event-request
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
name | NO | ||
source | NO | ||
request | NO | ||
result | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/event-request
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
name | NO | ||
source | NO | ||
request | NO | ||
result | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/event-request[/:request_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
name | NO | ||
source | NO | ||
request | NO | ||
result | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/event-request[/:request_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
name | NO | ||
source | NO | ||
request | NO | ||
result | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/event-request[/:request_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
state | NO | ||
name | NO | ||
source | NO | ||
request | NO | ||
result | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
IntegrationService
GET /api/integrations/integration
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/integration
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/integration[/:integration_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/integration[/:integration_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/integration[/:integration_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
ImportService
GET /api/integrations/import
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/import
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/import[/:import_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/import[/:import_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/import[/:import_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
IntegrationService
GET /api/integrations/integration
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/integration
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/integration[/:integration_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/integration[/:integration_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/integration[/:integration_id]
Fields
Field | Type | Description | Required |
---|---|---|---|
name/name | NO |
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 400: Client Error
- 422: Unprocessable Entity
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
multipart/form-data
application/x-www-form-urlencoded |
Allow | Comma-separated list of all HTTP methods allowed |
Body
SourceDictionary
GET /api/integrations/source-dictionaries[/:source_id][/:type]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/source-dictionaries[/:source_id][/:type]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/source-dictionaries[/:source_id][/:type]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/source-dictionaries[/:source_id][/:type]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/integrations/source-dictionaries[/:source_id][/:type]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
application/x-www-form-urlencoded |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/integrations/source-dictionaries[/:source_id][/:type]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
SourceService
GET /api/integrations/source-service[/]
Request
Headers
Header | Value |
---|---|
Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/source-service[/]
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/source-service[/:source_service_id][/]
Request
Headers
Header | Value |
---|---|
Accept |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/source-service[/:source_service_id][/]
Request
Headers
Header | Value |
---|---|
Accept | |
Content-Type |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 404: Not Found
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
OPTIONS /api/integrations/source-service[/:source_service_id][/]
Request
Headers
Header | Value |
---|---|
Accept |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
Headers
Header | Value |
---|---|
Content-Type | |
Allow | Comma-separated list of all HTTP methods allowed |
Body
Source
GET /api/integrations/sources
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
POST /api/integrations/sources
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
application/x-www-form-urlencoded |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 201: Created
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
GET /api/integrations/sources[/:source_id]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PATCH /api/integrations/sources[/:source_id]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
application/x-www-form-urlencoded |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
PUT /api/integrations/sources[/:source_id]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/json
application/x-www-form-urlencoded |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Body
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 200: OK
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |
Body
DELETE /api/integrations/sources[/:source_id]
Request
Headers
Header | Value |
---|---|
Accept | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Authorization | HTTP Basic, HTTP Digest, or OAuth2 Bearer token (check API provider for details) |
Response
Status Codes
- 406: Not Acceptable
- 415: Unsupported Media Type
- 204: No Content
- 404: Not Found
- 401: Unauthorized
- 403: Forbidden
Headers
Header | Value |
---|---|
Content-Type | application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json
application/vnd.orderadmin\integrations\api.v1+json
application/hal+json
application/json |
Allow | Comma-separated list of all HTTP methods allowed |