commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
Loading...
Searching...
No Matches
lib
commercetools-api
src
Models
Order
OrderImportDraft.php
1
<?php
2
3
declare(strict_types=1);
9
namespace
Commercetools\Api\Models\Order
;
10
11
use
Commercetools\Api\Models\BusinessUnit\BusinessUnitResourceIdentifier
;
12
use
Commercetools\Api\Models\Cart\TaxedPriceDraft
;
13
use
Commercetools\Api\Models\Common\BaseAddress
;
14
use
Commercetools\Api\Models\Common\BaseAddressCollection
;
15
use
Commercetools\Api\Models\Common\Money
;
16
use
Commercetools\Api\Models\CustomerGroup\CustomerGroupResourceIdentifier
;
17
use
Commercetools\Api\Models\State\StateReference
;
18
use
Commercetools\Api\Models\Store\StoreResourceIdentifier
;
19
use
Commercetools\Api\Models\Type\CustomFieldsDraft
;
20
use
Commercetools\Base\DateTimeImmutableCollection
;
21
use
Commercetools\Base\JsonObject
;
22
use DateTimeImmutable;
23
24
interface
OrderImportDraft
extends
JsonObject
25
{
26
public
const
FIELD_ORDER_NUMBER
=
'orderNumber'
;
27
public
const
FIELD_PURCHASE_ORDER_NUMBER
=
'purchaseOrderNumber'
;
28
public
const
FIELD_CUSTOMER_ID
=
'customerId'
;
29
public
const
FIELD_CUSTOMER_EMAIL
=
'customerEmail'
;
30
public
const
FIELD_CUSTOMER_GROUP
=
'customerGroup'
;
31
public
const
FIELD_BUSINESS_UNIT
=
'businessUnit'
;
32
public
const
FIELD_STORE
=
'store'
;
33
public
const
FIELD_LINE_ITEMS
=
'lineItems'
;
34
public
const
FIELD_CUSTOM_LINE_ITEMS
=
'customLineItems'
;
35
public
const
FIELD_TOTAL_PRICE
=
'totalPrice'
;
36
public
const
FIELD_TAXED_PRICE
=
'taxedPrice'
;
37
public
const
FIELD_PRICE_ROUNDING_MODE
=
'priceRoundingMode'
;
38
public
const
FIELD_TAX_ROUNDING_MODE
=
'taxRoundingMode'
;
39
public
const
FIELD_TAX_CALCULATION_MODE
=
'taxCalculationMode'
;
40
public
const
FIELD_INVENTORY_MODE
=
'inventoryMode'
;
41
public
const
FIELD_BILLING_ADDRESS
=
'billingAddress'
;
42
public
const
FIELD_SHIPPING_ADDRESS
=
'shippingAddress'
;
43
public
const
FIELD_ITEM_SHIPPING_ADDRESSES
=
'itemShippingAddresses'
;
44
public
const
FIELD_SHIPPING_INFO
=
'shippingInfo'
;
45
public
const
FIELD_PAYMENT_INFO
=
'paymentInfo'
;
46
public
const
FIELD_PAYMENT_STATE
=
'paymentState'
;
47
public
const
FIELD_SHIPMENT_STATE
=
'shipmentState'
;
48
public
const
FIELD_ORDER_STATE
=
'orderState'
;
49
public
const
FIELD_STATE
=
'state'
;
50
public
const
FIELD_COUNTRY
=
'country'
;
51
public
const
FIELD_ORIGIN
=
'origin'
;
52
public
const
FIELD_COMPLETED_AT
=
'completedAt'
;
53
public
const
FIELD_CUSTOM
=
'custom'
;
54
62
public
function
getOrderNumber
();
63
70
public
function
getPurchaseOrderNumber
();
71
78
public
function
getCustomerId
();
79
86
public
function
getCustomerEmail
();
87
94
public
function
getCustomerGroup
();
95
103
public
function
getBusinessUnit
();
104
114
public
function
getStore
();
115
123
public
function
getLineItems
();
124
132
public
function
getCustomLineItems
();
133
140
public
function
getTotalPrice
();
141
148
public
function
getTaxedPrice
();
149
156
public
function
getPriceRoundingMode
();
157
164
public
function
getTaxRoundingMode
();
165
172
public
function
getTaxCalculationMode
();
173
180
public
function
getInventoryMode
();
181
188
public
function
getBillingAddress
();
189
196
public
function
getShippingAddress
();
197
204
public
function
getItemShippingAddresses
();
205
212
public
function
getShippingInfo
();
213
220
public
function
getPaymentInfo
();
221
228
public
function
getPaymentState
();
229
236
public
function
getShipmentState
();
237
244
public
function
getOrderState
();
245
252
public
function
getState
();
253
260
public
function
getCountry
();
261
268
public
function
getOrigin
();
269
276
public
function
getCompletedAt
();
277
284
public
function
getCustom
();
285
289
public
function
setOrderNumber
(?
string
$orderNumber): void;
290
294
public
function
setPurchaseOrderNumber
(?
string
$purchaseOrderNumber): void;
295
299
public
function
setCustomerId
(?
string
$customerId): void;
300
304
public
function
setCustomerEmail
(?
string
$customerEmail): void;
305
309
public
function
setCustomerGroup
(?
CustomerGroupResourceIdentifier
$customerGroup): void;
310
314
public
function
setBusinessUnit
(?
BusinessUnitResourceIdentifier
$businessUnit): void;
315
319
public
function
setStore
(?
StoreResourceIdentifier
$store): void;
320
324
public
function
setLineItems
(?
LineItemImportDraftCollection
$lineItems): void;
325
329
public
function
setCustomLineItems
(?
CustomLineItemImportDraftCollection
$customLineItems): void;
330
334
public
function
setTotalPrice
(?
Money
$totalPrice): void;
335
339
public
function
setTaxedPrice
(?
TaxedPriceDraft
$taxedPrice): void;
340
344
public
function
setPriceRoundingMode
(?
string
$priceRoundingMode): void;
345
349
public
function
setTaxRoundingMode
(?
string
$taxRoundingMode): void;
350
354
public
function
setTaxCalculationMode
(?
string
$taxCalculationMode): void;
355
359
public
function
setInventoryMode
(?
string
$inventoryMode): void;
360
364
public
function
setBillingAddress
(?
BaseAddress
$billingAddress): void;
365
369
public
function
setShippingAddress
(?
BaseAddress
$shippingAddress): void;
370
374
public
function
setItemShippingAddresses
(?
BaseAddressCollection
$itemShippingAddresses): void;
375
379
public
function
setShippingInfo
(?
ShippingInfoImportDraft
$shippingInfo): void;
380
384
public
function
setPaymentInfo
(?
PaymentInfo
$paymentInfo): void;
385
389
public
function
setPaymentState
(?
string
$paymentState): void;
390
394
public
function
setShipmentState
(?
string
$shipmentState): void;
395
399
public
function
setOrderState
(?
string
$orderState): void;
400
404
public
function
setState
(?
StateReference
$state): void;
405
409
public
function
setCountry
(?
string
$country): void;
410
414
public
function
setOrigin
(?
string
$origin): void;
415
419
public
function
setCompletedAt
(?DateTimeImmutable $completedAt): void;
420
424
public
function
setCustom
(?
CustomFieldsDraft
$custom): void;
425
}
Commercetools\Api\Models\Common\BaseAddressCollection
Definition
BaseAddressCollection.php:26
Commercetools\Api\Models\Order\CustomLineItemImportDraftCollection
Definition
CustomLineItemImportDraftCollection.php:22
Commercetools\Api\Models\Order\LineItemImportDraftCollection
Definition
LineItemImportDraftCollection.php:22
Commercetools\Base\DateTimeImmutableCollection
Definition
DateTimeImmutableCollection.php:21
Commercetools\Api\Models\BusinessUnit\BusinessUnitResourceIdentifier
Definition
BusinessUnitResourceIdentifier.php:16
Commercetools\Api\Models\Cart\TaxedPriceDraft
Definition
TaxedPriceDraft.php:17
Commercetools\Api\Models\Common\BaseAddress
Definition
BaseAddress.php:15
Commercetools\Api\Models\Common\Money
Definition
Money.php:15
Commercetools\Api\Models\CustomerGroup\CustomerGroupResourceIdentifier
Definition
CustomerGroupResourceIdentifier.php:16
Commercetools\Api\Models\Order\OrderImportDraft
Definition
OrderImportDraft.php:25
Commercetools\Api\Models\Order\OrderImportDraft\getItemShippingAddresses
getItemShippingAddresses()
Commercetools\Api\Models\Order\OrderImportDraft\setPaymentState
setPaymentState(?string $paymentState)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_LINE_ITEMS
const FIELD_LINE_ITEMS
Definition
OrderImportDraft.php:33
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_STATE
const FIELD_STATE
Definition
OrderImportDraft.php:49
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_BILLING_ADDRESS
const FIELD_BILLING_ADDRESS
Definition
OrderImportDraft.php:41
Commercetools\Api\Models\Order\OrderImportDraft\setStore
setStore(?StoreResourceIdentifier $store)
Commercetools\Api\Models\Order\OrderImportDraft\getOrigin
getOrigin()
Commercetools\Api\Models\Order\OrderImportDraft\getPurchaseOrderNumber
getPurchaseOrderNumber()
Commercetools\Api\Models\Order\OrderImportDraft\setInventoryMode
setInventoryMode(?string $inventoryMode)
Commercetools\Api\Models\Order\OrderImportDraft\getShippingInfo
getShippingInfo()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_PAYMENT_INFO
const FIELD_PAYMENT_INFO
Definition
OrderImportDraft.php:45
Commercetools\Api\Models\Order\OrderImportDraft\getBusinessUnit
getBusinessUnit()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_CUSTOMER_GROUP
const FIELD_CUSTOMER_GROUP
Definition
OrderImportDraft.php:30
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_TAXED_PRICE
const FIELD_TAXED_PRICE
Definition
OrderImportDraft.php:36
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_TAX_ROUNDING_MODE
const FIELD_TAX_ROUNDING_MODE
Definition
OrderImportDraft.php:38
Commercetools\Api\Models\Order\OrderImportDraft\setCustom
setCustom(?CustomFieldsDraft $custom)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_COMPLETED_AT
const FIELD_COMPLETED_AT
Definition
OrderImportDraft.php:52
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_SHIPPING_INFO
const FIELD_SHIPPING_INFO
Definition
OrderImportDraft.php:44
Commercetools\Api\Models\Order\OrderImportDraft\getCustom
getCustom()
Commercetools\Api\Models\Order\OrderImportDraft\getCustomLineItems
getCustomLineItems()
Commercetools\Api\Models\Order\OrderImportDraft\setCustomerId
setCustomerId(?string $customerId)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_CUSTOMER_ID
const FIELD_CUSTOMER_ID
Definition
OrderImportDraft.php:28
Commercetools\Api\Models\Order\OrderImportDraft\getInventoryMode
getInventoryMode()
Commercetools\Api\Models\Order\OrderImportDraft\setCountry
setCountry(?string $country)
Commercetools\Api\Models\Order\OrderImportDraft\setShipmentState
setShipmentState(?string $shipmentState)
Commercetools\Api\Models\Order\OrderImportDraft\getShipmentState
getShipmentState()
Commercetools\Api\Models\Order\OrderImportDraft\setTotalPrice
setTotalPrice(?Money $totalPrice)
Commercetools\Api\Models\Order\OrderImportDraft\getTotalPrice
getTotalPrice()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_CUSTOM_LINE_ITEMS
const FIELD_CUSTOM_LINE_ITEMS
Definition
OrderImportDraft.php:34
Commercetools\Api\Models\Order\OrderImportDraft\setItemShippingAddresses
setItemShippingAddresses(?BaseAddressCollection $itemShippingAddresses)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_ORDER_STATE
const FIELD_ORDER_STATE
Definition
OrderImportDraft.php:48
Commercetools\Api\Models\Order\OrderImportDraft\setPriceRoundingMode
setPriceRoundingMode(?string $priceRoundingMode)
Commercetools\Api\Models\Order\OrderImportDraft\getLineItems
getLineItems()
Commercetools\Api\Models\Order\OrderImportDraft\getShippingAddress
getShippingAddress()
Commercetools\Api\Models\Order\OrderImportDraft\setBusinessUnit
setBusinessUnit(?BusinessUnitResourceIdentifier $businessUnit)
Commercetools\Api\Models\Order\OrderImportDraft\getPriceRoundingMode
getPriceRoundingMode()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_TAX_CALCULATION_MODE
const FIELD_TAX_CALCULATION_MODE
Definition
OrderImportDraft.php:39
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_ITEM_SHIPPING_ADDRESSES
const FIELD_ITEM_SHIPPING_ADDRESSES
Definition
OrderImportDraft.php:43
Commercetools\Api\Models\Order\OrderImportDraft\setCustomerGroup
setCustomerGroup(?CustomerGroupResourceIdentifier $customerGroup)
Commercetools\Api\Models\Order\OrderImportDraft\getOrderState
getOrderState()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_BUSINESS_UNIT
const FIELD_BUSINESS_UNIT
Definition
OrderImportDraft.php:31
Commercetools\Api\Models\Order\OrderImportDraft\setCustomerEmail
setCustomerEmail(?string $customerEmail)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_SHIPMENT_STATE
const FIELD_SHIPMENT_STATE
Definition
OrderImportDraft.php:47
Commercetools\Api\Models\Order\OrderImportDraft\getCustomerEmail
getCustomerEmail()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_TOTAL_PRICE
const FIELD_TOTAL_PRICE
Definition
OrderImportDraft.php:35
Commercetools\Api\Models\Order\OrderImportDraft\setBillingAddress
setBillingAddress(?BaseAddress $billingAddress)
Commercetools\Api\Models\Order\OrderImportDraft\setState
setState(?StateReference $state)
Commercetools\Api\Models\Order\OrderImportDraft\getBillingAddress
getBillingAddress()
Commercetools\Api\Models\Order\OrderImportDraft\setPaymentInfo
setPaymentInfo(?PaymentInfo $paymentInfo)
Commercetools\Api\Models\Order\OrderImportDraft\getCustomerGroup
getCustomerGroup()
Commercetools\Api\Models\Order\OrderImportDraft\setTaxedPrice
setTaxedPrice(?TaxedPriceDraft $taxedPrice)
Commercetools\Api\Models\Order\OrderImportDraft\getCustomerId
getCustomerId()
Commercetools\Api\Models\Order\OrderImportDraft\getPaymentState
getPaymentState()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_SHIPPING_ADDRESS
const FIELD_SHIPPING_ADDRESS
Definition
OrderImportDraft.php:42
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_ORDER_NUMBER
const FIELD_ORDER_NUMBER
Definition
OrderImportDraft.php:26
Commercetools\Api\Models\Order\OrderImportDraft\getCountry
getCountry()
Commercetools\Api\Models\Order\OrderImportDraft\getOrderNumber
getOrderNumber()
Commercetools\Api\Models\Order\OrderImportDraft\setLineItems
setLineItems(?LineItemImportDraftCollection $lineItems)
Commercetools\Api\Models\Order\OrderImportDraft\setTaxRoundingMode
setTaxRoundingMode(?string $taxRoundingMode)
Commercetools\Api\Models\Order\OrderImportDraft\getStore
getStore()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_ORIGIN
const FIELD_ORIGIN
Definition
OrderImportDraft.php:51
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_COUNTRY
const FIELD_COUNTRY
Definition
OrderImportDraft.php:50
Commercetools\Api\Models\Order\OrderImportDraft\getState
getState()
Commercetools\Api\Models\Order\OrderImportDraft\setOrderNumber
setOrderNumber(?string $orderNumber)
Commercetools\Api\Models\Order\OrderImportDraft\setTaxCalculationMode
setTaxCalculationMode(?string $taxCalculationMode)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_PRICE_ROUNDING_MODE
const FIELD_PRICE_ROUNDING_MODE
Definition
OrderImportDraft.php:37
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_CUSTOMER_EMAIL
const FIELD_CUSTOMER_EMAIL
Definition
OrderImportDraft.php:29
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_PURCHASE_ORDER_NUMBER
const FIELD_PURCHASE_ORDER_NUMBER
Definition
OrderImportDraft.php:27
Commercetools\Api\Models\Order\OrderImportDraft\setShippingInfo
setShippingInfo(?ShippingInfoImportDraft $shippingInfo)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_CUSTOM
const FIELD_CUSTOM
Definition
OrderImportDraft.php:53
Commercetools\Api\Models\Order\OrderImportDraft\setShippingAddress
setShippingAddress(?BaseAddress $shippingAddress)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_PAYMENT_STATE
const FIELD_PAYMENT_STATE
Definition
OrderImportDraft.php:46
Commercetools\Api\Models\Order\OrderImportDraft\getTaxedPrice
getTaxedPrice()
Commercetools\Api\Models\Order\OrderImportDraft\getCompletedAt
getCompletedAt()
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_INVENTORY_MODE
const FIELD_INVENTORY_MODE
Definition
OrderImportDraft.php:40
Commercetools\Api\Models\Order\OrderImportDraft\getTaxCalculationMode
getTaxCalculationMode()
Commercetools\Api\Models\Order\OrderImportDraft\setPurchaseOrderNumber
setPurchaseOrderNumber(?string $purchaseOrderNumber)
Commercetools\Api\Models\Order\OrderImportDraft\getPaymentInfo
getPaymentInfo()
Commercetools\Api\Models\Order\OrderImportDraft\setOrderState
setOrderState(?string $orderState)
Commercetools\Api\Models\Order\OrderImportDraft\setCustomLineItems
setCustomLineItems(?CustomLineItemImportDraftCollection $customLineItems)
Commercetools\Api\Models\Order\OrderImportDraft\getTaxRoundingMode
getTaxRoundingMode()
Commercetools\Api\Models\Order\OrderImportDraft\setOrigin
setOrigin(?string $origin)
Commercetools\Api\Models\Order\OrderImportDraft\setCompletedAt
setCompletedAt(?DateTimeImmutable $completedAt)
Commercetools\Api\Models\Order\OrderImportDraft\FIELD_STORE
const FIELD_STORE
Definition
OrderImportDraft.php:32
Commercetools\Api\Models\Order\PaymentInfo
Definition
PaymentInfo.php:16
Commercetools\Api\Models\Order\ShippingInfoImportDraft
Definition
ShippingInfoImportDraft.php:20
Commercetools\Api\Models\State\StateReference
Definition
StateReference.php:16
Commercetools\Api\Models\Store\StoreResourceIdentifier
Definition
StoreResourceIdentifier.php:16
Commercetools\Api\Models\Type\CustomFieldsDraft
Definition
CustomFieldsDraft.php:15
Commercetools\Base\JsonObject
Definition
JsonObject.php:15
Commercetools\Api\Models\Order
Definition
CustomLineItemImportDraft.php:9
Generated by
1.9.8