Skip to content

BulkApi.md

Latest commit

 

History

History
277 lines (180 loc) · 11.2 KB

BulkApi.md

File metadata and controls

277 lines (180 loc) · 11.2 KB
Raw

BulkApi

All URIs are relative to https://secure.ultracart.com/rest/v2

Method HTTP request Description
bulkCancelJob DELETE /bulk/{object}/{job_id} Request cancellation of a bulk job
bulkGenerateUploadUrl POST /bulk/{object}/upload-url Generate a presigned upload URL for a bulk payload
bulkGetJob GET /bulk/{object}/{job_id} Retrieve a bulk job's status and counts
bulkGetJobRecords GET /bulk/{object}/{job_id}/records Paginate a bulk job's per-record results
bulkListJobs GET /bulk/{object} List bulk jobs for the calling merchant
bulkSubmitJob POST /bulk/{object} Submit a bulk job

bulkCancelJob

bulkCancelJob(_object, jobId)

Request cancellation of a bulk job

Queued jobs cancel immediately (200). In-progress jobs finalize as cancelled between records (202); already-processed records stand.

Example

(No example for this operation).

Parameters

Name Type Description Notes
_object String Object type
jobId String The bulk job id

Return type

null (empty response body)

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 -
202 -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

bulkGenerateUploadUrl

BulkUploadUrlResponse bulkGenerateUploadUrl(_object)

Generate a presigned upload URL for a bulk payload

Returns a presigned S3 PUT URL the merchant uploads NDJSON to, plus the s3_key to pass to submit.

Example

(No example for this operation).

Parameters

Name Type Description Notes
_object String Object type

Return type

BulkUploadUrlResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

bulkGetJob

BulkJobResponse bulkGetJob(_object, jobId)

Retrieve a bulk job's status and counts

Example

(No example for this operation).

Parameters

Name Type Description Notes
_object String Object type
jobId String The bulk job id

Return type

BulkJobResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

bulkGetJobRecords

BulkRecordsResponse bulkGetJobRecords(_object, jobId, status, cursor, limit)

Paginate a bulk job's per-record results

Example

(No example for this operation).

Parameters

Name Type Description Notes
_object String Object type
jobId String The bulk job id
status String Filter by per-record result status (success, failed, duplicate) [optional]
cursor String Opaque pagination cursor [optional]
limit Integer Page size (default 100, max 1000) [optional]

Return type

BulkRecordsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

bulkListJobs

BulkJobsResponse bulkListJobs(_object, status, cursor, limit)

List bulk jobs for the calling merchant

Example

(No example for this operation).

Parameters

Name Type Description Notes
_object String Object type
status String Filter by job status [optional]
cursor String Opaque pagination cursor [optional]
limit Integer Page size (default 100, max 1000) [optional]

Return type

BulkJobsResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message

bulkSubmitJob

BulkJobResponse bulkSubmitJob(_object, bulkJob)

Submit a bulk job

Submits a job referencing a previously uploaded NDJSON object. One active job per merchant; additional submissions queue. The bulk surface is write-only (insert / upsert); it has no bulk read or export operation.

Example

(No example for this operation).

Parameters

Name Type Description Notes
_object String Object type
bulkJob BulkJobRequest Bulk job submission

Return type

BulkJobResponse

Authorization

ultraCartOauth, ultraCartSimpleApiKey

HTTP request headers

  • Content-Type: application/json; charset=UTF-8
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Successful response -
400 Status Code 400: bad request input such as invalid json * UC-REST-ERROR - Contains human readable error message
401 Status Code 401: invalid credentials supplied * UC-REST-ERROR - Contains human readable error message
410 Status Code 410: Your authorized application has been disabled by UltraCart * UC-REST-ERROR - Contains human readable error message
429 Status Code 429: you have exceeded the allowed API call rate limit for your application. * UC-REST-ERROR - Contains human readable error message
500 Status Code 500: any server side error. the body will contain a generic server error message * UC-REST-ERROR - Contains human readable error message