@redotech/redo-api-schema 2.2.432 → 2.2.447
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/lib/openapi.d.ts +45 -7
- package/lib/openapi.yaml +49 -8
- package/package.json +1 -1
package/lib/openapi.d.ts
CHANGED
|
@@ -810,10 +810,10 @@ export interface components {
|
|
|
810
810
|
/**
|
|
811
811
|
* Created at
|
|
812
812
|
* Format: date-time
|
|
813
|
-
* @description Timestamp when the customer was created.
|
|
813
|
+
* @description Timestamp when the customer was created. May be null for older customers created before this field was tracked.
|
|
814
814
|
*/
|
|
815
|
-
createdAt
|
|
816
|
-
/** @description Custom field values as key-value pairs, where keys are field names and values can be strings, numbers, or booleans. */
|
|
815
|
+
createdAt?: string | null;
|
|
816
|
+
/** @description Custom field values as key-value pairs, where keys are field names and values can be strings, numbers, or booleans. DATE custom field values are returned as ISO 8601 datetime strings (e.g., "2026-01-15T12:00:00.000Z"), not Date objects. */
|
|
817
817
|
customFields?: {
|
|
818
818
|
[key: string]: string | number | boolean;
|
|
819
819
|
};
|
|
@@ -834,9 +834,9 @@ export interface components {
|
|
|
834
834
|
/**
|
|
835
835
|
* Updated at
|
|
836
836
|
* Format: date-time
|
|
837
|
-
* @description Timestamp when the customer was last updated.
|
|
837
|
+
* @description Timestamp when the customer was last updated. May be null for older customers created before this field was tracked.
|
|
838
838
|
*/
|
|
839
|
-
updatedAt
|
|
839
|
+
updatedAt?: string | null;
|
|
840
840
|
};
|
|
841
841
|
/** @description Email subscription updates */
|
|
842
842
|
"customer-subscription-email.schema": {
|
|
@@ -884,12 +884,19 @@ export interface components {
|
|
|
884
884
|
*/
|
|
885
885
|
"customer-upsert-request.schema": {
|
|
886
886
|
/**
|
|
887
|
-
* @description Custom field values as key-value pairs. Keys are field names and values can be strings, numbers, or booleans.
|
|
887
|
+
* @description Custom field values as key-value pairs. Keys are field names and values can be strings, numbers, or booleans. The field type is determined automatically based on the value:
|
|
888
|
+
* - String values → STRING custom field
|
|
889
|
+
* - Number values → NUMBER custom field
|
|
890
|
+
* - Boolean values → BOOLEAN custom field
|
|
891
|
+
* - ISO 8601 datetime strings (e.g., "2026-02-24T12:15:00.000Z") → DATE custom field (auto-detected)
|
|
892
|
+
*
|
|
893
|
+
* If a field name does not already have a declaration, one is created automatically. For STRING fields, unique values are tracked as options (used for segment filtering dropdowns). NUMBER, BOOLEAN, and DATE fields do not track options.
|
|
888
894
|
* @example {
|
|
889
895
|
* "subscription_source": "web",
|
|
890
896
|
* "status": "Active",
|
|
891
897
|
* "loyalty_points": 1250,
|
|
892
|
-
* "vip_member": true
|
|
898
|
+
* "vip_member": true,
|
|
899
|
+
* "signup_date": "2026-02-24T12:15:00.000Z"
|
|
893
900
|
* }
|
|
894
901
|
*/
|
|
895
902
|
customFields?: {
|
|
@@ -1171,6 +1178,32 @@ export interface components {
|
|
|
1171
1178
|
*/
|
|
1172
1179
|
name: string;
|
|
1173
1180
|
};
|
|
1181
|
+
/**
|
|
1182
|
+
* Return Dropoff
|
|
1183
|
+
* @description Dropoff entry for returns using QR-code-based drop-off methods (e.g. BlueYonder/FedEx Easy Returns)
|
|
1184
|
+
*/
|
|
1185
|
+
"return-dropoff.schema": {
|
|
1186
|
+
/**
|
|
1187
|
+
* Provider
|
|
1188
|
+
* @description Dropoff provider name (e.g. "FedEx Easy Returns", "Virtual")
|
|
1189
|
+
*/
|
|
1190
|
+
provider: string;
|
|
1191
|
+
/**
|
|
1192
|
+
* QR Code
|
|
1193
|
+
* @description Raw QR code data
|
|
1194
|
+
*/
|
|
1195
|
+
qrCode?: string;
|
|
1196
|
+
/**
|
|
1197
|
+
* QR Code URL
|
|
1198
|
+
* @description URL to a rendered QR code image
|
|
1199
|
+
*/
|
|
1200
|
+
qrCodeUrl?: string;
|
|
1201
|
+
/**
|
|
1202
|
+
* Shipment Group ID
|
|
1203
|
+
* @description ID of the shipment group this dropoff belongs to
|
|
1204
|
+
*/
|
|
1205
|
+
shipmentGroupId: string;
|
|
1206
|
+
};
|
|
1174
1207
|
/**
|
|
1175
1208
|
* Return
|
|
1176
1209
|
* @description Return read.
|
|
@@ -1204,6 +1237,11 @@ export interface components {
|
|
|
1204
1237
|
*/
|
|
1205
1238
|
phoneNumber?: components["schemas"]["phone-number.schema"];
|
|
1206
1239
|
};
|
|
1240
|
+
/**
|
|
1241
|
+
* Dropoffs
|
|
1242
|
+
* @description Array of QR-code-based dropoff entries for returns using drop-off methods such as BlueYonder/FedEx Easy Returns. Empty for standard label-based returns.
|
|
1243
|
+
*/
|
|
1244
|
+
dropoffs?: components["schemas"]["return-dropoff.schema"][];
|
|
1207
1245
|
/**
|
|
1208
1246
|
* Exchange
|
|
1209
1247
|
* @description Exchange order
|
package/lib/openapi.yaml
CHANGED
|
@@ -1943,7 +1943,7 @@ components:
|
|
|
1943
1943
|
location:
|
|
1944
1944
|
$ref: '#/components/schemas/customer-location.schema'
|
|
1945
1945
|
customFields:
|
|
1946
|
-
description: Custom field values as key-value pairs, where keys are field names and values can be strings, numbers, or booleans.
|
|
1946
|
+
description: Custom field values as key-value pairs, where keys are field names and values can be strings, numbers, or booleans. DATE custom field values are returned as ISO 8601 datetime strings (e.g., "2026-01-15T12:00:00.000Z"), not Date objects.
|
|
1947
1947
|
type: object
|
|
1948
1948
|
additionalProperties:
|
|
1949
1949
|
oneOf:
|
|
@@ -1955,25 +1955,28 @@ components:
|
|
|
1955
1955
|
status: Active
|
|
1956
1956
|
loyalty_points: 1250
|
|
1957
1957
|
vip_member: true
|
|
1958
|
+
signup_date: '2026-02-24T12:15:00.000Z'
|
|
1958
1959
|
createdAt:
|
|
1959
|
-
description: Timestamp when the customer was created.
|
|
1960
|
+
description: Timestamp when the customer was created. May be null for older customers created before this field was tracked.
|
|
1960
1961
|
format: date-time
|
|
1961
1962
|
title: Created at
|
|
1962
1963
|
examples:
|
|
1963
1964
|
- '2026-02-20T18:30:00.000Z'
|
|
1964
|
-
type:
|
|
1965
|
+
type:
|
|
1966
|
+
- string
|
|
1967
|
+
- 'null'
|
|
1965
1968
|
updatedAt:
|
|
1966
|
-
description: Timestamp when the customer was last updated.
|
|
1969
|
+
description: Timestamp when the customer was last updated. May be null for older customers created before this field was tracked.
|
|
1967
1970
|
format: date-time
|
|
1968
1971
|
title: Updated at
|
|
1969
1972
|
examples:
|
|
1970
1973
|
- '2026-02-24T12:15:00.000Z'
|
|
1971
|
-
type:
|
|
1974
|
+
type:
|
|
1975
|
+
- string
|
|
1976
|
+
- 'null'
|
|
1972
1977
|
required:
|
|
1973
1978
|
- id
|
|
1974
1979
|
- email
|
|
1975
|
-
- createdAt
|
|
1976
|
-
- updatedAt
|
|
1977
1980
|
title: Customer
|
|
1978
1981
|
type: object
|
|
1979
1982
|
customer-upsert-request.schema:
|
|
@@ -1998,7 +2001,14 @@ components:
|
|
|
1998
2001
|
location:
|
|
1999
2002
|
$ref: '#/components/schemas/customer-location.schema'
|
|
2000
2003
|
customFields:
|
|
2001
|
-
description:
|
|
2004
|
+
description: |-
|
|
2005
|
+
Custom field values as key-value pairs. Keys are field names and values can be strings, numbers, or booleans. The field type is determined automatically based on the value:
|
|
2006
|
+
- String values → STRING custom field
|
|
2007
|
+
- Number values → NUMBER custom field
|
|
2008
|
+
- Boolean values → BOOLEAN custom field
|
|
2009
|
+
- ISO 8601 datetime strings (e.g., "2026-02-24T12:15:00.000Z") → DATE custom field (auto-detected)
|
|
2010
|
+
|
|
2011
|
+
If a field name does not already have a declaration, one is created automatically. For STRING fields, unique values are tracked as options (used for segment filtering dropdowns). NUMBER, BOOLEAN, and DATE fields do not track options.
|
|
2002
2012
|
type: object
|
|
2003
2013
|
additionalProperties:
|
|
2004
2014
|
oneOf:
|
|
@@ -2010,6 +2020,7 @@ components:
|
|
|
2010
2020
|
status: Active
|
|
2011
2021
|
loyalty_points: 1250
|
|
2012
2022
|
vip_member: true
|
|
2023
|
+
signup_date: '2026-02-24T12:15:00.000Z'
|
|
2013
2024
|
required:
|
|
2014
2025
|
- email
|
|
2015
2026
|
title: Customer Upsert Request
|
|
@@ -2680,6 +2691,30 @@ components:
|
|
|
2680
2691
|
type: string
|
|
2681
2692
|
title: Return Shipment
|
|
2682
2693
|
type: object
|
|
2694
|
+
return-dropoff.schema:
|
|
2695
|
+
description: Dropoff entry for returns using QR-code-based drop-off methods (e.g. BlueYonder/FedEx Easy Returns)
|
|
2696
|
+
properties:
|
|
2697
|
+
shipmentGroupId:
|
|
2698
|
+
description: ID of the shipment group this dropoff belongs to
|
|
2699
|
+
title: Shipment Group ID
|
|
2700
|
+
type: string
|
|
2701
|
+
provider:
|
|
2702
|
+
description: Dropoff provider name (e.g. "FedEx Easy Returns", "Virtual")
|
|
2703
|
+
title: Provider
|
|
2704
|
+
type: string
|
|
2705
|
+
qrCode:
|
|
2706
|
+
description: Raw QR code data
|
|
2707
|
+
title: QR Code
|
|
2708
|
+
type: string
|
|
2709
|
+
qrCodeUrl:
|
|
2710
|
+
description: URL to a rendered QR code image
|
|
2711
|
+
title: QR Code URL
|
|
2712
|
+
type: string
|
|
2713
|
+
required:
|
|
2714
|
+
- shipmentGroupId
|
|
2715
|
+
- provider
|
|
2716
|
+
title: Return Dropoff
|
|
2717
|
+
type: object
|
|
2683
2718
|
return-status.schema:
|
|
2684
2719
|
description: |
|
|
2685
2720
|
Return status.
|
|
@@ -3157,6 +3192,12 @@ components:
|
|
|
3157
3192
|
$ref: '#/components/schemas/return-shipment.schema'
|
|
3158
3193
|
title: Shipments
|
|
3159
3194
|
type: array
|
|
3195
|
+
dropoffs:
|
|
3196
|
+
description: Array of QR-code-based dropoff entries for returns using drop-off methods such as BlueYonder/FedEx Easy Returns. Empty for standard label-based returns.
|
|
3197
|
+
items:
|
|
3198
|
+
$ref: '#/components/schemas/return-dropoff.schema'
|
|
3199
|
+
title: Dropoffs
|
|
3200
|
+
type: array
|
|
3160
3201
|
shopifyOrderIds:
|
|
3161
3202
|
description: Array of Shopify order IDs (deprecated, use externalOrderIds)
|
|
3162
3203
|
items:
|
package/package.json
CHANGED