Supported Formats

json

Errors

Code Description
401 Unauthorized. Include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403 Forbidden. The request was a valid request, but the server is refusing to respond to it. 403 error semantically means "unauthorized", i.e. the user does not have the necessary permissions for the resource.
404 Not Found. The requested resource could not be found.
422 Unprocessable Entity. The request was well-formed but was unable to be followed due to semantic errors.
500 Internal Server Error. An unexpected condition was encountered.

Examples

response:
{
  "id": 429,
  "request_id": "2e2b36a6-e6f7-42ae-a388-e53bfa2626be",
  "entity": "Category",
  "status": "complete",
  "percent_completed": 1,
  "operation": "insert",
  "created_at": "2016-05-30T14:55:57.316+10:00",
  "updated_at": "2016-05-30T14:55:58.671+10:00",
  "created_by": "test@fusionfactory.com",
  "error_count": 0,
  "result": "Success",
  "processing_details": [
    {
      "errors": [],
      "id": 327,
      "category": {
        ...
      }
    },
    {
      "_request_data_id": "7y3k9iuye6",
      "errors": [],
      "id": 330,
      "category": {
        ...
      }
    },
    {
      "errors": [],
      "id": 333,
      "category": {
        ...
      }
    }
  ]
}

processing_details:

id - the object ID generated by CommerceConnect. Save this ID in the client and use it to refer to the object in other APIs.
errors - errors during processing the job
_request_data_id - the same value passed in the payload. Use this value to identify the individual element if needed (for example, in the case of failing to create object)
%entity% - the hash version of the object. This is similar to the response from GET /api/v2/:entity . If this is not needed, we suggest to set job[options][object_in_response] to false when posting the job.



Params

Param name Description
id
optional

Job ID

Validations:

  • Must be a number.