commercetools-sdk-php-v2
The commercetools platform, import-api and PHP sdks generated from our api reference.
Order.php
1 <?php
2 
3 declare(strict_types=1);
10 
37 use DateTimeImmutable;
38 
39 interface Order extends BaseResource
40 {
41  public const FIELD_ORDER_NUMBER = 'orderNumber';
42  public const FIELD_PURCHASE_ORDER_NUMBER = 'purchaseOrderNumber';
43  public const FIELD_CUSTOMER_ID = 'customerId';
44  public const FIELD_CUSTOMER_EMAIL = 'customerEmail';
45  public const FIELD_CUSTOMER_GROUP = 'customerGroup';
46  public const FIELD_ANONYMOUS_ID = 'anonymousId';
47  public const FIELD_BUSINESS_UNIT = 'businessUnit';
48  public const FIELD_STORE = 'store';
49  public const FIELD_LINE_ITEMS = 'lineItems';
50  public const FIELD_CUSTOM_LINE_ITEMS = 'customLineItems';
51  public const FIELD_TOTAL_PRICE = 'totalPrice';
52  public const FIELD_TAXED_PRICE = 'taxedPrice';
53  public const FIELD_TAXED_SHIPPING_PRICE = 'taxedShippingPrice';
54  public const FIELD_DISCOUNT_ON_TOTAL_PRICE = 'discountOnTotalPrice';
55  public const FIELD_TAX_MODE = 'taxMode';
56  public const FIELD_TAX_ROUNDING_MODE = 'taxRoundingMode';
57  public const FIELD_TAX_CALCULATION_MODE = 'taxCalculationMode';
58  public const FIELD_INVENTORY_MODE = 'inventoryMode';
59  public const FIELD_BILLING_ADDRESS = 'billingAddress';
60  public const FIELD_SHIPPING_ADDRESS = 'shippingAddress';
61  public const FIELD_SHIPPING_MODE = 'shippingMode';
62  public const FIELD_SHIPPING_KEY = 'shippingKey';
63  public const FIELD_SHIPPING_INFO = 'shippingInfo';
64  public const FIELD_SHIPPING_RATE_INPUT = 'shippingRateInput';
65  public const FIELD_SHIPPING_CUSTOM_FIELDS = 'shippingCustomFields';
66  public const FIELD_SHIPPING = 'shipping';
67  public const FIELD_ITEM_SHIPPING_ADDRESSES = 'itemShippingAddresses';
68  public const FIELD_DISCOUNT_CODES = 'discountCodes';
69  public const FIELD_DIRECT_DISCOUNTS = 'directDiscounts';
70  public const FIELD_REFUSED_GIFTS = 'refusedGifts';
71  public const FIELD_PAYMENT_INFO = 'paymentInfo';
72  public const FIELD_COUNTRY = 'country';
73  public const FIELD_LOCALE = 'locale';
74  public const FIELD_ORIGIN = 'origin';
75  public const FIELD_CART = 'cart';
76  public const FIELD_QUOTE = 'quote';
77  public const FIELD_ORDER_STATE = 'orderState';
78  public const FIELD_SHIPMENT_STATE = 'shipmentState';
79  public const FIELD_PAYMENT_STATE = 'paymentState';
80  public const FIELD_STATE = 'state';
81  public const FIELD_SYNC_INFO = 'syncInfo';
82  public const FIELD_RETURN_INFO = 'returnInfo';
83  public const FIELD_LAST_MESSAGE_SEQUENCE_NUMBER = 'lastMessageSequenceNumber';
84  public const FIELD_CUSTOM = 'custom';
85  public const FIELD_COMPLETED_AT = 'completedAt';
86  public const FIELD_LAST_MODIFIED_BY = 'lastModifiedBy';
87  public const FIELD_CREATED_BY = 'createdBy';
88 
95  public function getId();
96 
103  public function getVersion();
104 
111  public function getOrderNumber();
112 
120  public function getPurchaseOrderNumber();
121 
128  public function getCustomerId();
129 
136  public function getCustomerEmail();
137 
145  public function getCustomerGroup();
146 
153  public function getAnonymousId();
154 
161  public function getBusinessUnit();
162 
169  public function getStore();
170 
177  public function getLineItems();
178 
185  public function getCustomLineItems();
186 
195  public function getTotalPrice();
196 
207  public function getTaxedPrice();
208 
215  public function getTaxedShippingPrice();
216 
223  public function getDiscountOnTotalPrice();
224 
231  public function getTaxMode();
232 
239  public function getTaxRoundingMode();
240 
247  public function getTaxCalculationMode();
248 
255  public function getInventoryMode();
256 
263  public function getBillingAddress();
264 
272  public function getShippingAddress();
273 
280  public function getShippingMode();
281 
288  public function getShippingKey();
289 
297  public function getShippingInfo();
298 
311  public function getShippingRateInput();
312 
319  public function getShippingCustomFields();
320 
328  public function getShipping();
329 
337  public function getItemShippingAddresses();
338 
346  public function getDiscountCodes();
347 
355  public function getDirectDiscounts();
356 
363  public function getRefusedGifts();
364 
371  public function getPaymentInfo();
372 
379  public function getCountry();
380 
388  public function getLocale();
389 
396  public function getOrigin();
397 
405  public function getCart();
406 
413  public function getQuote();
414 
421  public function getOrderState();
422 
429  public function getShipmentState();
430 
437  public function getPaymentState();
438 
446  public function getState();
447 
455  public function getSyncInfo();
456 
463  public function getReturnInfo();
464 
471  public function getLastMessageSequenceNumber();
472 
479  public function getCustom();
480 
488  public function getCompletedAt();
489 
496  public function getCreatedAt();
497 
504  public function getLastModifiedAt();
505 
512  public function getLastModifiedBy();
513 
520  public function getCreatedBy();
521 
525  public function setId(?string $id): void;
526 
530  public function setVersion(?int $version): void;
531 
535  public function setOrderNumber(?string $orderNumber): void;
536 
540  public function setPurchaseOrderNumber(?string $purchaseOrderNumber): void;
541 
545  public function setCustomerId(?string $customerId): void;
546 
550  public function setCustomerEmail(?string $customerEmail): void;
551 
555  public function setCustomerGroup(?CustomerGroupReference $customerGroup): void;
556 
560  public function setAnonymousId(?string $anonymousId): void;
561 
565  public function setBusinessUnit(?BusinessUnitKeyReference $businessUnit): void;
566 
570  public function setStore(?StoreKeyReference $store): void;
571 
575  public function setLineItems(?LineItemCollection $lineItems): void;
576 
580  public function setCustomLineItems(?CustomLineItemCollection $customLineItems): void;
581 
585  public function setTotalPrice(?TypedMoney $totalPrice): void;
586 
590  public function setTaxedPrice(?TaxedPrice $taxedPrice): void;
591 
595  public function setTaxedShippingPrice(?TaxedPrice $taxedShippingPrice): void;
596 
600  public function setDiscountOnTotalPrice(?DiscountOnTotalPrice $discountOnTotalPrice): void;
601 
605  public function setTaxMode(?string $taxMode): void;
606 
610  public function setTaxRoundingMode(?string $taxRoundingMode): void;
611 
615  public function setTaxCalculationMode(?string $taxCalculationMode): void;
616 
620  public function setInventoryMode(?string $inventoryMode): void;
621 
625  public function setBillingAddress(?Address $billingAddress): void;
626 
630  public function setShippingAddress(?Address $shippingAddress): void;
631 
635  public function setShippingMode(?string $shippingMode): void;
636 
640  public function setShippingKey(?string $shippingKey): void;
641 
645  public function setShippingInfo(?ShippingInfo $shippingInfo): void;
646 
650  public function setShippingRateInput(?ShippingRateInput $shippingRateInput): void;
651 
655  public function setShippingCustomFields(?CustomFields $shippingCustomFields): void;
656 
660  public function setShipping(?ShippingCollection $shipping): void;
661 
665  public function setItemShippingAddresses(?AddressCollection $itemShippingAddresses): void;
666 
670  public function setDiscountCodes(?DiscountCodeInfoCollection $discountCodes): void;
671 
675  public function setDirectDiscounts(?DirectDiscountCollection $directDiscounts): void;
676 
680  public function setRefusedGifts(?CartDiscountReferenceCollection $refusedGifts): void;
681 
685  public function setPaymentInfo(?PaymentInfo $paymentInfo): void;
686 
690  public function setCountry(?string $country): void;
691 
695  public function setLocale(?string $locale): void;
696 
700  public function setOrigin(?string $origin): void;
701 
705  public function setCart(?CartReference $cart): void;
706 
710  public function setQuote(?QuoteReference $quote): void;
711 
715  public function setOrderState(?string $orderState): void;
716 
720  public function setShipmentState(?string $shipmentState): void;
721 
725  public function setPaymentState(?string $paymentState): void;
726 
730  public function setState(?StateReference $state): void;
731 
735  public function setSyncInfo(?SyncInfoCollection $syncInfo): void;
736 
740  public function setReturnInfo(?ReturnInfoCollection $returnInfo): void;
741 
745  public function setLastMessageSequenceNumber(?int $lastMessageSequenceNumber): void;
746 
750  public function setCustom(?CustomFields $custom): void;
751 
755  public function setCompletedAt(?DateTimeImmutable $completedAt): void;
756 
760  public function setCreatedAt(?DateTimeImmutable $createdAt): void;
761 
765  public function setLastModifiedAt(?DateTimeImmutable $lastModifiedAt): void;
766 
770  public function setLastModifiedBy(?LastModifiedBy $lastModifiedBy): void;
771 
775  public function setCreatedBy(?CreatedBy $createdBy): void;
776 }
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)
setTotalPrice(?TypedMoney $totalPrice)
setItemShippingAddresses(?AddressCollection $itemShippingAddresses)
setOrderNumber(?string $orderNumber)
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)