@teemill/orders 1.24.1 → 1.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +14 -9
- package/api.ts +560 -137
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +499 -137
- package/dist/api.js +127 -32
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +499 -137
- package/dist/esm/api.js +126 -31
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/Address.md +9 -9
- package/docs/ApiError.md +3 -2
- package/docs/ConfirmOrderFulfillment.md +4 -3
- package/docs/ConfirmOrderFulfillmentWithShipment.md +3 -2
- package/docs/ConfirmOrderFulfillmentWithShippingMethod.md +3 -2
- package/docs/ConfirmOrderValidationError.md +2 -0
- package/docs/ContactInformation.md +2 -2
- package/docs/ContactInformation1.md +23 -0
- package/docs/CreateOrder.md +7 -7
- package/docs/CreateOrderItem.md +24 -0
- package/docs/CustomsInformation.md +4 -4
- package/docs/CustomsInformation1.md +5 -4
- package/docs/DeliveryEstimates.md +4 -3
- package/docs/Fulfiller.md +25 -0
- package/docs/FulfillerLocation.md +23 -0
- package/docs/Fulfillment.md +9 -8
- package/docs/FulfillmentItem.md +3 -3
- package/docs/Image.md +5 -5
- package/docs/ImportOrders202Response.md +20 -0
- package/docs/Order.md +18 -17
- package/docs/OrderItem.md +10 -9
- package/docs/OrderPaymentMethod.md +21 -0
- package/docs/OrderTracking.md +4 -3
- package/docs/OrdersApi.md +91 -31
- package/docs/Origin.md +3 -2
- package/docs/PaymentAttempt.md +4 -5
- package/docs/PaymentMethod.md +2 -1
- package/docs/Price.md +3 -3
- package/docs/ProductUnavailableError.md +35 -0
- package/docs/RecipientCost.md +23 -0
- package/docs/Shipment.md +21 -0
- package/docs/ShippingMethod.md +8 -7
- package/docs/Status.md +1 -0
- package/docs/StockConflictError.md +34 -0
- package/docs/StockUnavailableError.md +35 -0
- package/index.ts +1 -1
- package/package.json +1 -1
|
@@ -6,10 +6,10 @@ Customs information for the order. **Note:** Adding customs information to an or
|
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**preRegistrationType** | **string** |
|
|
10
|
-
**preRegistrationNumber** | **string** |
|
|
11
|
-
**vatNumber** | **string** | VAT number | [optional] [default to undefined]
|
|
12
|
-
**eoriNumber** | **string** | EORI number | [optional] [default to undefined]
|
|
9
|
+
**preRegistrationType** | **string** | The type of tax pre-registration (e.g. IOSS for EU imports). | [optional] [default to undefined]
|
|
10
|
+
**preRegistrationNumber** | **string** | The pre-registration number associated with the registration type. | [optional] [default to undefined]
|
|
11
|
+
**vatNumber** | **string** | The shipper\'s VAT registration number. | [optional] [default to undefined]
|
|
12
|
+
**eoriNumber** | **string** | The shipper\'s EORI number for customs declarations. | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -1,14 +1,15 @@
|
|
|
1
1
|
# CustomsInformation1
|
|
2
2
|
|
|
3
|
+
Customs and tax registration details for international shipments.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**preRegistrationType** | **string** |
|
|
9
|
-
**preRegistrationNumber** | **string** |
|
|
10
|
-
**vatNumber** | **string** |
|
|
11
|
-
**eoriNumber** | **string** |
|
|
9
|
+
**preRegistrationType** | **string** | The type of tax pre-registration (e.g. IOSS for EU imports). | [optional] [default to undefined]
|
|
10
|
+
**preRegistrationNumber** | **string** | The pre-registration number associated with the registration type. | [optional] [default to undefined]
|
|
11
|
+
**vatNumber** | **string** | The shipper\'s VAT registration number. | [optional] [default to undefined]
|
|
12
|
+
**eoriNumber** | **string** | The shipper\'s EORI number for customs declarations. | [optional] [default to undefined]
|
|
12
13
|
|
|
13
14
|
## Example
|
|
14
15
|
|
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
# DeliveryEstimates
|
|
2
2
|
|
|
3
|
+
Estimated delivery window for this shipping method.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**isPriority** | **boolean** | Whether this is a priority shipping method. Fulfillments with priority methods aim for same
|
|
9
|
-
**min** | **string** |
|
|
10
|
-
**max** | **string** |
|
|
9
|
+
**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]
|
|
10
|
+
**min** | **string** | The earliest estimated delivery date. | [optional] [default to undefined]
|
|
11
|
+
**max** | **string** | The latest estimated delivery date. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# Fulfiller
|
|
2
|
+
|
|
3
|
+
The fulfiller that will produce and ship this package.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | Unique identifier of the fulfiller. | [optional] [default to undefined]
|
|
10
|
+
**location** | [**FulfillerLocation**](FulfillerLocation.md) | | [optional] [default to undefined]
|
|
11
|
+
**canFulfillImmediately** | **boolean** | Whether the fulfiller has the stock and capacity to begin processing immediately. | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { Fulfiller } from '@teemill/orders';
|
|
17
|
+
|
|
18
|
+
const instance: Fulfiller = {
|
|
19
|
+
id,
|
|
20
|
+
location,
|
|
21
|
+
canFulfillImmediately,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# FulfillerLocation
|
|
2
|
+
|
|
3
|
+
The geographic location of the fulfiller.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**city** | **string** | The city where the fulfiller is located. | [optional] [default to undefined]
|
|
10
|
+
**country** | **string** | The country code where the fulfiller is located (ISO 3166-1 alpha-2). | [optional] [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { FulfillerLocation } from '@teemill/orders';
|
|
16
|
+
|
|
17
|
+
const instance: FulfillerLocation = {
|
|
18
|
+
city,
|
|
19
|
+
country,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[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
CHANGED
|
@@ -1,19 +1,20 @@
|
|
|
1
1
|
# Fulfillment
|
|
2
2
|
|
|
3
|
+
A fulfillment group within an order. Each fulfillment represents a package that will be shipped separately, potentially from a different fulfiller.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | Unique fulfillment
|
|
9
|
-
**status** | [**Status**](Status.md) |
|
|
10
|
-
**fulfiller** | [**
|
|
11
|
-
**items** | [**Array<FulfillmentItem>**](FulfillmentItem.md) |
|
|
9
|
+
**id** | **string** | Unique identifier for this fulfillment. | [optional] [default to undefined]
|
|
10
|
+
**status** | [**Status**](Status.md) | The current status of this fulfillment. | [optional] [default to undefined]
|
|
11
|
+
**fulfiller** | [**Fulfiller**](Fulfiller.md) | | [optional] [default to undefined]
|
|
12
|
+
**items** | [**Array<FulfillmentItem>**](FulfillmentItem.md) | The items included in this fulfillment package. | [optional] [default to undefined]
|
|
12
13
|
**tracking** | [**OrderTracking**](OrderTracking.md) | | [optional] [default to undefined]
|
|
13
|
-
**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) |
|
|
14
|
-
**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment.
|
|
15
|
-
**packageWeight** | **number** |
|
|
16
|
-
**platformRef** | **string** |
|
|
14
|
+
**shippingMethod** | [**ShippingMethod**](ShippingMethod.md) | The shipping method currently assigned to this fulfillment. | [optional] [default to undefined]
|
|
15
|
+
**availableShippingMethods** | [**Array<ShippingMethod>**](ShippingMethod.md) | Shipping methods available for this fulfillment. Use one of these IDs when confirming the order. | [optional] [default to undefined]
|
|
16
|
+
**packageWeight** | **number** | The estimated weight of the package in grams. | [optional] [default to undefined]
|
|
17
|
+
**platformRef** | **string** | Reference to the source platform of this fulfillment. | [optional] [default to undefined]
|
|
17
18
|
|
|
18
19
|
## Example
|
|
19
20
|
|
package/docs/FulfillmentItem.md
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | Unique fulfillment item
|
|
9
|
-
**itemId** | **string** |
|
|
10
|
-
**quantity** | **number** |
|
|
8
|
+
**id** | **string** | Unique identifier for this fulfillment item. | [optional] [default to undefined]
|
|
9
|
+
**itemId** | **string** | The ID of the order item being fulfilled. | [optional] [default to undefined]
|
|
10
|
+
**quantity** | **number** | The number of units of this item included in the fulfillment. | [optional] [default to undefined]
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
package/docs/Image.md
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
# Image
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A product image associated with an order item.
|
|
4
4
|
|
|
5
5
|
## Properties
|
|
6
6
|
|
|
7
7
|
Name | Type | Description | Notes
|
|
8
8
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**id** | **string** | Unique
|
|
10
|
-
**src** | **string** |
|
|
11
|
-
**alt** | **string** |
|
|
12
|
-
**sortOrder** | **number** |
|
|
9
|
+
**id** | **string** | Unique identifier for this image. | [optional] [default to undefined]
|
|
10
|
+
**src** | **string** | The URL of the image. | [optional] [default to undefined]
|
|
11
|
+
**alt** | **string** | Alternative text describing the image content. | [optional] [default to undefined]
|
|
12
|
+
**sortOrder** | **number** | The display order of this image relative to other images for the same item. | [optional] [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ImportOrders202Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**importId** | **string** | Id of the order import | [optional] [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ImportOrders202Response } from '@teemill/orders';
|
|
14
|
+
|
|
15
|
+
const instance: ImportOrders202Response = {
|
|
16
|
+
importId,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[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
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
# Order
|
|
2
2
|
|
|
3
|
+
Represents a print-on-demand order placed on a project. An order contains items, fulfillment details, pricing, and status tracking.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
@@ -7,26 +8,26 @@ Name | Type | Description | Notes
|
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
9
|
**id** | **string** | Unique object identifier | [optional] [default to undefined]
|
|
9
10
|
**ref** | **string** | A reference to the resource location | [optional] [default to undefined]
|
|
10
|
-
**status** | [**Status**](Status.md) |
|
|
11
|
+
**status** | [**Status**](Status.md) | The current status of the order. | [optional] [default to undefined]
|
|
11
12
|
**contactInformation** | [**ContactInformation**](ContactInformation.md) | | [default to undefined]
|
|
12
|
-
**paymentMethod** | [**
|
|
13
|
-
**shippingAddress** | [**Address**](Address.md) |
|
|
13
|
+
**paymentMethod** | [**OrderPaymentMethod**](OrderPaymentMethod.md) | | [optional] [default to undefined]
|
|
14
|
+
**shippingAddress** | [**Address**](Address.md) | The address the order will be shipped to. | [default to undefined]
|
|
14
15
|
**customsInformation** | [**CustomsInformation1**](CustomsInformation1.md) | | [optional] [default to undefined]
|
|
15
|
-
**createdAt** | **string** |
|
|
16
|
-
**updatedAt** | **string** |
|
|
17
|
-
**statusChangedAt** | **string** |
|
|
18
|
-
**merchantReference** | **string** |
|
|
19
|
-
**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) |
|
|
20
|
-
**items** | [**Array<OrderItem>**](OrderItem.md) |
|
|
21
|
-
**totalPrice** | [**Price**](Price.md) |
|
|
22
|
-
**taxPrice** | [**Price**](Price.md) |
|
|
23
|
-
**subtotalPrice** | [**Price**](Price.md) |
|
|
24
|
-
**discountPrice** | [**Price**](Price.md) |
|
|
25
|
-
**coupon** | [**Coupon**](Coupon.md) |
|
|
26
|
-
**shippingPrice** | [**Price**](Price.md) |
|
|
16
|
+
**createdAt** | **string** | When the order was created. | [optional] [default to undefined]
|
|
17
|
+
**updatedAt** | **string** | When the order was last updated. | [optional] [default to undefined]
|
|
18
|
+
**statusChangedAt** | **string** | When the order status last changed. | [optional] [default to undefined]
|
|
19
|
+
**merchantReference** | **string** | Your own reference for this order, such as an order number from your storefront. | [optional] [default to undefined]
|
|
20
|
+
**fulfillments** | [**Array<Fulfillment>**](Fulfillment.md) | The fulfillment groups for this order. Each fulfillment represents a package that will be shipped separately. | [optional] [readonly] [default to undefined]
|
|
21
|
+
**items** | [**Array<OrderItem>**](OrderItem.md) | The line items included in this order. | [default to undefined]
|
|
22
|
+
**totalPrice** | [**Price**](Price.md) | The total price of the order including tax and after discounts. | [optional] [default to undefined]
|
|
23
|
+
**taxPrice** | [**Price**](Price.md) | The total tax amount for the order. | [optional] [default to undefined]
|
|
24
|
+
**subtotalPrice** | [**Price**](Price.md) | The net items price excluding tax and before discounts. | [optional] [default to undefined]
|
|
25
|
+
**discountPrice** | [**Price**](Price.md) | The total discount amount applied to the order. | [optional] [default to undefined]
|
|
26
|
+
**coupon** | [**Coupon**](Coupon.md) | The coupon applied to the order, if any. | [optional] [default to undefined]
|
|
27
|
+
**shippingPrice** | [**Price**](Price.md) | The total shipping cost for the order. | [optional] [default to undefined]
|
|
27
28
|
**origin** | [**Origin**](Origin.md) | | [optional] [default to undefined]
|
|
28
|
-
**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) |
|
|
29
|
-
**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) |
|
|
29
|
+
**statusHistory** | [**Array<StatusHistoryItem>**](StatusHistoryItem.md) | A chronological list of status changes for this order. | [optional] [default to undefined]
|
|
30
|
+
**paymentAttempts** | [**Array<PaymentAttempt>**](PaymentAttempt.md) | A list of payment attempts made for this order. | [optional] [default to undefined]
|
|
30
31
|
|
|
31
32
|
## Example
|
|
32
33
|
|
package/docs/OrderItem.md
CHANGED
|
@@ -1,21 +1,22 @@
|
|
|
1
1
|
# OrderItem
|
|
2
2
|
|
|
3
|
+
A line item in an order, representing a specific product variant and quantity.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | Unique
|
|
9
|
+
**id** | **string** | Unique identifier for this order item. | [optional] [readonly] [default to undefined]
|
|
9
10
|
**variantRef** | **string** | A reference to the variant being ordered | [default to undefined]
|
|
10
11
|
**_options** | [**Array<Option>**](Option.md) | Options associated to an order item\'s variant, such as color and size. | [optional] [default to undefined]
|
|
11
|
-
**quantity** | **number** |
|
|
12
|
-
**name** | **string** | The name of the product | [optional] [default to undefined]
|
|
13
|
-
**images** | [**Array<Image>**](Image.md) |
|
|
14
|
-
**totalPrice** | [**Price**](Price.md) |
|
|
15
|
-
**taxPrice** | [**Price**](Price.md) | This is an estimate until the order has been confirmed | [optional] [readonly] [default to undefined]
|
|
16
|
-
**subtotalPrice** | [**Price**](Price.md) |
|
|
17
|
-
**discountPrice** | [**Price**](Price.md) |
|
|
18
|
-
**recipientCost** | [**Price**](Price.md) | The price you charged the recipient for each item.
|
|
12
|
+
**quantity** | **number** | The number of units of this variant to order. | [default to undefined]
|
|
13
|
+
**name** | **string** | The display name of the product. | [optional] [readonly] [default to undefined]
|
|
14
|
+
**images** | [**Array<Image>**](Image.md) | Product images associated with this item. | [optional] [readonly] [default to undefined]
|
|
15
|
+
**totalPrice** | [**Price**](Price.md) | The total price for this line item including tax and after discounts. | [optional] [readonly] [default to undefined]
|
|
16
|
+
**taxPrice** | [**Price**](Price.md) | The tax amount for this line item. This is an estimate until the order has been confirmed. | [optional] [readonly] [default to undefined]
|
|
17
|
+
**subtotalPrice** | [**Price**](Price.md) | The net price for this line item, excluding tax and before discounts. | [optional] [readonly] [default to undefined]
|
|
18
|
+
**discountPrice** | [**Price**](Price.md) | The discount amount applied to this line item. | [optional] [readonly] [default to undefined]
|
|
19
|
+
**recipientCost** | [**Price**](Price.md) | The price you charged the recipient for each item. Highly recommended for international orders as it aids customs declarations. | [optional] [default to undefined]
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# OrderPaymentMethod
|
|
2
|
+
|
|
3
|
+
The payment method used for this order.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**type** | **string** | The type of payment method used. | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { OrderPaymentMethod } from '@teemill/orders';
|
|
15
|
+
|
|
16
|
+
const instance: OrderPaymentMethod = {
|
|
17
|
+
type,
|
|
18
|
+
};
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
[[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
CHANGED
|
@@ -1,13 +1,14 @@
|
|
|
1
1
|
# OrderTracking
|
|
2
2
|
|
|
3
|
+
Shipment tracking information. Available once the fulfillment has been dispatched.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**courier** | **string** |
|
|
9
|
-
**code** | **string** |
|
|
10
|
-
**url** | **string** |
|
|
9
|
+
**courier** | **string** | The name of the courier service. | [optional] [default to undefined]
|
|
10
|
+
**code** | **string** | The tracking code provided by the courier. | [optional] [default to undefined]
|
|
11
|
+
**url** | **string** | A URL to track the shipment on the courier\'s website. | [optional] [default to undefined]
|
|
11
12
|
|
|
12
13
|
## Example
|
|
13
14
|
|
package/docs/OrdersApi.md
CHANGED
|
@@ -11,6 +11,7 @@ All URIs are relative to *https://api.localhost:8080*
|
|
|
11
11
|
|[**exportOrders**](#exportorders) | **GET** /v1/orders/export | Export orders|
|
|
12
12
|
|[**getOrder**](#getorder) | **GET** /v1/orders/{orderId} | Get order|
|
|
13
13
|
|[**getOrders**](#getorders) | **GET** /v1/orders | List orders|
|
|
14
|
+
|[**importOrders**](#importorders) | **POST** /v1/orders/import | Import orders|
|
|
14
15
|
|[**retryPlatformPayment**](#retryplatformpayment) | **POST** /v1/orders/{orderId}/retryPlatformPayment | Retry|
|
|
15
16
|
|
|
16
17
|
# **cancelOrder**
|
|
@@ -29,7 +30,7 @@ import {
|
|
|
29
30
|
const configuration = new Configuration();
|
|
30
31
|
const apiInstance = new OrdersApi(configuration);
|
|
31
32
|
|
|
32
|
-
let project: string; //
|
|
33
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
33
34
|
let orderId: string; //Unique identifier of an order (default to undefined)
|
|
34
35
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
35
36
|
|
|
@@ -44,7 +45,7 @@ const { status, data } = await apiInstance.cancelOrder(
|
|
|
44
45
|
|
|
45
46
|
|Name | Type | Description | Notes|
|
|
46
47
|
|------------- | ------------- | ------------- | -------------|
|
|
47
|
-
| **project** | [**string**] |
|
|
48
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
48
49
|
| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
|
|
49
50
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
50
51
|
|
|
@@ -92,9 +93,9 @@ import {
|
|
|
92
93
|
const configuration = new Configuration();
|
|
93
94
|
const apiInstance = new OrdersApi(configuration);
|
|
94
95
|
|
|
95
|
-
let project: string; //
|
|
96
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
96
97
|
let orderId: string; //Unique identifier of an order (default to undefined)
|
|
97
|
-
let confirmOrderRequest: ConfirmOrderRequest; //
|
|
98
|
+
let confirmOrderRequest: ConfirmOrderRequest; //Confirm an order by specifying shipping methods for each fulfillment. This submits the order for payment processing and production. Orders should be confirmed promptly after creation — the longer an order remains unconfirmed, the greater the chance that stock availability changes. If stock is no longer available at the time of confirmation, the request will fail and you will need to create a new order.
|
|
98
99
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
99
100
|
|
|
100
101
|
const { status, data } = await apiInstance.confirmOrder(
|
|
@@ -109,8 +110,8 @@ const { status, data } = await apiInstance.confirmOrder(
|
|
|
109
110
|
|
|
110
111
|
|Name | Type | Description | Notes|
|
|
111
112
|
|------------- | ------------- | ------------- | -------------|
|
|
112
|
-
| **confirmOrderRequest** | **ConfirmOrderRequest**|
|
|
113
|
-
| **project** | [**string**] |
|
|
113
|
+
| **confirmOrderRequest** | **ConfirmOrderRequest**| Confirm an order by specifying shipping methods for each fulfillment. This submits the order for payment processing and production. Orders should be confirmed promptly after creation — the longer an order remains unconfirmed, the greater the chance that stock availability changes. If stock is no longer available at the time of confirmation, the request will fail and you will need to create a new order. | |
|
|
114
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
114
115
|
| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
|
|
115
116
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
116
117
|
|
|
@@ -133,7 +134,7 @@ const { status, data } = await apiInstance.confirmOrder(
|
|
|
133
134
|
| Status code | Description | Response headers |
|
|
134
135
|
|-------------|-------------|------------------|
|
|
135
136
|
|**200** | Order schema | - |
|
|
136
|
-
|**400** | Failed validation | - |
|
|
137
|
+
|**400** | Failed validation for the confirm request. When the error relates to item fulfillment issues (e.g. stock or availability problems), the response includes an `errors` array with details on each affected item. | - |
|
|
137
138
|
|**401** | Not authorised to access this resource | - |
|
|
138
139
|
|**403** | Refuse to authorize | - |
|
|
139
140
|
|**404** | Resource not found | - |
|
|
@@ -158,7 +159,7 @@ import {
|
|
|
158
159
|
const configuration = new Configuration();
|
|
159
160
|
const apiInstance = new OrdersApi(configuration);
|
|
160
161
|
|
|
161
|
-
let project: string; //
|
|
162
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
162
163
|
let createOrder: CreateOrder; //Create Order schema
|
|
163
164
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
164
165
|
|
|
@@ -174,7 +175,7 @@ const { status, data } = await apiInstance.createOrder(
|
|
|
174
175
|
|Name | Type | Description | Notes|
|
|
175
176
|
|------------- | ------------- | ------------- | -------------|
|
|
176
177
|
| **createOrder** | **CreateOrder**| Create Order schema | |
|
|
177
|
-
| **project** | [**string**] |
|
|
178
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
178
179
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
179
180
|
|
|
180
181
|
|
|
@@ -219,7 +220,7 @@ import {
|
|
|
219
220
|
const configuration = new Configuration();
|
|
220
221
|
const apiInstance = new OrdersApi(configuration);
|
|
221
222
|
|
|
222
|
-
let project: string; //
|
|
223
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
223
224
|
let orderId: string; //Unique identifier of an order (default to undefined)
|
|
224
225
|
|
|
225
226
|
const { status, data } = await apiInstance.downloadInvoice(
|
|
@@ -232,7 +233,7 @@ const { status, data } = await apiInstance.downloadInvoice(
|
|
|
232
233
|
|
|
233
234
|
|Name | Type | Description | Notes|
|
|
234
235
|
|------------- | ------------- | ------------- | -------------|
|
|
235
|
-
| **project** | [**string**] |
|
|
236
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
236
237
|
| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
|
|
237
238
|
|
|
238
239
|
|
|
@@ -278,9 +279,9 @@ import {
|
|
|
278
279
|
const configuration = new Configuration();
|
|
279
280
|
const apiInstance = new OrdersApi(configuration);
|
|
280
281
|
|
|
281
|
-
let project: string; //
|
|
282
|
-
let start: string; //Start of date range to filter by when orders were placed (default to undefined)
|
|
283
|
-
let end: string; //End of date range (optional) (default to undefined)
|
|
282
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
283
|
+
let start: string; //Start of the date range to filter by when orders were placed. (default to undefined)
|
|
284
|
+
let end: string; //End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
284
285
|
let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
|
|
285
286
|
|
|
286
287
|
const { status, data } = await apiInstance.exportOrders(
|
|
@@ -295,9 +296,9 @@ const { status, data } = await apiInstance.exportOrders(
|
|
|
295
296
|
|
|
296
297
|
|Name | Type | Description | Notes|
|
|
297
298
|
|------------- | ------------- | ------------- | -------------|
|
|
298
|
-
| **project** | [**string**] |
|
|
299
|
-
| **start** | [**string**] | Start of date range to filter by when orders were placed | defaults to undefined|
|
|
300
|
-
| **end** | [**string**] | End of date range | (optional) defaults to undefined|
|
|
299
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
300
|
+
| **start** | [**string**] | Start of the date range to filter by when orders were placed. | defaults to undefined|
|
|
301
|
+
| **end** | [**string**] | End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
301
302
|
| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
|
|
302
303
|
|
|
303
304
|
|
|
@@ -344,7 +345,7 @@ import {
|
|
|
344
345
|
const configuration = new Configuration();
|
|
345
346
|
const apiInstance = new OrdersApi(configuration);
|
|
346
347
|
|
|
347
|
-
let project: string; //
|
|
348
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
348
349
|
let orderId: string; //Unique identifier of an order (default to undefined)
|
|
349
350
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
350
351
|
|
|
@@ -359,7 +360,7 @@ const { status, data } = await apiInstance.getOrder(
|
|
|
359
360
|
|
|
360
361
|
|Name | Type | Description | Notes|
|
|
361
362
|
|------------- | ------------- | ------------- | -------------|
|
|
362
|
-
| **project** | [**string**] |
|
|
363
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
363
364
|
| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
|
|
364
365
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
365
366
|
|
|
@@ -406,15 +407,15 @@ import {
|
|
|
406
407
|
const configuration = new Configuration();
|
|
407
408
|
const apiInstance = new OrdersApi(configuration);
|
|
408
409
|
|
|
409
|
-
let project: string; //
|
|
410
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
410
411
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
411
412
|
let pageToken: number; //Page reference token (optional) (default to 1)
|
|
412
413
|
let pageSize: number; //Max page size. This is the maximum page size that will be returned, but it might be smaller. (optional) (default to 100)
|
|
413
414
|
let search: string; //Search term to filter based on order reference, customer name and email (optional) (default to undefined)
|
|
414
|
-
let ids: Array<string>; //
|
|
415
|
-
let statuses: Array<Status>; //Filter by
|
|
416
|
-
let start: string; //Start of date range (optional) (default to undefined)
|
|
417
|
-
let end: string; //End of date range (optional) (default to undefined)
|
|
415
|
+
let ids: Array<string>; //Filter to specific order IDs. Only orders matching these IDs will be returned. (optional) (default to undefined)
|
|
416
|
+
let statuses: Array<Status>; //Filter by order status. Only orders matching one of the given statuses will be returned. (optional) (default to undefined)
|
|
417
|
+
let start: string; //Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
418
|
+
let end: string; //End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. (optional) (default to undefined)
|
|
418
419
|
let dateFilterType: 'createdAt' | 'updatedAt' | 'statusChangedAt'; //Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. (optional) (default to 'createdAt')
|
|
419
420
|
|
|
420
421
|
const { status, data } = await apiInstance.getOrders(
|
|
@@ -435,15 +436,15 @@ const { status, data } = await apiInstance.getOrders(
|
|
|
435
436
|
|
|
436
437
|
|Name | Type | Description | Notes|
|
|
437
438
|
|------------- | ------------- | ------------- | -------------|
|
|
438
|
-
| **project** | [**string**] |
|
|
439
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
439
440
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
440
441
|
| **pageToken** | [**number**] | Page reference token | (optional) defaults to 1|
|
|
441
442
|
| **pageSize** | [**number**] | Max page size. This is the maximum page size that will be returned, but it might be smaller. | (optional) defaults to 100|
|
|
442
443
|
| **search** | [**string**] | Search term to filter based on order reference, customer name and email | (optional) defaults to undefined|
|
|
443
|
-
| **ids** | **Array<string>** |
|
|
444
|
-
| **statuses** | **Array<Status>** | Filter by
|
|
445
|
-
| **start** | [**string**] | Start of date range | (optional) defaults to undefined|
|
|
446
|
-
| **end** | [**string**] | End of date range | (optional) defaults to undefined|
|
|
444
|
+
| **ids** | **Array<string>** | Filter to specific order IDs. Only orders matching these IDs will be returned. | (optional) defaults to undefined|
|
|
445
|
+
| **statuses** | **Array<Status>** | Filter by order status. Only orders matching one of the given statuses will be returned. | (optional) defaults to undefined|
|
|
446
|
+
| **start** | [**string**] | Start of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
447
|
+
| **end** | [**string**] | End of date range filter. Which date field this applies to is controlled by the `dateFilterType` parameter. | (optional) defaults to undefined|
|
|
447
448
|
| **dateFilterType** | [**'createdAt' | 'updatedAt' | 'statusChangedAt'**]**Array<'createdAt' | 'updatedAt' | 'statusChangedAt'>** | Specifies the type of date range filter to apply. Determines which date field the `start` and `end` fields should query. | (optional) defaults to 'createdAt'|
|
|
448
449
|
|
|
449
450
|
|
|
@@ -472,6 +473,65 @@ const { status, data } = await apiInstance.getOrders(
|
|
|
472
473
|
|
|
473
474
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
474
475
|
|
|
476
|
+
# **importOrders**
|
|
477
|
+
> ImportOrders202Response importOrders()
|
|
478
|
+
|
|
479
|
+
Initiates an order import from a CSV file. The import is processed asynchronously.
|
|
480
|
+
|
|
481
|
+
### Example
|
|
482
|
+
|
|
483
|
+
```typescript
|
|
484
|
+
import {
|
|
485
|
+
OrdersApi,
|
|
486
|
+
Configuration
|
|
487
|
+
} from '@teemill/orders';
|
|
488
|
+
|
|
489
|
+
const configuration = new Configuration();
|
|
490
|
+
const apiInstance = new OrdersApi(configuration);
|
|
491
|
+
|
|
492
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
493
|
+
let file: File; //CSV file containing order data (default to undefined)
|
|
494
|
+
|
|
495
|
+
const { status, data } = await apiInstance.importOrders(
|
|
496
|
+
project,
|
|
497
|
+
file
|
|
498
|
+
);
|
|
499
|
+
```
|
|
500
|
+
|
|
501
|
+
### Parameters
|
|
502
|
+
|
|
503
|
+
|Name | Type | Description | Notes|
|
|
504
|
+
|------------- | ------------- | ------------- | -------------|
|
|
505
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
506
|
+
| **file** | [**File**] | CSV file containing order data | defaults to undefined|
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
### Return type
|
|
510
|
+
|
|
511
|
+
**ImportOrders202Response**
|
|
512
|
+
|
|
513
|
+
### Authorization
|
|
514
|
+
|
|
515
|
+
[session-oauth](../README.md#session-oauth), [api-key](../README.md#api-key)
|
|
516
|
+
|
|
517
|
+
### HTTP request headers
|
|
518
|
+
|
|
519
|
+
- **Content-Type**: multipart/form-data
|
|
520
|
+
- **Accept**: application/json
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
### HTTP response details
|
|
524
|
+
| Status code | Description | Response headers |
|
|
525
|
+
|-------------|-------------|------------------|
|
|
526
|
+
|**202** | CSV file was accepted; orders will be imported asynchronously. | - |
|
|
527
|
+
|**400** | Failed validation | - |
|
|
528
|
+
|**401** | Not authorised to access this resource | - |
|
|
529
|
+
|**403** | Refuse to authorize | - |
|
|
530
|
+
|**404** | Resource not found | - |
|
|
531
|
+
|**500** | Unknown server error | - |
|
|
532
|
+
|
|
533
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
534
|
+
|
|
475
535
|
# **retryPlatformPayment**
|
|
476
536
|
> Order retryPlatformPayment()
|
|
477
537
|
|
|
@@ -488,7 +548,7 @@ import {
|
|
|
488
548
|
const configuration = new Configuration();
|
|
489
549
|
const apiInstance = new OrdersApi(configuration);
|
|
490
550
|
|
|
491
|
-
let project: string; //
|
|
551
|
+
let project: string; //The project identifier to scope the request to. (default to undefined)
|
|
492
552
|
let orderId: string; //Unique identifier of an order (default to undefined)
|
|
493
553
|
let fields: string; //Specifies which fields to return, separated by commas (optional) (default to undefined)
|
|
494
554
|
|
|
@@ -503,7 +563,7 @@ const { status, data } = await apiInstance.retryPlatformPayment(
|
|
|
503
563
|
|
|
504
564
|
|Name | Type | Description | Notes|
|
|
505
565
|
|------------- | ------------- | ------------- | -------------|
|
|
506
|
-
| **project** | [**string**] |
|
|
566
|
+
| **project** | [**string**] | The project identifier to scope the request to. | defaults to undefined|
|
|
507
567
|
| **orderId** | [**string**] | Unique identifier of an order | defaults to undefined|
|
|
508
568
|
| **fields** | [**string**] | Specifies which fields to return, separated by commas | (optional) defaults to undefined|
|
|
509
569
|
|
package/docs/Origin.md
CHANGED
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
# Origin
|
|
2
2
|
|
|
3
|
+
The marketing or acquisition source of the order, such as `facebook_cpc`, `google_cpc`, or `organic`.
|
|
3
4
|
|
|
4
5
|
## Properties
|
|
5
6
|
|
|
6
7
|
Name | Type | Description | Notes
|
|
7
8
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**code** | **string** |
|
|
9
|
-
**isPaid** | **boolean** |
|
|
9
|
+
**code** | **string** | A short identifier for the acquisition source, such as `facebook_cpc`, `google_cpc`, `instagram_cpc`, or `organic`. | [optional] [default to undefined]
|
|
10
|
+
**isPaid** | **boolean** | Whether this origin represents paid advertising traffic. | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
package/docs/PaymentAttempt.md
CHANGED
|
@@ -1,15 +1,14 @@
|
|
|
1
1
|
# PaymentAttempt
|
|
2
2
|
|
|
3
|
-
List of payment attempts for this order
|
|
4
3
|
|
|
5
4
|
## Properties
|
|
6
5
|
|
|
7
6
|
Name | Type | Description | Notes
|
|
8
7
|
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**paymentProvider** | **string** |
|
|
10
|
-
**status** | **string** |
|
|
11
|
-
**transactionId** | **string** |
|
|
12
|
-
**message** | **string** |
|
|
8
|
+
**paymentProvider** | **string** | The payment provider used. | [optional] [default to undefined]
|
|
9
|
+
**status** | **string** | The outcome of the payment attempt. | [optional] [default to undefined]
|
|
10
|
+
**transactionId** | **string** | The transaction ID from the payment provider. | [optional] [default to undefined]
|
|
11
|
+
**message** | **string** | A human-readable message describing the payment result. | [optional] [default to undefined]
|
|
13
12
|
**createdAt** | **string** | ISO 8601 Timestamp | [optional] [default to undefined]
|
|
14
13
|
|
|
15
14
|
## Example
|