@teemill/orders 1.15.1 → 1.16.0

package/docs/CustomsInformation.md

@@ -0,0 +1,27 @@
+# CustomsInformation
+
+Customs information for the order. **Note:** Adding customs information to an order is only compatible with Shipmate at this time
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preRegistrationType** | **string** | Pre-registration type | [optional] [default to undefined]
+**preRegistrationNumber** | **string** | Pre-registration number | [optional] [default to undefined]
+**vatNumber** | **string** | VAT number | [optional] [default to undefined]
+**eoriNumber** | **string** | EORI number | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomsInformation } from '@teemill/orders';
+
+const instance: CustomsInformation = {
+    preRegistrationType,
+    preRegistrationNumber,
+    vatNumber,
+    eoriNumber,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/CustomsInformation1.md

@@ -0,0 +1,26 @@
+# CustomsInformation1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**preRegistrationType** | **string** |  | [optional] [default to undefined]
+**preRegistrationNumber** | **string** |  | [optional] [default to undefined]
+**vatNumber** | **string** |  | [optional] [default to undefined]
+**eoriNumber** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { CustomsInformation1 } from '@teemill/orders';
+
+const instance: CustomsInformation1 = {
+    preRegistrationType,
+    preRegistrationNumber,
+    vatNumber,
+    eoriNumber,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/DeliveryEstimates.md

@@ -0,0 +1,24 @@
+# DeliveryEstimates
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**isPriority** | **boolean** | Whether this is a priority shipping method. Fulfillments with priority methods aim for same day dispatch when ordered before 1pm, and typically offer faster delivery times. | [optional] [default to undefined]
+**min** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**max** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DeliveryEstimates } from '@teemill/orders';
+
+const instance: DeliveryEstimates = {
+    isPriority,
+    min,
+    max,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ExportOrders202Response.md

@@ -0,0 +1,20 @@
+# ExportOrders202Response
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**message** | **string** | A message describing the export status | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ExportOrders202Response } from '@teemill/orders';
+
+const instance: ExportOrders202Response = {
+    message,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Fulfillment.md

@@ -0,0 +1,34 @@
+# Fulfillment
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique fulfillment id | [optional] [default to undefined]
+**status** | [**Status**](Status.md) |  | [optional] [default to undefined]
+**fulfiller** | [**FulfillmentFulfiller**](FulfillmentFulfiller.md) |  | [optional] [default to undefined]
+**items** | [**Array<FulfillmentItem>**](FulfillmentItem.md) |  | [optional] [default to undefined]
+**tracking** | [**OrderTracking**](OrderTracking.md) |  | [optional] [default to undefined]
+**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | Shipping method currently set | [optional] [default to undefined]
+**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment. | [optional] [default to undefined]
+**packageWeight** | **number** | Weight of the package being shipped in grams | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Fulfillment } from '@teemill/orders';
+
+const instance: Fulfillment = {
+    id,
+    status,
+    fulfiller,
+    items,
+    tracking,
+    shippingMethod,
+    availableShippingMethods,
+    packageWeight,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FulfillmentFulfiller.md

@@ -0,0 +1,23 @@
+# FulfillmentFulfiller
+
+The fulfiller that will be processing this order.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**location** | [**FulfillmentFulfillerLocation**](FulfillmentFulfillerLocation.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FulfillmentFulfiller } from '@teemill/orders';
+
+const instance: FulfillmentFulfiller = {
+    id,
+    location,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FulfillmentFulfillerLocation.md

@@ -0,0 +1,22 @@
+# FulfillmentFulfillerLocation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**city** | **string** |  | [optional] [default to undefined]
+**country** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FulfillmentFulfillerLocation } from '@teemill/orders';
+
+const instance: FulfillmentFulfillerLocation = {
+    city,
+    country,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/FulfillmentItem.md

@@ -0,0 +1,24 @@
+# FulfillmentItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique fulfillment item id | [optional] [default to undefined]
+**itemId** | **string** | Id of the order item being fulfilled | [optional] [default to undefined]
+**quantity** | **number** | Number of this item being fulfilled | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { FulfillmentItem } from '@teemill/orders';
+
+const instance: FulfillmentItem = {
+    id,
+    itemId,
+    quantity,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Image.md

@@ -0,0 +1,27 @@
+# Image
+
+Image description
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**src** | **string** |  | [optional] [default to undefined]
+**alt** | **string** |  | [optional] [default to undefined]
+**sortOrder** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Image } from '@teemill/orders';
+
+const instance: Image = {
+    id,
+    src,
+    alt,
+    sortOrder,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Option.md

@@ -0,0 +1,22 @@
+# Option
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Option name | [default to undefined]
+**value** | **string** | Option value | [default to undefined]
+
+## Example
+
+```typescript
+import { Option } from '@teemill/orders';
+
+const instance: Option = {
+    name,
+    value,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Order.md

@@ -0,0 +1,58 @@
+# Order
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [default to undefined]
+**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
+**status** | [**Status**](Status.md) |  | [optional] [default to undefined]
+**contactInformation** | [**ContactInformation**](ContactInformation.md) |  | [default to undefined]
+**shippingAddress** | [**Address**](Address.md) |  | [default to undefined]
+**customsInformation** | [**CustomsInformation1**](CustomsInformation1.md) |  | [optional] [default to undefined]
+**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**updatedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**statusChangedAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
+**merchantReference** | **string** | A custom reference to the merchant\'s order. | [optional] [default to undefined]
+**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) |  | [optional] [readonly] [default to undefined]
+**items** | [**Array<OrderItem>**](OrderItem.md) |  | [default to undefined]
+**totalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**taxPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**discountPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**shippingPrice** | [**Price**](Price.md) |  | [optional] [default to undefined]
+**origin** | [**Origin**](Origin.md) |  | [optional] [default to undefined]
+**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) |  | [optional] [default to undefined]
+**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { Order } from '@teemill/orders';
+
+const instance: Order = {
+    id,
+    ref,
+    status,
+    contactInformation,
+    shippingAddress,
+    customsInformation,
+    createdAt,
+    updatedAt,
+    statusChangedAt,
+    merchantReference,
+    fulfillments,
+    items,
+    totalPrice,
+    taxPrice,
+    subtotalPrice,
+    discountPrice,
+    shippingPrice,
+    origin,
+    statusHistory,
+    paymentAttempts,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderItem.md

@@ -0,0 +1,40 @@
+# OrderItem
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **string** | Unique object identifier | [optional] [readonly] [default to undefined]
+**variantRef** | **string** | Reference URL to the order item variant | [default to undefined]
+**_options** | [**Array<Option>**](Option.md) | Options associated to an order item\'s variant, such as color and size. | [optional] [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**name** | **string** | The name of the product | [optional] [default to undefined]
+**images** | [**Array<Image>**](Image.md) | Images | [optional] [default to undefined]
+**totalPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+**taxPrice** | [**Price**](Price.md) | This is an estimate until the order has been confirmed | [optional] [readonly] [default to undefined]
+**subtotalPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+**discountPrice** | [**Price**](Price.md) |  | [optional] [readonly] [default to undefined]
+**recipientCost** | [**Price**](Price.md) | The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues. | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItem } from '@teemill/orders';
+
+const instance: OrderItem = {
+    id,
+    variantRef,
+    _options,
+    quantity,
+    name,
+    images,
+    totalPrice,
+    taxPrice,
+    subtotalPrice,
+    discountPrice,
+    recipientCost,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderItem1.md

@@ -0,0 +1,24 @@
+# OrderItem1
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**variantRef** | **string** | A reference to the resource location | [default to undefined]
+**quantity** | **number** |  | [default to undefined]
+**recipientCost** | [**OrderItem1RecipientCost**](OrderItem1RecipientCost.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItem1 } from '@teemill/orders';
+
+const instance: OrderItem1 = {
+    variantRef,
+    quantity,
+    recipientCost,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderItem1RecipientCost.md

@@ -0,0 +1,22 @@
+# OrderItem1RecipientCost
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **string** |  | [default to undefined]
+**currencyCode** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { OrderItem1RecipientCost } from '@teemill/orders';
+
+const instance: OrderItem1RecipientCost = {
+    amount,
+    currencyCode,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/OrderTracking.md

@@ -0,0 +1,24 @@
+# OrderTracking
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**courier** | **string** |  | [optional] [default to undefined]
+**code** | **string** |  | [optional] [default to undefined]
+**url** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { OrderTracking } from '@teemill/orders';
+
+const instance: OrderTracking = {
+    courier,
+    code,
+    url,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)