Bulk jobImport
Import Customers
Upload a customer spreadsheet and queue it for background import. Error reports never carry row values, and no customer field reaches the logs.
Authorization
default AuthorizationBearer <token>
You can retrieve your token by logging in.
In: header
Header Parameters
X-API-Version*string
API contract version to target. See the Changelog for what changed in each version.
Default
"2.0.0"Value in
"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"Request Body
multipart/form-data
file?string
This field is required when source_key is not present. Must be a file. Must not be greater than 20480 kilobytes.
source_key?string
This field is required when file is not present. Must start with one of imports/quarantine/.
original_filename?|
Must not be greater than 255 characters.
market_id?|
Must match an existing stored value.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.flavours.sa/dev/api/v2/bulk/customers/import" \ -H "X-API-Version: 2.3.0"{
"meta": {
"code": 200,
"status": "success",
"message": "Customer import has been queued."
},
"data": {
"id": 8,
"status": "QUEUED"
}
}{
"meta": {
"code": 401,
"status": "error",
"message": "Unauthenticated."
},
"data": null
}{
"meta": {
"code": 403,
"status": "error",
"message": "Unauthorized."
},
"data": null
}{
"meta": {
"code": 404,
"status": "error",
"message": "Resource not found."
},
"data": null
}{
"meta": {
"code": 500,
"status": "error",
"message": "Internal server error."
},
"data": null
}