Ankorstore Integration API
The Integration API from Ankorstore — 1 operation(s) for integration.
OpenAPI Specification
openapi: 3.1.0
info:
version: 1.2.2-oas3.1
title: Ankorstore Stock Tracking and Logistics Applications Integration API
summary: API specification for the Ankorstore Stock Tracking and Logistics system
description: Ankorstore Stock Tracking and Logistics (ASTRAL) API specification
contact:
name: Ankorstore
url: https://www.ankorstore.com
email: api@ankorstore.com
license:
url: https://creativecommons.org/publicdomain/zero/1.0/
name: CC0 1.0 Universal
servers:
- url: http://www.ankorlocal.com:8000
description: Local Development Server
- url: https://www.preprod.ankorstore.com
description: Staging Environment
- url: https://www.ankorstore.com
description: Prod Environment
tags:
- name: Integration
paths:
/api/v1/integration/external-integrations/-actions/update-status:
post:
summary: Update status of External Integration
operationId: integration-update-external-integration-status
description: Allows to notify Ankorstore about changing the status of an integration of external platform
tags:
- Integration
parameters:
- name: Accept
in: header
description: application/vnd.api+json
schema:
type: string
default: application/vnd.api+json
requestBody:
required: true
content:
application/json:
schema:
type: object
properties: &id001
platform:
type: string
enum:
- shopify
- woocommerce
- prestashop
- odoo
- sellsy
status:
type: string
enum:
- enabled
- disabled
required: &id002
- platform
- status
responses:
'200':
description: Single External Integration
content:
application/vnd.api+json:
schema:
type: object
properties:
jsonapi:
description: An object describing the server's implementation
type: object
properties: &id003
version:
type: string
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
data:
type: object
properties:
type:
type: string
default: external-integrations
id:
type: string
description: '[resource object identifier (uuid)](https://jsonapi.org/format/#document-resource-object-identification)'
format: uuid
attributes:
type: object
properties: *id001
required: *id002
required:
- data
- jsonapi
'400':
description: Bad request
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: &id004
errors:
type: array
uniqueItems: true
items:
type: object
properties:
code:
description: An application-specific error code, expressed as a string value.
type: string
detail:
description: A human-readable explanation specific to this occurrence of the problem.
type: string
status:
description: The HTTP status code applicable to this problem, expressed as a string value.
type: string
title:
description: The HTTP status code description applicable to this problem
type: string
source:
type: object
description: Optional object pointing towards the problematic field
properties:
pointer:
type: string
description: The field key
meta:
description: Non-standard meta-information that can not be represented as an attribute or relationship.
type: object
additionalProperties: true
additionalProperties: false
jsonapi:
description: An object describing the server's implementation
type: object
properties: *id003
additionalProperties: false
required: &id005
- errors
example:
jsonapi:
version: '1.0'
errors:
- detail: Bad request
status: '400'
'401':
description: Unauthorized
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: *id004
required: *id005
example:
jsonapi:
version: '1.0'
errors:
- detail: Unauthorized
status: '401'
'403':
description: '[Forbidden](https://jsonapi.org/format/#crud-creating-responses-403)'
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: *id004
required: *id005
example:
jsonapi:
version: '1.0'
errors:
- detail: Forbidden
status: '403'
'406':
description: Not Acceptable
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: *id004
required: *id005
example:
jsonapi:
version: '1.0'
errors:
- detail: Not Acceptable
status: '406'
'415':
description: Unsupported Media Type
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: *id004
required: *id005
example:
jsonapi:
version: '1.0'
errors:
- detail: Unsupported Media Type
status: '415'
'422':
description: 'Unprocessable Entity : Data provided are invalid'
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: *id004
required: *id005
example:
jsonapi:
version: string
errors:
- detail: The field is required.
source:
pointer: data.attributes.field
status: '422'
title: Unprocessable Content
'500':
description: '[Server Error](https://jsonapi.org/format/#errors)'
content:
application/vnd.api+json:
schema:
type: object
additionalProperties: false
properties: *id004
required: *id005
example:
jsonapi:
version: '1.0'
errors:
- detail: Server Error
status: '500'
components:
securitySchemes:
CookieKey:
type: apiKey
name: ankorstore_session
in: cookie