commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
All Classes Namespaces Functions Variables Pages
Order.php
1<?php
2
3declare(strict_types=1);
10
38use DateTimeImmutable;
39
40interface Order extends BaseResource
41{
42 public const FIELD_ORDER_NUMBER = 'orderNumber';
43 public const FIELD_PURCHASE_ORDER_NUMBER = 'purchaseOrderNumber';
44 public const FIELD_CUSTOMER_ID = 'customerId';
45 public const FIELD_CUSTOMER_EMAIL = 'customerEmail';
46 public const FIELD_CUSTOMER_GROUP = 'customerGroup';
47 public const FIELD_ANONYMOUS_ID = 'anonymousId';
48 public const FIELD_BUSINESS_UNIT = 'businessUnit';
49 public const FIELD_STORE = 'store';
50 public const FIELD_LINE_ITEMS = 'lineItems';
51 public const FIELD_CUSTOM_LINE_ITEMS = 'customLineItems';
52 public const FIELD_TOTAL_PRICE = 'totalPrice';
53 public const FIELD_TAXED_PRICE = 'taxedPrice';
54 public const FIELD_TAXED_SHIPPING_PRICE = 'taxedShippingPrice';
55 public const FIELD_DISCOUNT_ON_TOTAL_PRICE = 'discountOnTotalPrice';
56 public const FIELD_TAX_MODE = 'taxMode';
57 public const FIELD_TAX_ROUNDING_MODE = 'taxRoundingMode';
58 public const FIELD_TAX_CALCULATION_MODE = 'taxCalculationMode';
59 public const FIELD_INVENTORY_MODE = 'inventoryMode';
60 public const FIELD_BILLING_ADDRESS = 'billingAddress';
61 public const FIELD_SHIPPING_ADDRESS = 'shippingAddress';
62 public const FIELD_SHIPPING_MODE = 'shippingMode';
63 public const FIELD_SHIPPING_KEY = 'shippingKey';
64 public const FIELD_SHIPPING_INFO = 'shippingInfo';
65 public const FIELD_SHIPPING_RATE_INPUT = 'shippingRateInput';
66 public const FIELD_SHIPPING_CUSTOM_FIELDS = 'shippingCustomFields';
67 public const FIELD_SHIPPING = 'shipping';
68 public const FIELD_ITEM_SHIPPING_ADDRESSES = 'itemShippingAddresses';
69 public const FIELD_DISCOUNT_CODES = 'discountCodes';
70 public const FIELD_DIRECT_DISCOUNTS = 'directDiscounts';
71 public const FIELD_REFUSED_GIFTS = 'refusedGifts';
72 public const FIELD_PAYMENT_INFO = 'paymentInfo';
73 public const FIELD_COUNTRY = 'country';
74 public const FIELD_LOCALE = 'locale';
75 public const FIELD_ORIGIN = 'origin';
76 public const FIELD_CART = 'cart';
77 public const FIELD_QUOTE = 'quote';
78 public const FIELD_ORDER_STATE = 'orderState';
79 public const FIELD_SHIPMENT_STATE = 'shipmentState';
80 public const FIELD_PAYMENT_STATE = 'paymentState';
81 public const FIELD_STATE = 'state';
82 public const FIELD_SYNC_INFO = 'syncInfo';
83 public const FIELD_RETURN_INFO = 'returnInfo';
84 public const FIELD_DISCOUNT_TYPE_COMBINATION = 'discountTypeCombination';
85 public const FIELD_LAST_MESSAGE_SEQUENCE_NUMBER = 'lastMessageSequenceNumber';
86 public const FIELD_CUSTOM = 'custom';
87 public const FIELD_COMPLETED_AT = 'completedAt';
88 public const FIELD_LAST_MODIFIED_BY = 'lastModifiedBy';
89 public const FIELD_CREATED_BY = 'createdBy';
90
97 public function getId();
98
105 public function getVersion();
106
113 public function getOrderNumber();
114
122 public function getPurchaseOrderNumber();
123
130 public function getCustomerId();
131
138 public function getCustomerEmail();
139
147 public function getCustomerGroup();
148
155 public function getAnonymousId();
156
163 public function getBusinessUnit();
164
171 public function getStore();
172
179 public function getLineItems();
180
187 public function getCustomLineItems();
188
197 public function getTotalPrice();
198
209 public function getTaxedPrice();
210
217 public function getTaxedShippingPrice();
218
225 public function getDiscountOnTotalPrice();
226
233 public function getTaxMode();
234
241 public function getTaxRoundingMode();
242
249 public function getTaxCalculationMode();
250
257 public function getInventoryMode();
258
265 public function getBillingAddress();
266
274 public function getShippingAddress();
275
282 public function getShippingMode();
283
290 public function getShippingKey();
291
299 public function getShippingInfo();
300
313 public function getShippingRateInput();
314
321 public function getShippingCustomFields();
322
330 public function getShipping();
331
339 public function getItemShippingAddresses();
340
348 public function getDiscountCodes();
349
357 public function getDirectDiscounts();
358
365 public function getRefusedGifts();
366
373 public function getPaymentInfo();
374
381 public function getCountry();
382
390 public function getLocale();
391
398 public function getOrigin();
399
407 public function getCart();
408
415 public function getQuote();
416
423 public function getOrderState();
424
431 public function getShipmentState();
432
439 public function getPaymentState();
440
448 public function getState();
449
457 public function getSyncInfo();
458
465 public function getReturnInfo();
466
473 public function getDiscountTypeCombination();
474
482
489 public function getCustom();
490
498 public function getCompletedAt();
499
506 public function getCreatedAt();
507
514 public function getLastModifiedAt();
515
522 public function getLastModifiedBy();
523
530 public function getCreatedBy();
531
535 public function setId(?string $id): void;
536
540 public function setVersion(?int $version): void;
541
545 public function setOrderNumber(?string $orderNumber): void;
546
550 public function setPurchaseOrderNumber(?string $purchaseOrderNumber): void;
551
555 public function setCustomerId(?string $customerId): void;
556
560 public function setCustomerEmail(?string $customerEmail): void;
561
565 public function setCustomerGroup(?CustomerGroupReference $customerGroup): void;
566
570 public function setAnonymousId(?string $anonymousId): void;
571
575 public function setBusinessUnit(?BusinessUnitKeyReference $businessUnit): void;
576
580 public function setStore(?StoreKeyReference $store): void;
581
585 public function setLineItems(?LineItemCollection $lineItems): void;
586
590 public function setCustomLineItems(?CustomLineItemCollection $customLineItems): void;
591
595 public function setTotalPrice(?CentPrecisionMoney $totalPrice): void;
596
600 public function setTaxedPrice(?TaxedPrice $taxedPrice): void;
601
605 public function setTaxedShippingPrice(?TaxedPrice $taxedShippingPrice): void;
606
610 public function setDiscountOnTotalPrice(?DiscountOnTotalPrice $discountOnTotalPrice): void;
611
615 public function setTaxMode(?string $taxMode): void;
616
620 public function setTaxRoundingMode(?string $taxRoundingMode): void;
621
625 public function setTaxCalculationMode(?string $taxCalculationMode): void;
626
630 public function setInventoryMode(?string $inventoryMode): void;
631
635 public function setBillingAddress(?Address $billingAddress): void;
636
640 public function setShippingAddress(?Address $shippingAddress): void;
641
645 public function setShippingMode(?string $shippingMode): void;
646
650 public function setShippingKey(?string $shippingKey): void;
651
655 public function setShippingInfo(?ShippingInfo $shippingInfo): void;
656
660 public function setShippingRateInput(?ShippingRateInput $shippingRateInput): void;
661
665 public function setShippingCustomFields(?CustomFields $shippingCustomFields): void;
666
670 public function setShipping(?ShippingCollection $shipping): void;
671
675 public function setItemShippingAddresses(?AddressCollection $itemShippingAddresses): void;
676
680 public function setDiscountCodes(?DiscountCodeInfoCollection $discountCodes): void;
681
685 public function setDirectDiscounts(?DirectDiscountCollection $directDiscounts): void;
686
690 public function setRefusedGifts(?CartDiscountReferenceCollection $refusedGifts): void;
691
695 public function setPaymentInfo(?PaymentInfo $paymentInfo): void;
696
700 public function setCountry(?string $country): void;
701
705 public function setLocale(?string $locale): void;
706
710 public function setOrigin(?string $origin): void;
711
715 public function setCart(?CartReference $cart): void;
716
720 public function setQuote(?QuoteReference $quote): void;
721
725 public function setOrderState(?string $orderState): void;
726
730 public function setShipmentState(?string $shipmentState): void;
731
735 public function setPaymentState(?string $paymentState): void;
736
740 public function setState(?StateReference $state): void;
741
745 public function setSyncInfo(?SyncInfoCollection $syncInfo): void;
746
750 public function setReturnInfo(?ReturnInfoCollection $returnInfo): void;
751
755 public function setDiscountTypeCombination(?DiscountTypeCombination $discountTypeCombination): void;
756
760 public function setLastMessageSequenceNumber(?int $lastMessageSequenceNumber): void;
761
765 public function setCustom(?CustomFields $custom): void;
766
770 public function setCompletedAt(?DateTimeImmutable $completedAt): void;
771
775 public function setCreatedAt(?DateTimeImmutable $createdAt): void;
776
780 public function setLastModifiedAt(?DateTimeImmutable $lastModifiedAt): void;
781
785 public function setLastModifiedBy(?LastModifiedBy $lastModifiedBy): void;
786
790 public function setCreatedBy(?CreatedBy $createdBy): void;
791}
setState(?StateReference $state)
setDiscountCodes(?DiscountCodeInfoCollection $discountCodes)
setBusinessUnit(?BusinessUnitKeyReference $businessUnit)
setShippingCustomFields(?CustomFields $shippingCustomFields)
setCreatedAt(?DateTimeImmutable $createdAt)
setDiscountOnTotalPrice(?DiscountOnTotalPrice $discountOnTotalPrice)
setReturnInfo(?ReturnInfoCollection $returnInfo)
setCustomerId(?string $customerId)
setCustom(?CustomFields $custom)
setItemShippingAddresses(?AddressCollection $itemShippingAddresses)
setOrderNumber(?string $orderNumber)
setTotalPrice(?CentPrecisionMoney $totalPrice)
setDiscountTypeCombination(?DiscountTypeCombination $discountTypeCombination)
setLastModifiedAt(?DateTimeImmutable $lastModifiedAt)
setPaymentInfo(?PaymentInfo $paymentInfo)
setCustomerEmail(?string $customerEmail)
setOrderState(?string $orderState)
setSyncInfo(?SyncInfoCollection $syncInfo)
setShippingMode(?string $shippingMode)
setDirectDiscounts(?DirectDiscountCollection $directDiscounts)
setAnonymousId(?string $anonymousId)
setShippingAddress(?Address $shippingAddress)
setTaxCalculationMode(?string $taxCalculationMode)
setCustomerGroup(?CustomerGroupReference $customerGroup)
setInventoryMode(?string $inventoryMode)
setShipping(?ShippingCollection $shipping)
setQuote(?QuoteReference $quote)
setCreatedBy(?CreatedBy $createdBy)
setLastModifiedBy(?LastModifiedBy $lastModifiedBy)
setBillingAddress(?Address $billingAddress)
setPaymentState(?string $paymentState)
setShippingRateInput(?ShippingRateInput $shippingRateInput)
setCustomLineItems(?CustomLineItemCollection $customLineItems)
setPurchaseOrderNumber(?string $purchaseOrderNumber)
setStore(?StoreKeyReference $store)
setShipmentState(?string $shipmentState)
setShippingKey(?string $shippingKey)
setTaxRoundingMode(?string $taxRoundingMode)
setRefusedGifts(?CartDiscountReferenceCollection $refusedGifts)
setLastMessageSequenceNumber(?int $lastMessageSequenceNumber)
setCompletedAt(?DateTimeImmutable $completedAt)
setTaxedPrice(?TaxedPrice $taxedPrice)
setLineItems(?LineItemCollection $lineItems)
setShippingInfo(?ShippingInfo $shippingInfo)
setTaxedShippingPrice(?TaxedPrice $taxedShippingPrice)