--- title: Get Order Sync Job Status slug: get-order-sync-job-status docTags: createdAt: 2026-08-25T19:28:59.170Z --- { "id": "V1Jjg_HRfisfqCT7xTQ2g", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.nue.io/billing/orders/sync-jobs/{jobId}", "servers": [ { "url": "https://api.nue.io/billing/orders/sync-jobs/{jobId}", "description": "Nue Production API Endpoint" }, { "url": "https://api.sandbox.nue.io/billing/orders/sync-jobs/{jobId}", "description": "Nue Sandbox API Endpoint" } ], "name": "Get Order Sync Job Status", "description": "Retrieve the status of the order sync job.", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "jobId", "type": "string", "description": "The sync job ID. " } ], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json", "*/*" ], "default": "application/json" } ], "queryParameters": [], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKeyAuth", "name": "nue-api-key", "kind": "optional", "type": "apiKey", "in": "header" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Order sync job status", "jsonExample": "", "isExpanded": true, "subExamples": [ { "label": "GENERATED", "code": "// Order sync job status\n{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"scheduleId\": \"\",\n \"type\": \"\",\n \"parameters\": {\n \"graphqlFilter\": \"\"\n },\n \"status\": \"\",\n \"sourceRecords\": \"\",\n \"targetRecords\": \"\",\n \"recordsToSync\": \"\",\n \"recordsProcessed\": \"\",\n \"batchSize\": \"\",\n \"totalBatches\": \"\",\n \"batchesProcessed\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n}" }, { "label": "Batch sync orders job response", "code": "{\n \"data\": {\n \"id\": \"14e4dae9-6bb4-4158-9146-216881834b04\",\n \"name\": \"\",\n \"scheduleId\": \"\",\n \"type\": \"Order\",\n \"parameters\": {\n \"graphqlFilter\": \"{_and: [{customerId: {_eq: \\\"0016s00000cPEgZAAB\\\"}}]}\"\n },\n \"status\": \"Completed\",\n \"sourceRecords\": 1,\n \"targetRecords\": 0,\n \"recordsToSync\": 1,\n \"recordsProcessed\": 1,\n \"batchSize\": 200,\n \"totalBatches\": 1,\n \"batchesProcessed\": 1,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 3,\n \"startTime\": 1685336050207,\n \"endTime\": 1685336053646\n }\n}" } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "OrderSyncJobResponse", "schema": [ { "name": "data", "kind": "optional", "type": "object", "description": "Sync orders job response", "modelRef": "#/components/schemas/SyncJobSyncJobParams", "customType": "SyncJobSyncJobParams", "schema": [ { "name": "id", "kind": "optional", "type": "string", "description": "The unique id of the current batch job", "format": "uuid" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the current batch job" }, { "name": "scheduleId", "kind": "optional", "type": "string", "description": "

The schedule Id if the current batch job is triggered by a scheduled job, this parameter is passed from the request

" }, { "name": "type", "kind": "optional", "type": "string", "description": "The object type to be synced" }, { "name": "parameters", "kind": "optional", "type": "object", "description": "

The additional parameters of the batch job, currently only ‘graphqlFilter’ is supported, set this parameter in the request if only filtered records need to be synced

", "modelRef": "#/components/schemas/SyncJobParams", "customType": "SyncJobParams", "schema": [ { "name": "graphqlFilter", "kind": "optional", "type": "string", "description": "" } ] }, { "name": "status", "kind": "optional", "type": "string", "description": "

The status of the current batch job, the available options are Queued, Processing, Completed, and Error.

", "enum": [ "Queued", "Processing", "Completed", "Failed" ] }, { "name": "sourceRecords", "kind": "optional", "type": "integer", "description": "The number of order records in Salesforce included in the current batch job", "format": "int64" }, { "name": "targetRecords", "kind": "optional", "type": "integer", "description": "The number of order records in Nue included in the current batch job", "format": "int64" }, { "name": "recordsToSync", "kind": "optional", "type": "integer", "description": "

The number of order records to be synced from Salesforce to Nue, this number indicates the records do not exist in Nue and need to be synced

", "format": "int64" }, { "name": "recordsProcessed", "kind": "optional", "type": "integer", "description": "The number of order records being processed in the current batch job", "format": "int64" }, { "name": "batchSize", "kind": "optional", "type": "integer", "description": "

The size of each batch in the current job, this parameter is passed from the request

", "format": "int64" }, { "name": "totalBatches", "kind": "optional", "type": "integer", "description": "The total number of batches in the current job", "format": "int64" }, { "name": "batchesProcessed", "kind": "optional", "type": "integer", "description": "The number of batches being processed in the current job", "format": "int64" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "The error code when the current job is completed with errors" }, { "name": "errorMessage", "kind": "optional", "type": "string", "description": "The error message details when the current job is completed with errors" }, { "name": "executionSeconds", "kind": "optional", "type": "integer", "description": "The execution time of the current job in seconds", "format": "int64" }, { "name": "startTime", "kind": "optional", "type": "integer", "description": "The start time of the current job", "format": "int64" }, { "name": "endTime", "kind": "optional", "type": "integer", "description": "The end time of the current job", "format": "int64" } ] } ], "modelRef": "#/components/schemas/OrderSyncJobResponse", "isExpanded": true } ] }, { "statusCode": "400", "description": "Bad Request", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "schema": [ { "name": "title", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "errorCode", "kind": "optional", "type": "string", "description": "" } ], "isExpanded": true } ] }, { "statusCode": "404", "description": "Not Found", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "aJC0rLp1VL5fQe52Vto52", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.nue.io/billing/orders/sync-jobs/{jobId} \\\n --header 'accept: application/json'" }, { "id": "WLAj0TnM8mmnAQSL0HwGK", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.nue.io/billing/orders/sync-jobs/{jobId}\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "Ixf8je3b4ixUj20HasKXg", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.nue.io/billing/orders/sync-jobs/{jobId}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "0McBD-rrT3-1SwDKS38jS", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.nue.io/billing/orders/sync-jobs/{jobId}\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "aJC0rLp1VL5fQe52Vto52" }, "results": { "languages": [ { "id": "IscCdfogzrXWZlHVkFFCS", "language": "200", "code": "// Order sync job status\n{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"scheduleId\": \"\",\n \"type\": \"\",\n \"parameters\": {\n \"graphqlFilter\": \"\"\n },\n \"status\": \"\",\n \"sourceRecords\": \"\",\n \"targetRecords\": \"\",\n \"recordsToSync\": \"\",\n \"recordsProcessed\": \"\",\n \"batchSize\": \"\",\n \"totalBatches\": \"\",\n \"batchesProcessed\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n}", "subExamples": [ { "label": "GENERATED", "code": "// Order sync job status\n{\n \"data\": {\n \"id\": \"\",\n \"name\": \"\",\n \"scheduleId\": \"\",\n \"type\": \"\",\n \"parameters\": {\n \"graphqlFilter\": \"\"\n },\n \"status\": \"\",\n \"sourceRecords\": \"\",\n \"targetRecords\": \"\",\n \"recordsToSync\": \"\",\n \"recordsProcessed\": \"\",\n \"batchSize\": \"\",\n \"totalBatches\": \"\",\n \"batchesProcessed\": \"\",\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": \"\",\n \"startTime\": \"\",\n \"endTime\": \"\"\n }\n}" }, { "label": "Batch sync orders job response", "code": "{\n \"data\": {\n \"id\": \"14e4dae9-6bb4-4158-9146-216881834b04\",\n \"name\": \"\",\n \"scheduleId\": \"\",\n \"type\": \"Order\",\n \"parameters\": {\n \"graphqlFilter\": \"{_and: [{customerId: {_eq: \\\"0016s00000cPEgZAAB\\\"}}]}\"\n },\n \"status\": \"Completed\",\n \"sourceRecords\": 1,\n \"targetRecords\": 0,\n \"recordsToSync\": 1,\n \"recordsProcessed\": 1,\n \"batchSize\": 200,\n \"totalBatches\": 1,\n \"batchesProcessed\": 1,\n \"errorCode\": \"\",\n \"errorMessage\": \"\",\n \"executionSeconds\": 3,\n \"startTime\": 1685336050207,\n \"endTime\": 1685336053646\n }\n}" } ] }, { "id": "0F2SZGDesdtJeyTX-CP3S", "language": "400", "code": "// Bad Request\n{\n \"title\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\"\n}" }, { "id": "hJD4ChQg3wEjjx_DzmwhJ", "language": "404", "code": "// Not Found\n" } ], "selectedLanguageId": "IscCdfogzrXWZlHVkFFCS" } }, "children": [ { "text": "" } ] }