Skip to main content

Orders

The Orders module manages order syncing, order status updates, feed URL setup, and ecommerce stats.

Obtain $client via new Client([...]) as described in Authentication.

Access module​

$ordersApi = $client->orders();

getEcommerceStats​

Returns ecommerce statistics.

Input

  • none

Response

  • array
$stats = $ordersApi->getEcommerceStats();

saveOrder​

Creates or syncs an order using the standard payload format.

Input

  • payload (array<string, mixed>):
    • number (int, required)
    • email_address (string, required)
    • phone (string, required)
    • firstname (string, required)
    • lastname (string, required)
    • city (string, required)
    • county (string, required)
    • address (string, required)
    • discount_value (float, required)
    • discount_code (string, required)
    • shipping (float, required)
    • tax (float, required)
    • total_value (float, required)
    • products (list<array<string, mixed>>, required, min 1)
      • product_id (int, required)
      • price (float, required)
      • quantity (int, required)
      • variation_sku (string, required)

Response

  • array
$result = $ordersApi->saveOrder([
    'number' => 1001,
    'email_address' => 'john@doe.com',
    'phone' => '+40123456789',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'city' => 'Bucharest',
    'county' => 'Bucharest',
    'address' => 'Street 1, no 2',
    'discount_value' => 0.0,
    'discount_code' => '-',
    'shipping' => 0.0,
    'tax' => 0.0,
    'total_value' => 99.99,
    'products' => [
        [
            'product_id' => 123,
            'price' => 99.99,
            'quantity' => 1,
            'variation_sku' => 'SKU-123',
        ],
    ],
]);

saveOrderRetail​

Creates or syncs an order using the retail payload format.

Input

  • payload (array<string, mixed>):
    • all fields from saveOrder payload, plus:
    • store_id (int, required)
    • store_name (string, required)
    • store_city (string, required)
    • store_country (string, required)

Response

  • array
$result = $ordersApi->saveOrderRetail([
    'number' => 1001,
    'email_address' => 'john@doe.com',
    'phone' => '+40123456789',
    'firstname' => 'John',
    'lastname' => 'Doe',
    'city' => 'Bucharest',
    'county' => 'Bucharest',
    'address' => 'Street 1, no 2',
    'discount_value' => 0.0,
    'discount_code' => '-',
    'shipping' => 0.0,
    'tax' => 0.0,
    'total_value' => 99.99,
    'products' => [
        [
            'product_id' => 123,
            'price' => 99.99,
            'quantity' => 1,
            'variation_sku' => 'SKU-123',
        ],
    ],
    'store_id' => 10,
    'store_name' => 'Store name',
    'store_city' => 'Bucharest',
    'store_country' => 'RO',
]);

updateFeedUrl​

Sets or updates the feed URL.

Input

  • url (string, required): feed URL to import from.
  • type (?string): optional. Allowed values: product, category, brand.

Response

  • array
$result = $ordersApi->updateFeedUrl(
    'https://shop.example.com/feed.xml',
    'product'
);

updateOrderFeedUrl​

Sets or updates the order feed URL.

Input

  • url (string): order feed URL.
  • type (?string): optional feed type.

Response

  • array
$result = $ordersApi->updateOrderFeedUrl(
    'https://shop.example.com/orders-feed.xml',
    null
);

updateOrderStatus​

Updates the status of an existing order.

Input

  • order_number (string): the order identifier.
  • order_status (string): the new status to set.

Response

  • array
$result = $ordersApi->updateOrderStatus('1001', 'shipped');