Partner API

This API is REST API. You can get information from BSS: B2B Portal/Net Term through this API.

Contact us at email [e-mail] for the access key and more information related.

1. Net-terms orders

Get net-terms orders

GET https://b2b-customer-portal-api.bsscommerce.com/api/v1/nt/orders

Path Parameters

Name	Type	Description
access_key*	String
email	String	Use to filter orders by email
offset	Number	The order in which records start to be retrieved Positive number only Default value: 0
order_name	String	Use to filter orders by order name
limit	Number	Number of records to retrieve Positive number only Default value: 50

200: OK

401: Unauthorized

403: Forbidden

404: Not Found

Example:

• URL: https://b2b-customer-portal-api.bsscommerce.com/api/v1/nt/orders?access_key=123456XYZ&limit=7&offset=6

• Response

{
    "success": true,
    "statusCode": 200,
    "data": [
        {
            "id": 7,
            "shop_id": 1,
            "shopify_id": "1130928865586",
            "name": "#D444",
            "email": "[e-mail]",
            "shipping_address": "Hà nội Vietnam",
            "rule_id": 1,
            "rule_name": "Net terms",
            "order_type": 0,
            "createdAt": "2023-09-15T04:40:35.000Z",
            "order_status": "Open",
            "payment_status": null,
            "updatedAt": "2023-09-15T04:40:35.000Z",
            "net_terms": "Due on specific date",
            "remaining_days": "5 days"
        }
    ],
    "count": 1,
    "total": 7,
    "message": "Get orders successful"
}