Sandbox

Create test orders and sales in your test store. Test keys only.

POSTSimulate a paid online order
POSTMove a test order on
POSTSimulate an in-store Scan & Go sale
POSTReset the test store

Simulate a paid online order

POST/v1/sandbox/orders

Creates a paid delivery order at your test store and sends order.placed. Requires a company-wide test key. Sandbox only.

Request body

linesarray of object
Defaults to one each of two stocked products.
- barcodestringrequired
- quantityinteger

Returns · SandboxOrderCreated

Show 2 fields

order_idstringrequired
store_idinteger
Your test store.

Request
curl -X POST https://sandbox.api.scanimart.com/v1/sandbox/orders \
  -H "Authorization: Bearer $SCANIMART_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lines": [
      {
        "barcode": "8901725181222",
        "quantity": 1
      }
    ]
  }'

Response · 201
{
  "order_id": "ORDER-1A2B3C4D5E",
  "store_id": 1042
}

Move a test order on

POST/v1/sandbox/orders/{order_id}/advance

Play the store, rider or customer: ACCEPTED (from the retailer app), PACKED, OUT_FOR_DELIVERY, DELIVERED, or CANCELLED (by the customer). Requires a company-wide test key.

Parameters

order_idstring · pathrequired

Request body

toenumrequired
* ACCEPTED - ACCEPTED * PACKED - PACKED * OUT_FOR_DELIVERY - OUT_FOR_DELIVERY * DELIVERED - DELIVERED * CANCELLED - CANCELLED
ACCEPTEDPACKEDOUT_FOR_DELIVERYDELIVEREDCANCELLED

Returns · SandboxAdvanced

Show 2 fields

order_idstringrequired
statusstringrequired

Request
curl -X POST https://sandbox.api.scanimart.com/v1/sandbox/orders/ORDER-1A2B3C4D5E/advance \
  -H "Authorization: Bearer $SCANIMART_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "ACCEPTED"
  }'

Response · 200
{
  "order_id": "ORDER-1A2B3C4D5E",
  "status": "string"
}

Simulate an in-store Scan & Go sale

POST/v1/sandbox/instore-sales

Requires a company-wide test key.

Request body

linesarray of object
Defaults to one each of two stocked products.
- barcodestringrequired
- quantityinteger

Returns · SandboxOrderCreated

Show 2 fields

order_idstringrequired
store_idinteger
Your test store.

Request
curl -X POST https://sandbox.api.scanimart.com/v1/sandbox/instore-sales \
  -H "Authorization: Bearer $SCANIMART_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "lines": [
      {
        "barcode": "8901725181222",
        "quantity": 1
      }
    ]
  }'

Response · 201
{
  "order_id": "ORDER-1A2B3C4D5E",
  "store_id": 1042
}

Reset the test store

POST/v1/sandbox/reset

Deletes the test store's orders and restores every product to 50 units. Requires a company-wide test key.

Returns · SandboxReset

Show 1 fields

deleted_ordersintegerrequired

Request
curl -X POST https://sandbox.api.scanimart.com/v1/sandbox/reset \
  -H "Authorization: Bearer $SCANIMART_KEY"

Response · 200
{
  "deleted_orders": 1
}