Orders

Bulk Import Orders

Uploads a file to be imported.

POST

/v1/orders/goodsouts/from_file

Bulk Import Orders

curl --request POST \
  --url https://public-api.bladepro.io/v1/orders/goodsouts/from_file \
  --header 'Content-Type: application/json' \
  --data '
{
  "brand_id": 123,
  "category": "<any>",
  "currency_id": 123,
  "extension": "<string>",
  "fields": "<string>",
  "file": "<string>",
  "mapping_template_id": 123,
  "mime": "<string>",
  "name": "<string>",
  "order_channel_id": 123,
  "organisation_id": 123,
  "paper_size": "<any>",
  "print_at_despatch": 123,
  "slug": "<string>"
}
'

{
  "data": {
    "success": true
  },
  "meta": {
    "request_reference": "233f2gjwz-c893v86"
  }
}

Scope(s): APP::ORDERS::MANAGE

Body

brand_idintegerrequired

The ID for the brand.

categoryanyrequired

The document category.

currency_idintegerrequired

The ID for the currency.

extensionstringrequired

The file extension.

fieldsstringrequired

The array of fields of the file.

filestringrequired

The file contents Base64 encoded.

mapping_template_idintegerrequired

The ID for the mapping template.

mimestringrequired

The file mime.

namestringrequired

The file name.

order_channel_idintegerrequired

The ID for the order channel.

organisation_idintegerrequired

The ID for the organisation.

paper_sizeany

The paper size.

print_at_despatchnumber

The number of copies to print at desptach.

slugstringrequired

The slug.

Response

successful operation

successboolean

Pass an order export to import orders in bulk.

Still need help? Share an idea