Class Orders

MailChimp\MailChimp

Extended by

MailChimp\Ecommerce\Ecommerce

Extended by

MailChimp\Ecommerce\Orders

Namespace: MailChimp\Ecommerce
Located at Ecommerce/Orders.php

Methods summary

`public object`	# `getOrders( string $store_id, array $query = [] )` Get information about a store’s orders. Get information about a store’s orders. array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. array["customer_id"] string Restrict results to orders made by a specific customer. Parameters `$store_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public`	# `getOrder( $store_id, $order_id, array $query = [] )` Get information about a specific order. Get information about a specific order. array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields")
`public object`	# `addOrder( string $store_id, string $order_id, string $currency_code, number $order_total, array $customer = [], array $lines = [], array $optional_settings = null )` Add a new order to a store. Add a new order to a store. Parameters `$store_id` `$order_id` `$currency_code` `$order_total` `$customer` See addCustomer method in Customer class `$lines` See addOrderLine method below `$optional_settings` Returns object
`public object`	# `updateOrder( string $store_id, string $order_id, array $data = [] )` Update an order Update an order Parameters `$store_id` `$order_id` `$data` Returns object
`public object`	# `getOrderLines( string $store_id, string $order_id, array $query = [] )` Get information about a order’s line items Get information about a order’s line items array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") array["count"] int number of records to return array["offset"] int number of records from a collection to skip. Parameters `$store_id` `$order_id` `$query` (See Above) OPTIONAL associative array of query parameters. Returns object
`public object`	# `getOrderLine( string $store_id, string $order_id, array $line_id, array $query = [] )` Get information about a specific order line item. Get information about a specific order line item. array["fields"] array list of strings of response fields to return array["exclude_fields"] array list of strings of response fields to exclude (not to be used with "fields") Parameters `$store_id` `$order_id` `$line_id` $query (See Above) OPTIONAL associative array of query parameters. `$query` Returns object
`public object`	# `addOrderLine( string $store_id, string $order_id, string $line_id, string $product_id, string $product_variant_id, integer $quantity, number $price )` Add a new line item to an existing order Add a new line item to an existing order Parameters `$store_id` `$order_id` `$line_id` `$product_id` `$product_variant_id` `$quantity` `$price` price Returns object
`public object`	# `updateOrderLine( string $store_id, string $order_id, string $line_id, array $data = [] )` Update a line item to an existing order Update a line item to an existing order Parameters `$store_id` `$order_id` `$line_id` `$data` Returns object
`public`	# `deleteOrderLine( string $store_id, string $order_id, string $line_id )` Delete a line item to an existing order Delete a line item to an existing order Parameters `$store_id` `$order_id` `$line_id`
`public`	# `deleteOrder( string $store_id, string $order_id )` Delete an existing order Delete an existing order Parameters `$store_id` `$order_id`

Methods inherited from MailChimp\Ecommerce\Ecommerce

addStore(), carts(), customers(), deleteStore(), getStore(), getStores(), orders(), products(), updateStore()

Methods inherited from MailChimp\MailChimp

__construct(), authorizedApps(), automations(), batchOps(), campaignFolders(), campaigns(), conversations(), createLog(), ecommerce(), execute(), fileManager(), fileManagerFolders(), getAccountInfo(), getMemberHash(), lists(), logData(), optionalFields(), reports(), searchMembers(), templateFolders(), templates()