Responses And Errors

Most sync APIs are bulk-oriented. A request can succeed at the request level while still returning row-level validation failures.

Response Patterns

Pattern	Meaning	Seen in
Full success	Every submitted row was accepted or queued.	Customer, Item, Employee
Partial success	Some rows were accepted; invalid rows are returned separately.	Customer, Item, Inventory, Order
Request validation error	The whole request is invalid, such as missing required array.	Update Order Status
Async queued	Valid rows are queued and processed later.	Employee Sync

Row-Level Error Collections

Field	Meaning
nonProcessableRows	Invalid rows in customer/employee-style bulk requests.
nonProcessableOrders	Invalid order rows in order processing.
nonProcessablesStocks	Invalid stock rows in inventory sync.
errors	Error messages or per-item failures, depending on endpoint.

info

For some bulk endpoints, the API may return only the first 20 invalid rows in the response. Use bulk upload logs for the full error list when failures exceed that limit.

Typical Partial Success Shape

Partial success response

{
  "error": false,
  "status": true,
  "statusCode": 200,
  "data": {
    "message": "Some rows failed",
    "processedCount": 0,
    "errorCount": 1,
    "errors": [
      {
        "row": 1,
        "itemName": "Item 1",
        "errors": ["items[1].itemName is required"]
      }
    ]
  }
}

Request-Level Error Examples

Scenario	Expected handling
Missing request body	Reject the request.
Invalid JSON	Return request-level validation error.
Missing required array	Return request-level validation error.
Unauthorized request	Return authentication error.

Troubleshooting Checklist

• Check whether the failure is request-level or row-level.
• For row-level errors, inspect the row, itemName, and errors fields.
• Fix source data before retrying failed rows.
• Retry only the corrected failed rows when possible.
• Check bulk upload logs when the response says errors were truncated.