⬆️Request and Response

Request to the API endpoint

Retrieves a list of orders that meet the specified criteria

POST https://api.alephcrm.com/v2/orders

Query Parameters

Name	Type	Description
API_KEY*	String	(default=none)
accountId *	Integer	(default=none)
orderInfo	/

201: Created

[
  {
    "Message": "A number with the internal AlephCRM ID of the created order-for informational purposes only",
    "Level": {
      "Id": 99,
      "Name": "OK"
    }
  }
]

400: Bad Request

[
  {
    "Message": "Error string",
    "Level": {
      "Id": 0,
      "Name": "Error"
    }
  }
]

401: Unauthorized

[
  {
    "Message": "Error string",
    "Level": {
      "Id": 0,
      "Name": "Error"
    }
  }
]

403: Forbidden

[
  {
    "Message": "Error string",
    "Level": {
      "Id": 0,
      "Name": "Error"
    }
  }
]

412: Precondition Failed

[
  {
    "Message": "Error string",
    "Level": {
      "Id": 0,
      "Name": "Error"
    }
  }
]

416: Range Not Satisfiable

[
  {
    "Message": "Error string",
    "Level": {
      "Id": 0,
      "Name": "Error"
    }
  }
]

429: Too Many Requests {"Status": integer, "Message": string}

500: Internal Server Error string

Parameters details

API_KEY

The API_KEY that was provided.

accountId

The Alephee account ID of the shipping label you are trying to get.

orderInfo

JSON package with the order to be created.