commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
lib
commercetools-import
src
Models
Orders
OrderImport.php
1
<?php
2
3
declare(strict_types=1);
9
namespace
Commercetools\Import\Models\Orders
;
10
11
use
Commercetools\Base\DateTimeImmutableCollection
;
12
use
Commercetools\Base\JsonObject
;
13
use
Commercetools\Import\Models\Common\Address
;
14
use
Commercetools\Import\Models\Common\AddressCollection
;
15
use
Commercetools\Import\Models\Common\CustomerGroupKeyReference
;
16
use
Commercetools\Import\Models\Common\CustomerKeyReference
;
17
use
Commercetools\Import\Models\Common\StateKeyReference
;
18
use
Commercetools\Import\Models\Common\StoreKeyReference
;
19
use
Commercetools\Import\Models\Common\TypedMoney
;
20
use
Commercetools\Import\Models\Customfields\Custom
;
21
use DateTimeImmutable;
22
23
interface
OrderImport
extends
JsonObject
24
{
25
public
const
FIELD_ORDER_NUMBER
=
'orderNumber'
;
26
public
const
FIELD_CUSTOMER
=
'customer'
;
27
public
const
FIELD_CUSTOMER_EMAIL
=
'customerEmail'
;
28
public
const
FIELD_LINE_ITEMS
=
'lineItems'
;
29
public
const
FIELD_CUSTOM_LINE_ITEMS
=
'customLineItems'
;
30
public
const
FIELD_TOTAL_PRICE
=
'totalPrice'
;
31
public
const
FIELD_TAXED_PRICE
=
'taxedPrice'
;
32
public
const
FIELD_SHIPPING_ADDRESS
=
'shippingAddress'
;
33
public
const
FIELD_BILLING_ADDRESS
=
'billingAddress'
;
34
public
const
FIELD_CUSTOMER_GROUP
=
'customerGroup'
;
35
public
const
FIELD_COUNTRY
=
'country'
;
36
public
const
FIELD_ORDER_STATE
=
'orderState'
;
37
public
const
FIELD_SHIPMENT_STATE
=
'shipmentState'
;
38
public
const
FIELD_PAYMENT_STATE
=
'paymentState'
;
39
public
const
FIELD_SHIPPING_INFO
=
'shippingInfo'
;
40
public
const
FIELD_COMPLETED_AT
=
'completedAt'
;
41
public
const
FIELD_CUSTOM
=
'custom'
;
42
public
const
FIELD_INVENTORY_MODE
=
'inventoryMode'
;
43
public
const
FIELD_TAX_ROUNDING_MODE
=
'taxRoundingMode'
;
44
public
const
FIELD_TAX_CALCULATION_MODE
=
'taxCalculationMode'
;
45
public
const
FIELD_ORIGIN
=
'origin'
;
46
public
const
FIELD_ITEM_SHIPPING_ADDRESSES
=
'itemShippingAddresses'
;
47
public
const
FIELD_STORE
=
'store'
;
48
public
const
FIELD_STATE
=
'state'
;
49
56
public
function
getOrderNumber
();
57
62
public
function
getCustomer
();
63
70
public
function
getCustomerEmail
();
71
78
public
function
getLineItems
();
79
86
public
function
getCustomLineItems
();
87
94
public
function
getTotalPrice
();
95
102
public
function
getTaxedPrice
();
103
110
public
function
getShippingAddress
();
111
118
public
function
getBillingAddress
();
119
126
public
function
getCustomerGroup
();
127
134
public
function
getCountry
();
135
142
public
function
getOrderState
();
143
150
public
function
getShipmentState
();
151
158
public
function
getPaymentState
();
159
166
public
function
getShippingInfo
();
167
174
public
function
getCompletedAt
();
175
182
public
function
getCustom
();
183
190
public
function
getInventoryMode
();
191
198
public
function
getTaxRoundingMode
();
199
206
public
function
getTaxCalculationMode
();
207
214
public
function
getOrigin
();
215
222
public
function
getItemShippingAddresses
();
223
230
public
function
getStore
();
231
238
public
function
getState
();
239
243
public
function
setOrderNumber
(?
string
$orderNumber): void;
244
248
public
function
setCustomer
(?
CustomerKeyReference
$customer): void;
249
253
public
function
setCustomerEmail
(?
string
$customerEmail): void;
254
258
public
function
setLineItems
(?
LineItemImportDraftCollection
$lineItems): void;
259
263
public
function
setCustomLineItems
(?
CustomLineItemDraftCollection
$customLineItems): void;
264
268
public
function
setTotalPrice
(?
TypedMoney
$totalPrice): void;
269
273
public
function
setTaxedPrice
(?
TaxedPrice
$taxedPrice): void;
274
278
public
function
setShippingAddress
(?
Address
$shippingAddress): void;
279
283
public
function
setBillingAddress
(?
Address
$billingAddress): void;
284
288
public
function
setCustomerGroup
(?
CustomerGroupKeyReference
$customerGroup): void;
289
293
public
function
setCountry
(?
string
$country): void;
294
298
public
function
setOrderState
(?
string
$orderState): void;
299
303
public
function
setShipmentState
(?
string
$shipmentState): void;
304
308
public
function
setPaymentState
(?
string
$paymentState): void;
309
313
public
function
setShippingInfo
(?
ShippingInfoImportDraft
$shippingInfo): void;
314
318
public
function
setCompletedAt
(?DateTimeImmutable $completedAt): void;
319
323
public
function
setCustom
(?
Custom
$custom): void;
324
328
public
function
setInventoryMode
(?
string
$inventoryMode): void;
329
333
public
function
setTaxRoundingMode
(?
string
$taxRoundingMode): void;
334
338
public
function
setTaxCalculationMode
(?
string
$taxCalculationMode): void;
339
343
public
function
setOrigin
(?
string
$origin): void;
344
348
public
function
setItemShippingAddresses
(?
AddressCollection
$itemShippingAddresses): void;
349
353
public
function
setStore
(?
StoreKeyReference
$store): void;
354
358
public
function
setState
(?
StateKeyReference
$state): void;
359
}
Commercetools\Base\DateTimeImmutableCollection
Definition:
DateTimeImmutableCollection.php:21
Commercetools\Import\Models\Common\AddressCollection
Definition:
AddressCollection.php:22
Commercetools\Import\Models\Orders\CustomLineItemDraftCollection
Definition:
CustomLineItemDraftCollection.php:22
Commercetools\Import\Models\Orders\LineItemImportDraftCollection
Definition:
LineItemImportDraftCollection.php:22
Commercetools\Base\JsonObject
Definition:
JsonObject.php:15
Commercetools\Import\Models\Common\Address
Definition:
Address.php:16
Commercetools\Import\Models\Common\CustomerGroupKeyReference
Definition:
CustomerGroupKeyReference.php:15
Commercetools\Import\Models\Common\CustomerKeyReference
Definition:
CustomerKeyReference.php:15
Commercetools\Import\Models\Common\StateKeyReference
Definition:
StateKeyReference.php:15
Commercetools\Import\Models\Common\StoreKeyReference
Definition:
StoreKeyReference.php:15
Commercetools\Import\Models\Common\TypedMoney
Definition:
TypedMoney.php:15
Commercetools\Import\Models\Customfields\Custom
Definition:
Custom.php:16
Commercetools\Import\Models\Orders\OrderImport
Definition:
OrderImport.php:24
Commercetools\Import\Models\Orders\OrderImport\FIELD_ORDER_NUMBER
const FIELD_ORDER_NUMBER
Definition:
OrderImport.php:25
Commercetools\Import\Models\Orders\OrderImport\FIELD_STATE
const FIELD_STATE
Definition:
OrderImport.php:48
Commercetools\Import\Models\Orders\OrderImport\setTaxedPrice
setTaxedPrice(?TaxedPrice $taxedPrice)
Commercetools\Import\Models\Orders\OrderImport\getShippingInfo
getShippingInfo()
Commercetools\Import\Models\Orders\OrderImport\getOrigin
getOrigin()
Commercetools\Import\Models\Orders\OrderImport\setOrigin
setOrigin(?string $origin)
Commercetools\Import\Models\Orders\OrderImport\setShipmentState
setShipmentState(?string $shipmentState)
Commercetools\Import\Models\Orders\OrderImport\FIELD_TAX_ROUNDING_MODE
const FIELD_TAX_ROUNDING_MODE
Definition:
OrderImport.php:43
Commercetools\Import\Models\Orders\OrderImport\FIELD_SHIPPING_INFO
const FIELD_SHIPPING_INFO
Definition:
OrderImport.php:39
Commercetools\Import\Models\Orders\OrderImport\getTotalPrice
getTotalPrice()
Commercetools\Import\Models\Orders\OrderImport\setCustomLineItems
setCustomLineItems(?CustomLineItemDraftCollection $customLineItems)
Commercetools\Import\Models\Orders\OrderImport\getOrderState
getOrderState()
Commercetools\Import\Models\Orders\OrderImport\setCountry
setCountry(?string $country)
Commercetools\Import\Models\Orders\OrderImport\setOrderNumber
setOrderNumber(?string $orderNumber)
Commercetools\Import\Models\Orders\OrderImport\getStore
getStore()
Commercetools\Import\Models\Orders\OrderImport\FIELD_INVENTORY_MODE
const FIELD_INVENTORY_MODE
Definition:
OrderImport.php:42
Commercetools\Import\Models\Orders\OrderImport\getPaymentState
getPaymentState()
Commercetools\Import\Models\Orders\OrderImport\FIELD_TAXED_PRICE
const FIELD_TAXED_PRICE
Definition:
OrderImport.php:31
Commercetools\Import\Models\Orders\OrderImport\FIELD_CUSTOM
const FIELD_CUSTOM
Definition:
OrderImport.php:41
Commercetools\Import\Models\Orders\OrderImport\FIELD_CUSTOMER
const FIELD_CUSTOMER
Definition:
OrderImport.php:26
Commercetools\Import\Models\Orders\OrderImport\getBillingAddress
getBillingAddress()
Commercetools\Import\Models\Orders\OrderImport\getCompletedAt
getCompletedAt()
Commercetools\Import\Models\Orders\OrderImport\setCustomerGroup
setCustomerGroup(?CustomerGroupKeyReference $customerGroup)
Commercetools\Import\Models\Orders\OrderImport\getCustomLineItems
getCustomLineItems()
Commercetools\Import\Models\Orders\OrderImport\FIELD_CUSTOMER_GROUP
const FIELD_CUSTOMER_GROUP
Definition:
OrderImport.php:34
Commercetools\Import\Models\Orders\OrderImport\getTaxRoundingMode
getTaxRoundingMode()
Commercetools\Import\Models\Orders\OrderImport\getState
getState()
Commercetools\Import\Models\Orders\OrderImport\getInventoryMode
getInventoryMode()
Commercetools\Import\Models\Orders\OrderImport\setOrderState
setOrderState(?string $orderState)
Commercetools\Import\Models\Orders\OrderImport\FIELD_COMPLETED_AT
const FIELD_COMPLETED_AT
Definition:
OrderImport.php:40
Commercetools\Import\Models\Orders\OrderImport\setItemShippingAddresses
setItemShippingAddresses(?AddressCollection $itemShippingAddresses)
Commercetools\Import\Models\Orders\OrderImport\setCustom
setCustom(?Custom $custom)
Commercetools\Import\Models\Orders\OrderImport\FIELD_TAX_CALCULATION_MODE
const FIELD_TAX_CALCULATION_MODE
Definition:
OrderImport.php:44
Commercetools\Import\Models\Orders\OrderImport\setCustomer
setCustomer(?CustomerKeyReference $customer)
Commercetools\Import\Models\Orders\OrderImport\getTaxedPrice
getTaxedPrice()
Commercetools\Import\Models\Orders\OrderImport\FIELD_ORIGIN
const FIELD_ORIGIN
Definition:
OrderImport.php:45
Commercetools\Import\Models\Orders\OrderImport\getLineItems
getLineItems()
Commercetools\Import\Models\Orders\OrderImport\FIELD_ITEM_SHIPPING_ADDRESSES
const FIELD_ITEM_SHIPPING_ADDRESSES
Definition:
OrderImport.php:46
Commercetools\Import\Models\Orders\OrderImport\getCustomerGroup
getCustomerGroup()
Commercetools\Import\Models\Orders\OrderImport\setCustomerEmail
setCustomerEmail(?string $customerEmail)
Commercetools\Import\Models\Orders\OrderImport\setPaymentState
setPaymentState(?string $paymentState)
Commercetools\Import\Models\Orders\OrderImport\FIELD_ORDER_STATE
const FIELD_ORDER_STATE
Definition:
OrderImport.php:36
Commercetools\Import\Models\Orders\OrderImport\FIELD_CUSTOM_LINE_ITEMS
const FIELD_CUSTOM_LINE_ITEMS
Definition:
OrderImport.php:29
Commercetools\Import\Models\Orders\OrderImport\setInventoryMode
setInventoryMode(?string $inventoryMode)
Commercetools\Import\Models\Orders\OrderImport\FIELD_BILLING_ADDRESS
const FIELD_BILLING_ADDRESS
Definition:
OrderImport.php:33
Commercetools\Import\Models\Orders\OrderImport\setBillingAddress
setBillingAddress(?Address $billingAddress)
Commercetools\Import\Models\Orders\OrderImport\getCustomer
getCustomer()
Commercetools\Import\Models\Orders\OrderImport\setLineItems
setLineItems(?LineItemImportDraftCollection $lineItems)
Commercetools\Import\Models\Orders\OrderImport\getTaxCalculationMode
getTaxCalculationMode()
Commercetools\Import\Models\Orders\OrderImport\FIELD_COUNTRY
const FIELD_COUNTRY
Definition:
OrderImport.php:35
Commercetools\Import\Models\Orders\OrderImport\setCompletedAt
setCompletedAt(?DateTimeImmutable $completedAt)
Commercetools\Import\Models\Orders\OrderImport\FIELD_PAYMENT_STATE
const FIELD_PAYMENT_STATE
Definition:
OrderImport.php:38
Commercetools\Import\Models\Orders\OrderImport\FIELD_TOTAL_PRICE
const FIELD_TOTAL_PRICE
Definition:
OrderImport.php:30
Commercetools\Import\Models\Orders\OrderImport\FIELD_STORE
const FIELD_STORE
Definition:
OrderImport.php:47
Commercetools\Import\Models\Orders\OrderImport\getCustomerEmail
getCustomerEmail()
Commercetools\Import\Models\Orders\OrderImport\setTaxCalculationMode
setTaxCalculationMode(?string $taxCalculationMode)
Commercetools\Import\Models\Orders\OrderImport\setTaxRoundingMode
setTaxRoundingMode(?string $taxRoundingMode)
Commercetools\Import\Models\Orders\OrderImport\FIELD_SHIPPING_ADDRESS
const FIELD_SHIPPING_ADDRESS
Definition:
OrderImport.php:32
Commercetools\Import\Models\Orders\OrderImport\getCustom
getCustom()
Commercetools\Import\Models\Orders\OrderImport\getItemShippingAddresses
getItemShippingAddresses()
Commercetools\Import\Models\Orders\OrderImport\getShippingAddress
getShippingAddress()
Commercetools\Import\Models\Orders\OrderImport\getCountry
getCountry()
Commercetools\Import\Models\Orders\OrderImport\setState
setState(?StateKeyReference $state)
Commercetools\Import\Models\Orders\OrderImport\FIELD_LINE_ITEMS
const FIELD_LINE_ITEMS
Definition:
OrderImport.php:28
Commercetools\Import\Models\Orders\OrderImport\setShippingInfo
setShippingInfo(?ShippingInfoImportDraft $shippingInfo)
Commercetools\Import\Models\Orders\OrderImport\getShipmentState
getShipmentState()
Commercetools\Import\Models\Orders\OrderImport\setStore
setStore(?StoreKeyReference $store)
Commercetools\Import\Models\Orders\OrderImport\setShippingAddress
setShippingAddress(?Address $shippingAddress)
Commercetools\Import\Models\Orders\OrderImport\getOrderNumber
getOrderNumber()
Commercetools\Import\Models\Orders\OrderImport\FIELD_SHIPMENT_STATE
const FIELD_SHIPMENT_STATE
Definition:
OrderImport.php:37
Commercetools\Import\Models\Orders\OrderImport\setTotalPrice
setTotalPrice(?TypedMoney $totalPrice)
Commercetools\Import\Models\Orders\OrderImport\FIELD_CUSTOMER_EMAIL
const FIELD_CUSTOMER_EMAIL
Definition:
OrderImport.php:27
Commercetools\Import\Models\Orders\ShippingInfoImportDraft
Definition:
ShippingInfoImportDraft.php:19
Commercetools\Import\Models\Orders\TaxedPrice
Definition:
TaxedPrice.php:16
Commercetools\Import\Models\Orders
Definition:
CartClassificationTier.php:9
Generated by
1.9.1