API Update: v2 Deprecation Notice

Release Date

Wed March 1, 2022

Note to current API Users:

Related to ongoing v2 /order/ deprecation, we are removing the v2 order split endpoint.

If you are using an Ordoro v3 account to make API requests, this should not affect you, as this endpoint was explicitly deprecated when we made our final
migrations in 2020.

However, if you are still accessing v2 endpoints using the API and older API access credentials, you may need to update your code.

Breaking Changes

  • POST /order/{order_id}/split/ has been deprecated in favor of POST /v3/order/{order_number}/split
  • Please see the Ordoro API documentation for any questions as to how to utilize the current version’s Order split functionality.

Note:

From our records this should not affect the majority of users, yet we would like to announce this in an official capacity for any edge case scenarios.

Split an Order

POST /v3/order/{order_number}/split

Payload:

{
  "additionalProperties": false,
  "properties": {
    "split_orders": {
      "items": {
        "properties": {
          "lines": {
            "items": {
              "additionalProperties": false,
              "properties": {
                "line_id": {
                  "type": "integer"
                },
                "quantity": {
                  "exclusiveMinimum": false,
                  "minimum": 0,
                  "type": "number"
                }
              },
              "required": [
                "line_id",
                "quantity"
              ],
              "type": "object"
            },
            "minItems": 1,
            "type": "array"
          }
        },
        "type": "object"
      },
      "minItems": 2,
      "type": "array"
    }
  },
  "required": [
    "split_orders"
  ],
  "title": "Split Order Schema",
  "type": "object"
}

Response:

{
    "title": "Split Order Response Schema",
    "type": "array",
    "minItems": 2,
    "uniqueItems": true,
    "items": {
      "description": "Resulting child order numbers",
      "type": "string"
    }
}