Authentication
All requests require a valid API token.
Include your token in your request headers, as Authorization: Bearer {token}
(without the curly braces).
To generate the token use /api/Authenticate/Login/login endpoint
The basic schema request is
{
"username": string
"password": string
}
'https://localhost:7135/api/Authenticate/Login/login' \
--header 'accept: */*' \
--header 'Content-Type: application/json' \
--data-raw '{ "username": "string", "password": "string" }'
Endpoints and requests
Our REST API endpoints are organized by resource type. You'll need to use different endpoints depending on your app's requirements.
All REST API endpoints follow this pattern:
https://api.bllix.com/{resource}
Dates
The API uses ISO 8601 for all dates. All dates returned from the API have both the date and time set, and are always in UTC. For example:
2025-01-31T18:30:20ZWe recommend that you follow the same pattern when sending dates to the API. For example, to filter a list of orders for a given date:
/api/order/getorders?filters[updated:gte]=2025-01-01T00:00:00Z&filters[updated:lt]=2025-01-02T00:00:00Z
...will return all orders whose updated date is January 1st 2025 in UTC, regardless
of the
time.
If you need to filter based on a different timezone, we recommend doing the timezone conversion on your end, before passing it to the API filters. For example, to apply the above filter based on EST, convert the start and end of the day from EST to UTC:
/api/order/getorders?filters[updated:gte]=2024-12-31T19:00:00Z&filters[updated:lt]=2025-01-01T19:00:00Z
...will return all orders whose updated date is January 1st 2025 in EST, regardless
of the
time.
Filters
Many list endpoints, which are accessed via a GET request to the root of the
resource (such as /orders), include support for passing along filters to narrow
down the results. This section describes how filters work in general. Refer to the documentation
for each resource to see the available filters for each specific endpoint.
-
The
filtersquery - All filters should be passed in via thefiltersquery parameter. For example:/api/order/getorders?filters[status]=shipped...will only return orders whose
statusisshipped. -
Multiple filters - To use multiple filters, you may set multiple fields on the
filterskey. For example:/api/order/getorders?filters[status]=shipped&filters[order.id]=123...will return orders whose
statusisshipped, but only if itsorderidis also123. -
Multiple values - To filter for multiple values in the same field, you may set the same field multiple times to a different value. For example:
/api/order/getorders?filters[status]=shipped&filters[status]=ready_for_pickup...will return orders whose
statusis eithershippedorready_for_pickup. -
Nested fields - To filter based on a nested field, you can use "dot notation" as the key. For example:
/api/order/getorders?filters[order.id]=123...will return orders whose order id is
123. -
Operators - In addition to regular key/value filters, many fields also support supplying an operator for the filter. For example:
/api/order/getorders?filters[status:not]=shipped...will only return orders whose
statusis notshipped.As you can see, operators are supplied as part of the key, separated from the field by a
:(colon). Here is a list of operators and their meaning:Operator Meaning eqEquals (Default) notNot equals gtGreater than ltLess than gteGreater than or equal to lteLess than or equal to For additional examples of operator usage, review the section on dates .
Support for these operators varies by endpoint and field type. As mentioned, refer to the documentation of each endpoint to see the list of supported filters and operators.
Pagination
All list pages, which are accessed via a GET request to the root of the
resource (such as /api/order/getorders?pageN0=1&size=30), return their data as
paginated chunks.Bydefault pageNumber is 1 and pageSize is 30 .The basic schema
for the response is:
{
"data": [/* ... */]
}
The actual chunk of records is returned in an array under the data property.
Rate Limits
Every endpoint in the API is rate limited, to prevent abuse and keep the API available to all users.
All REST API responses include X-Rate-Limit headers, which show how many requests
the client has made, and the total number allowed per minute.
When the limit has been exceeded, a 429 HTTP response code will be returned. It
will
also include a Retry-After header with the number of seconds to wait until retrying
your request.
Status and error codes
401 Unauthorized
The client doesn't have correct authentication credentials.
403 Forbidden
The client doesn't have the correct permissions for the given endpoint.
404 Not Found
The requested resource was not found.
422 Unprocessable Entity
The request body contains semantic errors, or doesn't pass validation. This is typically caused by incorrect formatting, omitting required fields, or logical errors such as attempting to ship an order that's already shipped.
HTTP/1.1 422 Unprocessable Entity
{
"message": "The given data is invalid",
"errors": [
"name": [
"Name required"
]
]
}
429 Too Many Requests
The client has exceeded the rate limit.
HTTP/1.1 429 Too Many Requests
{
"message": "API rate limit exceeded. See the rate-limiting section in our API documentation.",
"retry_after_seconds": 7.8832487
}
503 Service Unavailable
The Bllix API is temporarily unavailable, for scheduled maintenance.
5xx Errors
An internal error occurred in Bllix.
listings
The listings resource represents sales listings.
List listings
get /listings|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Listings
[
{
"id": 0,
"isDeleted": false,
"createdDate": "2022-10-21T09:31:27.909Z",
"updatedDate": "2022-10-21T09:31:27.909Z",
"clientListingId": "string",
"listingName": "string",
"merchantSKU": "string",
"clientsId": 0,
"isMultiItem": true,
"createdBy": "string",
"modifiedBy": "string",
"upc": "string",
"asin": "string",
"packOf": 0,
"jobDescription": "string",
"imagePath": "string",
"totalItem": 0,
"isLabeling": true,
"labelingBarcode": "string",
"labelingType": "string",
"fnsku": "string",
}
]
Curl request for listings
curl --location --request GET'https://api.bllix.com/api/Listing/GetListing' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single listing
get /api/Listing/GetListingById?{Id}path Parameters
|
Id
required
|
string
The internal ID for the listing. |
The response schema for Listing
{
"id": 0,
"isDeleted": false,
"createdDate": "2022-10-21T09:31:27.909Z",
"updatedDate": "2022-10-21T09:31:27.909Z",
"clientListingId": "string",
"listingName": "string",
"merchantSKU": "string",
"clientsId": 0,
"isMultiItem": true,
"createdBy": "string",
"modifiedBy": "string",
"upc": "string",
"asin": "string",
"packOf": 0,
"jobDescription": "string",
"imagePath": "string",
"totalItem": 0,
"isLabeling": true,
"labelingBarcode": "string",
"labelingType": "string",
"fnsku": "string",
}
Curl request for listing by id
curl --location --request GET'https://api.bllix.com/api/Listing/GetListingById?Id=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
orders
The orders resource represents sales orders. Orders are generally imported directly from the channels, but may have also been entered manually, or uploaded from a file. No matter the source, Bllix standardizes the orders so they all look the same.
List orders
get /ordersquery Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Orders
[
{
"orderid": "string",
"purchased": "2023-12-22T11:44:20.556Z",
"updated": "2023-12-22T11:44:20.556Z",
"status": "string",
"sku": "string",
"asin": "string",
"qty": 0,
"currency": "string",
"price": 0,
"tax": 0,
"shipping": 0,
"stax": 0,
"gift": 0,
"gtax": 0,
"discount": 0,
"sdiscount": 0,
"account": "string",
"timeadj": true,
"channel": "string",
"shipbymerch": true,
"isbsns": true,
"poid": "string"
}
]
Curl request for orders
curl --location --request GET'https://api.bllix.com/api/Order/GetOrders' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single order
get /api/Order/GetOrderById?{Id}path Parameters
|
Id
required
|
string
The internal ID for the order. |
The response schema for Order
{
"orderid": "string",
"purchased": "2023-12-22T11:44:20.556Z",
"updated": "2023-12-22T11:44:20.556Z",
"status": "string",
"sku": "string",
"asin": "string",
"qty": 0,
"currency": "string",
"price": 0,
"tax": 0,
"shipping": 0,
"stax": 0,
"gift": 0,
"gtax": 0,
"discount": 0,
"sdiscount": 0,
"account": "string",
"timeadj": true,
"channel": "string",
"shipbymerch": true,
"isbsns": true,
"poid": "string"
}
Curl request for order by id
curl --location --request GET'https://api.bllix.com/api/Order/GetOrderById?Id=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List orders
get /ordersquery Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Orders
[
{
"orderid": "string",
"purchased": "2023-12-22T11:44:20.556Z",
"updated": "2023-12-22T11:44:20.556Z",
"status": "string",
"sku": "string",
"asin": "string",
"qty": 0,
"currency": "string",
"price": 0,
"tax": 0,
"shipping": 0,
"stax": 0,
"gift": 0,
"gtax": 0,
"discount": 0,
"sdiscount": 0,
"account": "string",
"timeadj": true,
"channel": "string",
"shipbymerch": true,
"isbsns": true,
"poid": "string"
}
]
Curl request for orders
curl --location --request GET'https://api.bllix.com/api/Order/GetOrders' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List shipped orders
get /ordersResponses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
ShippedOrder
]
|
The response schema for Orders
[
{
"cust_ref": "string"
}
]
Curl request for orders
curl --location --request GET'https://api.bllix.com/api/Order/GetShippedOrders' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
products
The Products resource represents products in your catalog.
Products come in 3 different types:
-
standard- A regular product, with inventory and recorded costs. -
group- A virtual product, which is a grouping of other products. The product'schildrenproperty holds the "recipe" that forms this group, including the quantities for each child.Groups have no inventory of their own, and no associated costs of their own. They're merely a way to group products together to easily sell them as a single bundle.
-
kit- A product that can be assembled from other products, and disassembled back into those products. The product'schildrenproperty holds the "recipe" that forms this kit, including the quantities for each child.Kits have their own inventory and recorded cost, just like standard products. When assembling or disassembling a kit (using productions), the inventory and cost is automatically moved between the kit and its children.
List products
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Products
[
{
"id": 0,
"createdDate": "2022-10-21T09:35:13.672Z",
"updatedDate": "2022-10-21T09:35:13.672Z",
"createdBy": "string",
"modifiedBy": "string",
"itemName": "string",
"itemsNumber": "string",
"sku": "string",
"upc": "string",
"isActive": true,
"clientItemId": "string",
"upcNotAvailable": true,
"isExpirationDate": true,
"allocatedQty": 0,
"backOrderQty": 0,
"weight": 0,
"height": 0,
"width": 0,
"onHand": 0,
"available": 0
}
]
Curl request for products
curl --location --request GET'https://api.bllix.com/api/Product/GetProducts?pageNo=1&size=30' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single product
get /api/Product/GetProducts?{Id}path Parameters
|
Id
required
|
string
The internal ID for the product. |
The response schema for Product
{
"id": 0,
"createdDate": "2022-10-21T09:35:13.672Z",
"updatedDate": "2022-10-21T09:35:13.672Z",
"createdBy": "string",
"modifiedBy": "string",
"itemName": "string",
"itemsNumber": "string",
"sku": "string",
"upc": "string",
"isActive": true,
"clientItemId": "string",
"upcNotAvailable": true,
"isExpirationDate": true,
"allocatedQty": 0,
"backOrderQty": 0,
"weight": 0,
"height": 0,
"width": 0,
"onHand": 0,
"available": 0
}
Curl request for product by id
curl --location --request GET'https://api.bllix.com/api/Product/GetProductById?Id=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Create Inbound Orders
The request schema for Create Product
{
"id":0,
"CreatedDate": "2020-10-21T09:35:13.672Z",
"ExpirationDate":"2020-10-21T09:35:13.672Z",
"CreatedBy": "string",
"ModifiedBy": "string",
"ItemName": "string", [required]
"ItemsNumber": "string",
"SKU": "string", [required]
"UPC": "string", [required]
"ClientItemId": "string",
"UPCNotAvailable": true,
"IsExpirationDate": true,
"AllocatedQty": 0,
"BackOrderQty": 0,
"Weight": 0,
"Height": 0,
"Width": 0
}
Curl request for create update inbound order
curl --location --request POST'https://api.bllix.com/api/Product/CreateUpdateProduct' \
--header 'accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ token }}' \
--data '{ "id":115421, "CreatedDate": "2022-10-21T09:35:13.672Z", "ExpirationDate":"2023-10-21T09:35:13.672Z", "CreatedBy": "Marko Bender", "ModifiedBy": "Marko Bender", "ItemName": "Item name updated", "ItemsNumber": "12345", "SKU": "string11", "UPC": "string", "ClientItemId": "ClientItem123123", "UPCNotAvailable": false, "IsExpirationDate": true, "AllocatedQty": 150, "BackOrderQty": 10, "Weight": 1.55, "Height": 10.55, "Width": 5.0 }'
Responses
Response Schema:
application/json
application/json
text/json
|
object
|
shipments
The shipments resource represents shipments in your catalog.
List shipments
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Shipments
[
{
"id": "string",
"name": "string",
"account": 0,
"status": "string",
"address": "string",
"cases": true,
"destination": "string",
"date": "2022-10-21T09:36:37.590Z",
"boxcontent": "string",
"iboid": "string"
}
]
Curl request for shipments
curl --location --request GET'https://api.bllix.com/api/Shipment/GetShipments?pageNo=1&size=30' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single shipments
get /api/Shipment/GetShipmentById?{Id}path Parameters
|
Id
required
|
string
The internal ID for the shipments. |
The response schema for Shipment
{
"id": "string",
"name": "string",
"account": 0,
"status": "string",
"address": "string",
"cases": true,
"destination": "string",
"date": "2022-10-21T09:36:37.590Z",
"boxcontent": "string",
"iboid": "string"
}
Curl request for shipment by id
curl --location --request GET'https://api.bllix.com/api/Shipment/GetShipmentById?Id=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Inbound Orders
The inbound resource represents inbound orders in your catalog.
List Inbound Orders
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Inbound Orders
[
{
"id": 0,
"shipmentCompanyName": "string",
"shipperName": "string",
"carrierName": "string",
"comments": "string",
"expectedDateArrival": "2023-12-22T11:25:32.885Z",
"quantity": 0,
"containerTypeId": 0,
"poNumber": "string",
"supplierId": 0,
"clientInboundOrderId": "string",
"unApproveComment": "string",
"bol": "string",
"checkInDate": "2023-12-22T11:25:32.885Z",
"receivedDate": "2023-12-22T11:25:32.885Z",
"reviewComments": "string",
"orderApprovedDate": "2023-12-22T11:25:32.885Z",
"createdBy": "string",
"modifiedBy": "string",
"ioItemsVM": [
{
"sku": "string",
"expectedBoxes": 0,
"expectedTotalQty": 0,
"expectedPcsPerBox": 0,
"receivedBoxes": 0,
"receivedTotalQty": 0,
"receivedPcsPerBox": 0
}
],
"trackingNumbers": [
{
"id": 0,
"carrierId": 0,
"trackingNumber": "string",
"quantity": 0,
"packageTypeId": 0,
"packageType": "string",
"carrierName": "string",
"expectedDateArrival": "2023-12-22T11:25:32.885Z"
}
]
}
]
Curl request for inbound orders
curl --location --request GET'https://api.bllix.com/api/InboundOrder/GetInboundOrders?pageNo=1&size=30' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single inbound order
get /api/InboundOrder/GetInboundOrderByInboundOrderId?{InboundOrderId=123}path Parameters
|
InboundOrderId
required
|
long
The ID for the inbound order. |
The response schema for Inbound Order
{
"id": 0,
"shipmentCompanyName": "string",
"shipperName": "string",
"carrierName": "string",
"comments": "string",
"expectedDateArrival": "2023-12-22T11:25:32.885Z",
"quantity": 0,
"containerTypeId": 0,
"poNumber": "string",
"supplierId": 0,
"clientInboundOrderId": "string",
"unApproveComment": "string",
"bol": "string",
"checkInDate": "2023-12-22T11:25:32.885Z",
"receivedDate": "2023-12-22T11:25:32.885Z",
"reviewComments": "string",
"orderApprovedDate": "2023-12-22T11:25:32.885Z",
"createdBy": "string",
"modifiedBy": "string",
"ioItemsVM": [
{
"sku": "string",
"expectedBoxes": 0,
"expectedTotalQty": 0,
"expectedPcsPerBox": 0,
"receivedBoxes": 0,
"receivedTotalQty": 0,
"receivedPcsPerBox": 0
}
],
"trackingNumbers": [
{
"id": 0,
"carrierId": 0,
"trackingNumber": "string",
"quantity": 0,
"packageTypeId": 0,
"packageType": "string",
"carrierName": "string",
"expectedDateArrival": "2023-12-22T11:25:32.885Z"
}
]
}
Curl request for inbound order by id
curl --location --request GET'https://api.bllix.com/api/InboundOrder/GetInboundOrderById?InboundOrderId=123&ClientId=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List InboundOrderType
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for InboundOrderType
[
{
"id": 0,
"name": "string",
"type": 0,
"description": "string"
}
]
Curl request for inbound order type
curl --location --request GET'https://api.bllix.com/api/InboundOrder/GetInboundOrderType' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List Supplier
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Supplier
[
{
"isDeleted": true,
"createdDate": "2023-12-22T11:28:59.577Z",
"updatedDate": "2023-12-22T11:28:59.577Z",
"createdBy": "string",
"modifiedBy": "string",
"id": 0,
"supplierId": 0,
"clientSupplierId": "string",
"clientsId": 0,
"shipperCompanyName": "string",
"shipperName": "string",
"supplierType": "string",
"supplierPhone": "string",
"supplierEmail": "string",
"addressID": 0
}
]
Curl request for supplier
curl --location --request GET'https://api.bllix.com/api/InboundOrder/GetSupplier?pageNo=1&size=30' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Create Inbound Orders
The request schema for Create Inbound Order
{
"id": 0,
"shipmentCompanyName": "string", [required]
"shipperName": "string",
"carrierName": "string",
"comments": "string",
"expectedDateArrival": "2023-12-22T11:35:09.958Z",
"quantity": 0,
"containerTypeId": 0,
"orderType": 0, [required]
"poNumber": "string",
"supplierName": "string", [required]
"isAllItems": true,
"insertOrderFrom": 0,
"unApproveComment": "string",
"bol": "string",
"internalComment": "string",
"checkInDate": "2023-12-22T11:35:09.958Z",
"receivedDate": "2023-12-22T11:35:09.958Z",
"partiallyReceivedDate": "2023-12-22T11:35:09.958Z",
"invoiceNo": "string",
"changeDescription": "string",
"ioItemsVM": [required][
{
"itemId": 0, [required]
"sku": "string", [required]
"totalPieces": 0,
"qtyPiecesPerBox": 0,
"qtyBoxes": 0,
"receivedQtyPiecesPerBox": 0
}
],
"supplierDetail": [
{
"shipperName": "string",
"email": "string",
"shipperCompanyName": "string"
}
],
"trackingNumbers": [required] [
{
"carrierId": 0,
"trackingNumber": "string" [required],
"quantity": 0,
"packageTypeId": 0,
"packageType": "string" [required],
"carrierName": "string" [required],
"expectedDateArrival": "2023-12-22T11:35:09.958Z" [required]
}
]
}
Curl request for create update inbound order
curl --location --request POST'https://api.bllix.com/api/InboundOrder/CreateUpdateInboundOrder' \
--header 'accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ token }}' \
--data '{ "id": 0, "shipmentCompanyName": "string", "shipperName": "string", "carrierName": "string", "comments": "string", "expectedDateArrival": "2023-12-22T11:35:09.958Z", "quantity": 0, "containerTypeId": 0, "orderType": 0, "poNumber": "string", "supplierName": "string", "isAllItems": true, "insertOrderFrom": 0, "unApproveComment": "string", "bol": "string", "internalComment": "string", "checkInDate": "2023-12-22T11:35:09.958Z", "receivedDate": "2023-12-22T11:35:09.958Z", "partiallyReceivedDate": "2023-12-22T11:35:09.958Z", "invoiceNo": "string", "changeDescription": "string", "ioItemsVM": [ { "itemId": 0, "sku": "string", "totalPieces": 0, "qtyPiecesPerBox": 0, "qtyBoxes": 0, "receivedQtyPiecesPerBox": 0 } ], "supplierDetail": [ { "shipperName": "string", "email": "string", "shipperCompanyName": "string" } ], "trackingNumbers": [ { "carrierId": 0, "trackingNumber": "string", "quantity": 0, "packageTypeId": 0, "packageType": "string" , "carrierName": "string" , "expectedDateArrival": "2023-12-22T11:35:09.958Z" } ] }'
Responses
Response Schema:
application/json
application/json
text/json
|
object
|
List Items
path Parameters
| SupId |
long
The ID's for the item list. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Items
[
{
"id": 0,
"clientItemId": "string",
"itemName": "string",
"itemsNumber": "string",
"sku": "string",
"upc": "string",
"isActive": true,
"allocatedQty": 0,
"backOrderQty": 0,
"weight": 0,
"length": 0,
"width": 0,
"height": 0,
"itemImage": "string",
"sortBy": 0,
"createdDate": "2023-12-22T11:41:55.771Z"
}
]
Curl request for list items
curl --location --request GET'https://api.bllix.com/api/InboundOrder/GetItemList?SupId=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{token}}'
Outbound Orders
The outbound resource represents outbound orders in your catalog.
List Outbound Orders
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Outbound orders
[
{
"id": 0,
"fbaShipmentId": "string",
"amazonLocationId": 0,
"packageTypeId": 0,
"shipmentTypeId": 0,
"shipmentName": "string",
"orderLeadtimeId": 0,
"amazonReferenceId": "string"
"poNumber": "string",
"comments": "string",
"status": 0,
"shiptoName": "string",
"clientOutboundOrderId": "string",
"unApproveComment": "string"
"bol": "string",
"boxesUsed": "string",
"quantity": 0,
"totalBoxes": 0,
"weightDimensions": "string",
"trackingNo": "string",
"truckingBroker": "string",
"truckingRefNo": "string",
"dateAddWeight": "2022-10-21T09:45:46.549Z",
"shippingBy": 0,
"fullAddress": "string",
"clientComments": "string",
"palletsFileName": "string",
"palletsFilePath": "string",
"orderCompletedDate": "2022-10-21T09:45:46.550Z",
"orderShippedDate": "2022-10-21T09:45:46.550Z",
"orderSubmittedDate": "2022-10-21T09:45:46.550Z",
"orderNewDate": "2022-10-21T09:45:46.550Z",
"orderReadyToShipDate": "2022-10-21T09:45:46.550Z",
"orderPreparedDate": "2022-10-21T09:45:46.550Z",
"orderApprovedDate": "2022-10-21T09:45:46.550Z",
"reviewComments": "string",
"createdDate": "2022-10-21T09:45:46.550Z",
"updatedDate": "2022-10-21T09:45:46.550Z",
"outBoundOrderListings": []
}
]
Curl request for outbound orders
curl --location --request GET'https://api.bllix.com/api/OutboundOrder/GetOutboundOrders?pageNo=1&size=30' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single outbound order
get /api/OutboundOrder/GetOutboundOrderByOutboundOrderId?{OutboundOrderId=123}path Parameters
|
OutboundOrderId
required
|
long
The ID for the outbound order. |
The response schema for Outbound order
{
"id": 0,
"fbaShipmentId": "string",
"amazonLocationId": 0,
"packageTypeId": 0,
"shipmentTypeId": 0,
"shipmentName": "string",
"orderLeadtimeId": 0,
"amazonReferenceId": "string"
"poNumber": "string",
"comments": "string",
"status": 0,
"shiptoName": "string",
"clientOutboundOrderId": "string",
"unApproveComment": "string"
"bol": "string",
"boxesUsed": "string",
"quantity": 0,
"totalBoxes": 0,
"weightDimensions": "string",
"trackingNo": "string",
"truckingBroker": "string",
"truckingRefNo": "string",
"dateAddWeight": "2022-10-21T09:45:46.549Z",
"shippingBy": 0,
"fullAddress": "string",
"clientComments": "string",
"palletsFileName": "string",
"palletsFilePath": "string",
"orderCompletedDate": "2022-10-21T09:45:46.550Z",
"orderShippedDate": "2022-10-21T09:45:46.550Z",
"orderSubmittedDate": "2022-10-21T09:45:46.550Z",
"orderNewDate": "2022-10-21T09:45:46.550Z",
"orderReadyToShipDate": "2022-10-21T09:45:46.550Z",
"orderPreparedDate": "2022-10-21T09:45:46.550Z",
"orderApprovedDate": "2022-10-21T09:45:46.550Z",
"reviewComments": "string",
"createdDate": "2022-10-21T09:45:46.550Z",
"updatedDate": "2022-10-21T09:45:46.550Z",
"outBoundOrderListings": [
{
"id": 0,
"createdBy": "string",
"modifiedBy": "string",
"outBoundOrderId": 0,
"listingId": 0,
"merchantSKU": "string",
"status": 0,
"quantity": 0,
"listingNotes": "string",
"quantityCompleted": 0,
"quantityDifference": 0,
"damagedQty": 0,
"extraQty": 0,
"quantityDiffReason": 0,
"printlabelQuantity": 0,
"printerId": 0,
"amount": 0.00,
"price": 0.00,
"expirationLabelDate": "2022-10-21T09:45:46.550Z",
"jobTypes": "string"
}
]
}
Curl request for outbound order by id
curl --location --request GET'https://api.bllix.com/api/OutboundOrder/GetOutboundOrderByOutboundOrderId?OutboundOrderId=123&ClientId=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List ShipmentType
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for ShipmentType
[
{
"id": 0,
"name": "string",
"type": 0,
"description": "string"
}
]
Curl request for shipment type
url --location --request GET'https://api.bllix.com/api/OutboundOrder/GetShipmentTypeRecord' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List Order LeadTime
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for OrderLeadTime
[
{
"id": 0,
"name": "string",
"type": 0,
"description": "string"
}
]
Curl request for order lead time
curl --location --request GET'https://api.bllix.com/api/OutboundOrder/GetOrderLeadTimeRecord' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List Order Package
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for PackageType
[
{
"id": 0,
"name": "string",
"type": 0,
"description": "string"
}
]
Curl request for order package type
curl --location --request GET'https://api.bllix.com/api/OutboundOrder/GetOrderPackageRecord' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
List Location
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Location
[
{
"id": 0,
"code": "string",
"address": "string",
"streetAddress1": "string",
"streetAddress2": "string",
"state": "string",
"zip": "string",
"country": "string",
"latitude": "string",
"longitude": "string",
"county": "string",
"fullAddress": "string",
"city": "string",
"lpId": 0,
"status": "string"
}
]
Curl request for location
curl --location --request GET'https://api.bllix.com/api/OutboundOrder/GetLocations' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Create Outbound Orders
The request schema for Create Outbound Order
{
"id":0,
"outboundOrderId": 0,
"fbaShipmentId": "string",
"amazonLocationCode": "string",
"packageType":"string", [required if packageTypeId is 0 or null]
"packageTypeId": 0,
"shipmentName": "string", [required if shipmentTypeId is 0 or null]
"shipmentTypeId": 0,
"orderLeadTime": "string" [required if orderLeadtimeId is 0 or null]
"orderLeadtimeId": 0,
"amazonReferenceId": "string",
"comments": "string",
"shiptoName": "string",
"shippingBy": 0,
"fullAddress": "string",
"clientComments": "string",
"palletsFileName": "string",
"palletsFilePath": "string",
"outBoundOrderListings": [
{
"quantity": 0,
"listingNotes": "string",
"expirationLabelDate": "2022-10-19T12:18:28.038Z",
"boxlimit": 0,
"merchantSKU" : "string"
}
] [required]
}
Curl request for create outbound order
curl --location --request POST'https://api.bllix.com/api/OutboundOrder/CreateUpdateOutboundOrder' \
--header 'accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ token }}' \
--data '{ "id":0, "outboundOrderId": 0, "fbaShipmentId": "string", "amazonLocationCode": "string", "packageType":"string", "packageTypeId": 0, "shipmentTypeId": 0, "shipmentName": "string", "orderLeadtimeId": 0, "amazonReferenceId": "0", "comments": "string", "shiptoName": "string", "shippingBy": 0, "fullAddress": "string", "clientComments": "string", "palletsFileName": "string", "palletsFilePath": "string", "outBoundOrderListings": [ { "quantity": 0, "listingNotes": "string", "expirationLabelDate": "2022-10-19T12:18:28.038Z", "boxlimit": 0, "merchantSKU" : "string" } ], "modifiedBy": "string", "createdBy": "string" }'
Responses
Response Schema:
application/json
application/json
text/json
|
object
|
Fullfillment Orders
The fullfillment resource represents fullfillment orders in your catalog.
List Fullfillment Orders
query Parameters
|
object
Refer to the general filters section for details on how to use these filters. |
Responses
Response Schema:
application/json
application/json
text/json
|
Array of
objects
[
items
]
|
The response schema for Fullfillment orders
[
{
"id": 0,
"cust_ref": "string",
"clientId": 0,
"addressId": 0,
"method": 0,
"totalCost": 0,
"orderSource": "string",
"orderStatus": "string",
"updatedOrderStatus": "string",
"shipCode": "string",
"custCompany": "string",
"custFirstName": "string",
"custLastName": "string",
"height": 0,
"length": 0,
"weight": 0,
"syncCartId": 0,
"latestShipDate": "2022-10-21T09:48:18.944Z",
"marketplaceOrderStatus": "string",
"labelStatus": "string",
"onHoldDate": "2022-10-21T09:48:18.944Z",
"awaitingShippingDate": "2022-10-21T09:48:18.944Z",
"shipMethod": "string",
"order_number": "string",
"giftFlag": "string",
"giftMessage": "string",
"internalNotes": "string",
"notesfromBuyer": "string",
"notestoBuyer": "string",
"predefinedPackage": "string",
"trackingNumber": "string",
"boxTypeId": 0,
"referenceNumber": "string",
"rateService": "string",
"batchId": 0,
"shippingAddress": {
"isDeleted": true,
"createdDate": "2022-10-21T09:48:18.944Z",
"updatedDate": "2022-10-21T09:48:18.944Z",
"createdBy": "string",
"modifiedBy": "string",
"deletedBy": "string",
"deletedDate": "2022-10-21T09:48:18.944Z",
"id": 0,
"addressOne": "string",
"addressTwo": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"addessType": 1,
"country": "string",
"cust_Ref": "string",
"shipCompany": "string",
"isAddressValid": true,
"isAddressVerified": true
}
}
]
Curl request for fullfillment orders
curl --location --request GET'https://api.bllix.com/api/FullfillmentOrder/GetFullfillmentOrders' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Fetch single fullfillment order
GET /api/FullfillmentOrder/GetFullfillmentOrderById?{Id}path Parameters
|
Id
required
|
long
The Id for the fullfillment order. |
The response schema for Fullfillment orders
{
"id": 0,
"cust_ref": "string",
"clientId": 0,
"addressId": 0,
"method": 0,
"totalCost": 0,
"orderSource": "string",
"orderStatus": "string",
"updatedOrderStatus": "string",
"shipCode": "string",
"custCompany": "string",
"custFirstName": "string",
"custLastName": "string",
"height": 0,
"length": 0,
"weight": 0,
"syncCartId": 0,
"latestShipDate": "2022-10-21T09:48:18.944Z",
"marketplaceOrderStatus": "string",
"labelStatus": "string",
"onHoldDate": "2022-10-21T09:48:18.944Z",
"awaitingShippingDate": "2022-10-21T09:48:18.944Z",
"shipMethod": "string",
"order_number": "string",
"giftFlag": "string",
"giftMessage": "string",
"internalNotes": "string",
"notesfromBuyer": "string",
"notestoBuyer": "string",
"predefinedPackage": "string",
"trackingNumber": "string",
"boxTypeId": 0,
"referenceNumber": "string",
"rateService": "string",
"batchId": 0,
"shippingAddress": {
"isDeleted": true,
"createdDate": "2022-10-21T09:48:18.944Z",
"updatedDate": "2022-10-21T09:48:18.944Z",
"createdBy": "string",
"modifiedBy": "string",
"deletedBy": "string",
"deletedDate": "2022-10-21T09:48:18.944Z",
"id": 0,
"addressOne": "string",
"addressTwo": "string",
"city": "string",
"state": "string",
"zipCode": "string",
"addessType": 1,
"country": "string",
"cust_Ref": "string",
"shipCompany": "string",
"isAddressValid": true,
"isAddressVerified": true
}
}
Curl request for fullfillment order by id
curl --location --request GET'https://api.bllix.com/api/FullfillmentOrder/GetFulFillmentOrderById?Id=123' \
--header 'accept: text/plain' \
--header 'Authorization: Bearer {{ token }}'
Create Fullfillment Orders
The request schema for Create Fullfillment Order
{
"tokenId": 0,[required]
"addressId": 0,
"tokenType": 1,[required]
"cust_ref": "string",
"ship_company": "string",[required]
"ship_address_1": "string",[required]
"ship_address_2": "string",
"ship_city": "string",[required]
"ship_state": "string",[required]
"ship_zip": "string",[required]
"ship_country": "string",[required]
"orderSource": "string",
"orderStatus": "string",
"ship_is_billing": true,
"items": [
{
"id": 0,
"clientId": 0,
"listingId": 0,[required]
"item": "string",
"quantity": 0,[required]
"price": 0,
"extended_amount": 0
}
],
"token": "string",
"referenceNumber": "string",
"verified": true,
"giftMessage": "string",
"isGiftMessage": true
}
Curl request for create fullfillment order
curl --location --request POST'https://api.bllix.com/api/FullfillmentOrder/CreateUpdateFullfillmentOrder' \
--header 'accept: text/plain' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{ token }}' \
--data-raw '{ "tokenId": 0, "addressId": 0, "tokenType": 1, "cust_ref": "string", "ship_company": "string", "ship_address_1": "string", "ship_address_2": "string", "ship_city": "string", "ship_state": "string", "ship_zip": "string", "ship_country": "string", "orderSource": "string", "orderStatus": "string", "ship_is_billing": true, "items": [ { "id": 0, "clientId": 0, "listingId": 0, "item": "string", "quantity": 0, "price": 0, "extended_amount": 0 } ], "token": "string", "referenceNumber": "string", "verified": true, "giftMessage": "string", "isGiftMessage": true }'
Responses
Response Schema:
application/json
application/json
text/json
|
object
|