Skip to content

Commit c6ed2af

Browse files
docs: add TSDocs for " feat(dashboard,types): add metadata form to Stock Location " (#15074)
Co-authored-by: kodiakhq[bot] <kodiakhq[bot]@users.noreply.github.com>
1 parent 2ae3978 commit c6ed2af

File tree

2 files changed

+41
-0
lines changed

2 files changed

+41
-0
lines changed

packages/core/types/src/http/stock-locations/admin/entities.ts

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,49 @@ import { AdminFulfillmentProvider } from "../../fulfillment-provider"
22
import { AdminFulfillmentSet } from "../../fulfillment-set"
33
import { AdminSalesChannel } from "../../sales-channel"
44

5+
/**
6+
* Stock location address details.
7+
*/
58
export interface AdminStockLocationAddress {
9+
/**
10+
* The ID of the stock location address.
11+
*/
612
id: string
13+
/**
14+
* The first address line of the stock location.
15+
*/
716
address_1: string
17+
/**
18+
* The second address line of the stock location.
19+
*/
820
address_2: string | null
21+
/**
22+
* The company name associated with the stock location address.
23+
*/
924
company: string | null
25+
/**
26+
* The country code of the stock location address.
27+
*/
1028
country_code: string
29+
/**
30+
* The city of the stock location address.
31+
*/
1132
city: string | null
33+
/**
34+
* The phone number of the stock location address.
35+
*/
1236
phone: string | null
37+
/**
38+
* The postal code of the stock location address.
39+
*/
1340
postal_code: string | null
41+
/**
42+
* The province of the stock location address.
43+
*/
1444
province: string | null
45+
/**
46+
* The metadata associated with the stock location address.
47+
*/
1548
metadata: Record<string, unknown> | null
1649
}
1750

@@ -26,6 +59,8 @@ export interface AdminStockLocation {
2659
name: string
2760
/**
2861
* The metadata associated with the stock location.
62+
*
63+
* @since 2.13.7
2964
*/
3065
metadata: Record<string, unknown> | null
3166
/**

packages/core/types/src/http/stock-locations/admin/payloads.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ export interface AdminUpdateStockLocation {
8585
metadata?: Record<string, unknown> | null
8686
}
8787

88+
/**
89+
* Sales channels to associate or disassociate from a stock location.
90+
*/
8891
export interface AdminUpdateStockLocationSalesChannels {
8992
/**
9093
* The IDs of the sales channels to add to the stock location.
@@ -96,6 +99,9 @@ export interface AdminUpdateStockLocationSalesChannels {
9699
remove?: string[]
97100
}
98101

102+
/**
103+
* Data for creating a fulfillment set for a stock location.
104+
*/
99105
export interface AdminCreateStockLocationFulfillmentSet {
100106
/**
101107
* The name of the fulfillment set.

0 commit comments

Comments
 (0)