OrderChief API

Download OpenAPI specification:

OAuth

Endpoints regrading the authorization to the OrderChief API

Get Token

POST-endpoint to retrieve a new Bearer token to be used in futrure requests. Use the provided client_id and client_secret in the request. The audience and grant_type are already provided in the sample request.

Request Body schema: application/x-www-form-urlencoded

Token request payload

client_id
string
client_secret
string
audience
string
grant_type
string

Responses

Request samples

Content type
application/x-www-form-urlencoded
client_id=string&client_secret=string&audience=https%3A%2F%2Forderchief.semso.io&grant_type=client_credentials

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "scope": "string",
  • "expires_in": 86400,
  • "token_type": "Bearer"
}

Item

Add items

This POST method allows to add items through the OrderChief API

Authorizations:
OAuth2
Request Body schema: application/json
required

Request body for adding item

object (incommingMessageHeader)
object (itemMessage)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}

OrderAck

Add orderacks

This POST method allows to add orderAcks through the OrderChief API

Authorizations:
OAuth2
Request Body schema: application/json
required

Request body for adding orderAck

object (incommingMessageHeader)
object (orderAckMessage)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}

Order

Add orders

This POST method allows to add orders through the OrderChief API

Authorizations:
OAuth2
Request Body schema: application/json
required

Request body for adding order

object (incommingMessageHeader)
object (orderMessage)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}

Shipment

Add shipments

This POST method allows to add shipments through the OrderChief API

Authorizations:
OAuth2
Request Body schema: application/json
required

Request body for adding shipment

object (incommingMessageHeader)
object (shipmentMessage)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}

Stock

Add stockmutations

This POST method allows to add stockmutations through the OrderChief API

Authorizations:
OAuth2
Request Body schema: application/json
required

Request body for adding stock mutations

object (incommingMessageHeader)
Array of objects (stockMessage)

Responses

Request samples

Content type
application/json
{
  • "header": {
    },
  • "message": [
    ]
}

Webhooks

Order webhooks

This method is not supported and only provides documentation regarding the models.

Responses

Response samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}

OrderResponse webhooks

This method is not supported and only provides documentation regarding the models.

Responses

Response samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}

Shipment webhooks

This method is not supported and only provides documentation regarding the models.

Responses

Response samples

Content type
application/json
{
  • "header": {
    },
  • "message": {
    }
}