Orders

Overview

The Orders API abstracts the Orders API from Woocommerce.

Creating a new order

It is possible to create an order for a logged in customer. The following squence diagram shows the required calls to successfully create an order.

api calls required to create an order

The customer_id is the data.user.data.ID from the login response.

Create an order.

POST https://console.flecs.tech/api/v2/my/orders

Creates a new order.

Headers

Name	Type	Description
Authorization*	String	Bearer token

Request Body

Name	Type	Description
customer_id*	Number
payment_method*	String	"b2bking-invoice-gateway"
payment_method_title	String	"Payment on account"
billing*	Object	{ first_name: String, last_name: String, company: String, address: String, city: String, postcode: String, state: String, country: String, email: String, vat: String }
line_items*	Array	[ { product_id: Number, quantity: Number } ]
set_paid*	Boolean	True

401 Permission denied

500: Internal Server Error

400: Bad Request

201: Created Order successfully created

statusCode: 201,
statusText: "Created",
data: {
    "id": 1,
    "parent_id": 0,
    "status": "processing",
    "currency": "EUR",
    "version": "8.4.0",
    "prices_include_tax": false,
    "date_created": "2024-01-01T23:59:11",
    "date_modified": "2024-01-01T23:59:11",
    "discount_total": "0.00",
    "discount_tax": "0.00",
    "shipping_total": "0.00",
    "shipping_tax": "0.00",
    "cart_tax": "1.90",
    "total": "11.88",
    "total_tax": "1.90",
    "customer_id": 2,
    "order_key": "wc_order_abc",
    "billing": {
        "first_name": "John",
        "last_name": "Doe",
        "company": "Great Company GmbH",
        "address_1": "Road 1",
        "address_2": "",
        "city": "Great City",
        "state": "",
        "postcode": "98765",
        "country": "DE",
        "email": "[e-mail]",
        "phone": ""
    },
    "payment_method": "b2bking-invoice-gateway",
    "payment_method_title": "Payment on account",
    "created_via": "rest-api",
    "customer_note": "",
    "date_completed": null,
    "date_paid": "2024-01-01T23:59:11",
    "cart_hash": "",
    "number": "0",
    "meta_data": [
        {
            "id": 101336,
            "key": "fslm_json_license_details",
            "value": "license-key"
        }
    ],
    "line_items": [
        {
            "id": 3,
            "name": "Software License",
            "product_id": 3,
            "variation_id": 0,
            "quantity": 2,
            "tax_class": "",
            "subtotal": "9.98",
            "subtotal_tax": "1.90",
            "total": "9.98",
            "total_tax": "1.90",
            "taxes": [
                {
                    "id": 7,
                    "total": "1.8962",
                    "subtotal": "1.8962"
                }
            ],
            "meta_data": [
            ],
            "sku": "",
            "price": 4.99,
            "image": {
                "id": "4",
                "src": "url"
            },
            "parent_name": null
        }
    ],
    "tax_lines": [
        {
            "id": 5,
            "rate_code": "DE-MWST.-1",
            "rate_id": 7,
            "label": "MwSt.",
            "compound": false,
            "tax_total": "1.90",
            "shipping_tax_total": "0.00",
            "rate_percent": 19,
            "meta_data": []
        }
    ],
    "payment_url": "pay-for-order-url",
    "currency_symbol": "€",
    "stores": [
        {
            "id": 6,
            "name": "Software seller",
            "shop_name": "ISV GmbH",
            "url": "https://flecs.tech/branch/isv/",
            "address": {
                "street_1": "Road 2",
                "street_2": "",
                "city": "Software City",
                "zip": "76543",
                "country": "DE",
                "state": "DE-BY"
            }
        }
    ],
    "store": {
        "id": 6,
        "name": "Software seller",
        "shop_name": "ISV GmbH",
        "url": "https://flecs.tech/branch/isv/",
        "address": {
            "street_1": "Road 2",
            "street_2": "",
            "city": "Software City",
            "zip": "76543",
            "country": "DE",
            "state": "DE-BY"
        }
    },
    "_links": {
    }
}