Import Orders

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/orders/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data '[
  {
    "source_id": "orderImport14",
    "status": "PAID",
    "metadata": {
      "location_id": [
        "L1",
        "L2"
      ],
      "payment_mean": [
        "paypal",
        "credit-card"
      ]
    },
    "customer": {
      "source_id": "bob2.smith@email.com",
      "name": "Bob Smith",
      "description": "A nice customer",
      "email": "bob.smith@email.com",
      "phone": "+1 933 222 3333",
      "address": {
        "city": "New York",
        "country": "United States",
        "line_1": "123 Main St.",
        "line_2": "APT 3 BLG 4",
        "postal_code": "10001",
        "state": "NY"
      },
      "metadata": {
        "lang": "en",
        "test": true
      },
      "birthdate": "2022-01-01"
    },
    "referrer": {
      "source_id": "jane.smith@email.com",
      "name": "Jane Smith",
      "description": "A really nice customer",
      "email": "jane.smith@email.com",
      "phone": "+1 933 222 3334",
      "address": {
        "city": "New York",
        "country": "United States",
        "line_1": "123 Main St.",
        "line_2": "APT 3 BLG 4",
        "postal_code": "10001",
        "state": "NY"
      },
      "metadata": {
        "lang": "en",
        "test": false
      },
      "birthday": "2022-03-03"
    },
    "items": [
      {
        "source_id": "prod_1",
        "related_object": "product",
        "quantity": 2,
        "product": {
          "name": "Apple iPhone 12",
          "price": 70000,
          "metadata": {
            "color": [
              "silver"
            ],
            "vendor": "mall"
          },
          "override": true
        }
      },
      {
        "source_id": "ComicBook_1",
        "related_object": "sku",
        "quantity": 1,
        "product": {
          "source_id": "Books",
          "name": "Comic Books1",
          "price": 1600,
          "metadata": {
            "color": [
              "silver"
            ],
            "vendor": "Bookstore1"
          },
          "override": true
        },
        "sku": {
          "sku": "Comics1",
          "source_id": "ComicBook_1",
          "price": 1600,
          "metadata": {
            "color": [
              "golden"
            ],
            "vendor": "islands"
          },
          "override": true
        }
      }
    ]
  },
  {
    "source_id": "orderImport15",
    "status": "PAID",
    "metadata": {
      "location_id": [
        "L3"
      ],
      "payment_mean": [
        "wire-transfer"
      ]
    },
    "customer": {
      "source_id": "bob2.smith@email.com"
    },
    "referrer": {
      "source_id": "jane.smith@email.com"
    },
    "items": [
      {
        "source_id": "ComicBook_1",
        "quantity": 4,
        "related_object": "sku",
        "sku": {
          "source_id": "ComicBook_1"
        }
      },
      {
        "source_id": "vase_1",
        "quantity": 1,
        "related_object": "product",
        "product": {
          "source_id": "vase_1"
        }
      }
    ]
  },
  {
    "source_id": "orderImport16",
    "status": "FULFILLED",
    "metadata": {
      "location_id": [
        "L3"
      ],
      "payment_mean": [
        "wire-transfer"
      ]
    },
    "customer": {
      "id": "cust_LMY4ZylSdUYB1J4tzqNcl5VV"
    },
    "referrer": {
      "id": "cust_Vzck5i8U3OhcEUFY6MKhN9Rv"
    },
    "items": [
      {
        "product_id": "prod_0b72b0bd64d198e3ae",
        "quantity": 2
      },
      {
        "sku_id": "sku_0b1621b319d248b79f",
        "quantity": 2
      }
    ]
  },
  {
    "source_id": "orderImport17",
    "status": "CANCELED",
    "amount": 7000,
    "metadata": {
      "location_id": [
        "L3"
      ],
      "payment_mean": [
        "wire-transfer"
      ]
    }
  },
  {
    "source_id": "orderImport18",
    "status": "CREATED",
    "metadata": {
      "location_id": [
        "L3"
      ],
      "payment_mean": [
        "wire-transfer"
      ]
    },
    "items": [
      {
        "source_id": "ComicBook_1",
        "amount": 900,
        "related_object": "sku"
      },
      {
        "source_id": "vase_1",
        "amount": 2000,
        "related_object": "product"
      }
    ]
  },
  {
    "source_id": "orderImport19",
    "status": "CREATED",
    "metadata": {
      "location_id": [
        "L3"
      ],
      "payment_mean": [
        "wire-transfer"
      ]
    },
    "items": [
      {
        "amount": 900
      },
      {
        "amount": 2000
      }
    ]
  },
  {
    "source_id": "orderImport20",
    "status": "CREATED",
    "metadata": {
      "location_id": [
        "L3"
      ],
      "payment_mean": [
        "wire-transfer"
      ]
    },
    "items": [
      {
        "price": 900,
        "quantity": 2
      },
      {
        "price": 2000,
        "quantity": 3
      }
    ]
  }
]'

{
  "async_action_id": "aa_0a875d56c805df6601"
}

Import Orders

🚧 Historical orders

This endpoint should only be used to import historical orders into Voucherify. For on-going synchronization, the update order endpoint should be used. This is critical because this endpoint does not store events or launch distributions. The orders will also have a created_at date that’s assigned when they’ve been imported to Voucherify. To keep track of the actual order creation date, add an order metadata in ISO 8601 date or date time format to each imported order.

Limitations

Import volume

There can be only a single on-going order import per tenant per project at a given time. The user can schedule more imports but those extra imports will be scheduled to run in sequence one by one.

Maximum count of orders in single import

There is a 2000 limit of orders per one request.

Notifications

There are no notifications on the Dashboard because this import is launched via the API.

Triggered actions

If you import orders with customers, then a logic will be scheduled responsible for placing these customers into segments and refreshing the segment’s summary. Consequently, this update will trigger

Customers entering into segments
Distributions based on any rules tied to customer entering segment(s)
Earning rules based on the customer entering segment(s)

What is not triggered

No webhooks are triggered during the import of orders - for both orders and upserted products / SKUs.
Distributions based on Order Update, Order Paid, Order Created and Order Cancelled. In other words if you have a distribution based on Order Paid and you import an order with a PAID status, the distribution is not going to be triggered.
No events are created during the import of orders - for both orders and upserted products / SKUs. In other words you won’t see any events in the Activity tab in the Dashboard such as Order created or Order paid. If you are additionally upserting products / SKUs, then you won’t see the Product created events listed, etc.
Earning rules based on Order Paid won’t be triggered.

This API request starts a process that affects Voucherify data in bulk.

In case of small jobs (like bulk update) the request is put into a queue and processed once every other bulk request placed in the queue prior to this request is finished. However, when the job takes a longer time (like vouchers generation) then it is processed in small portions in a round-robin fashion. When there is a list of vouchers generation scheduled, then they will all have the IN_PROGRESS status shortly. This way, small jobs added just after scheduling big jobs of the same type will be processed in a short time window.

The result will return the async ID. You can verify the status of your request with GET Async Action endpoint.

POST

orders

import

Import Orders

curl --request POST \
  --url https://{cluster}.voucherify.io/v1/orders/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>' \
  --data null

{
  "async_action_id": "aa_0a875d56c805df6601"
}

Authorizations

X-App-Id

string

header

required

X-App-Token

string

header

required

Authorization

string

header

required

Body

application/json · Order Customer And Referrer Ids Objects · object[]

referrer_id

string | null

Example:

customer

object

Show child attributes

referrer

object

Show child attributes

string

source_id

string | null

status

enum<string>

Available options:

CREATED,

PAID,

CANCELED,

FULFILLED

amount

integer

initial_amount

integer

discount_amount

integer

items

Order Item · object[]

Show child attributes

metadata

object

Response

async_action_id

string

required

Example:

Update Order Create Orders Export

⌘I

Introduction

Endpoints

Events

Import Orders

Limitations

Import volume

Maximum count of orders in single import

Notifications

Triggered actions

What is not triggered

Authorizations

Body

Response