@cloudcommerce/api
Advanced tools
Comparing version 0.0.24 to 0.0.25
@@ -49,93 +49,9 @@ /* tslint:disable */ | ||
modules?: { | ||
/** | ||
* Triggered after each term searched on storefront | ||
*/ | ||
term_searched?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered after each cart saves on storefront, just before checkout | ||
*/ | ||
cart_confirmed?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered to calculate shipping options, must return calculated values and times | ||
*/ | ||
calculate_shipping?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered when listing payments, must return available methods | ||
*/ | ||
list_payments?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered to validate and apply discout value, must return discount and conditions | ||
*/ | ||
apply_discount?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered when order is being closed, must create payment transaction and return info | ||
*/ | ||
create_transaction?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered after each order created from storefront, could return custom fields | ||
*/ | ||
checkout_done?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
term_searched?: Module; | ||
cart_confirmed?: Module1; | ||
calculate_shipping?: Module2; | ||
list_payments?: Module3; | ||
apply_discount?: Module4; | ||
create_transaction?: Module5; | ||
checkout_done?: Module6; | ||
}; | ||
@@ -203,2 +119,4 @@ /** | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -211,1 +129,92 @@ flags?: string[]; | ||
} | ||
/** | ||
* Triggered after each term searched on storefront | ||
*/ | ||
export interface Module { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered after each cart saves on storefront, just before checkout | ||
*/ | ||
export interface Module1 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered to calculate shipping options, must return calculated values and times | ||
*/ | ||
export interface Module2 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered when listing payments, must return available methods | ||
*/ | ||
export interface Module3 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered to validate and apply discout value, must return discount and conditions | ||
*/ | ||
export interface Module4 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered when order is being closed, must create payment transaction and return info | ||
*/ | ||
export interface Module5 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered after each order created from storefront, could return custom fields | ||
*/ | ||
export interface Module6 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} |
@@ -12,2 +12,5 @@ /* tslint:disable */ | ||
updated_at: string; | ||
/** | ||
* @maxItems 500 | ||
*/ | ||
store_ids: number[]; | ||
@@ -56,2 +59,4 @@ /** | ||
* List of dashboard cards chosen by user | ||
* | ||
* @maxItems 40 | ||
*/ | ||
@@ -81,2 +86,5 @@ panel_cards?: { | ||
* Aggregation pipeline | ||
* | ||
* @minItems 1 | ||
* @maxItems 50 | ||
*/ | ||
@@ -94,2 +102,4 @@ pipeline: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -96,0 +106,0 @@ flags?: string[]; |
@@ -13,2 +13,5 @@ /* tslint:disable */ | ||
store_id: number; | ||
/** | ||
* @maxItems 10 | ||
*/ | ||
channel_ids?: string[]; | ||
@@ -99,2 +102,4 @@ /** | ||
* List of brand images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -125,2 +130,4 @@ pictures?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -145,2 +152,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -147,0 +156,0 @@ flags?: string[]; |
@@ -71,2 +71,4 @@ /* tslint:disable */ | ||
* List of customers associated with this cart | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -80,2 +82,4 @@ customers?: string[]; | ||
* Products composing the cart | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -130,2 +134,4 @@ items: { | ||
* Item customization fields | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -190,2 +196,4 @@ customizations?: { | ||
* Current kit composition | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -258,2 +266,4 @@ composition?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -268,2 +278,4 @@ flags?: string[]; | ||
* List of orders completed with this cart | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -273,2 +285,4 @@ orders?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -293,2 +307,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -295,0 +311,0 @@ flags?: string[]; |
@@ -13,2 +13,5 @@ /* tslint:disable */ | ||
store_id: number; | ||
/** | ||
* @maxItems 10 | ||
*/ | ||
channel_ids?: string[]; | ||
@@ -133,2 +136,4 @@ /** | ||
* List of category images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -167,2 +172,4 @@ pictures?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -187,2 +194,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -189,0 +198,0 @@ flags?: string[]; |
@@ -80,2 +80,4 @@ /* tslint:disable */ | ||
* List of collection products | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -102,2 +104,4 @@ products?: string[]; | ||
* List of collection images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -128,2 +132,4 @@ pictures?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -148,2 +154,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -150,0 +158,0 @@ flags?: string[]; |
@@ -67,2 +67,4 @@ /* tslint:disable */ | ||
* Providers for OAuth authentication | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -89,2 +91,4 @@ oauth_providers?: { | ||
* Customer email addresses list | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -153,2 +157,4 @@ emails?: { | ||
* User profile pictures | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -158,2 +164,4 @@ photos?: string[]; | ||
* List of customer phone numbers | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -200,2 +208,4 @@ phones?: { | ||
* List of customer shipping addresses | ||
* | ||
* @maxItems 40 | ||
*/ | ||
@@ -279,2 +289,4 @@ addresses?: { | ||
* Products marked as favorites | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -284,2 +296,4 @@ favorites?: string[]; | ||
* Last products visited by the customer | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -289,2 +303,4 @@ last_visited_products?: string[]; | ||
* Last terms searched on shop by the customer | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -310,2 +326,4 @@ last_searched_terms?: string[]; | ||
* List of customer accumulated loyalty points by program and expiration | ||
* | ||
* @maxItems 1000 | ||
*/ | ||
@@ -352,2 +370,4 @@ loyalty_points_entries?: { | ||
* List of customer orders | ||
* | ||
* @maxItems 1000 | ||
*/ | ||
@@ -419,2 +439,4 @@ orders?: { | ||
* List of customer saved credit cards | ||
* | ||
* @maxItems 40 | ||
*/ | ||
@@ -458,2 +480,4 @@ credit_cards?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -478,2 +502,4 @@ metafields?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -498,2 +524,4 @@ hidden_metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -500,0 +528,0 @@ flags?: string[]; |
@@ -40,2 +40,4 @@ /* tslint:disable */ | ||
* Pre-defined options for this grid, used in specifications, customization and variations | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -86,2 +88,4 @@ options?: { | ||
* Option color palette (if the grid involves colors), starting by main color | ||
* | ||
* @maxItems 6 | ||
*/ | ||
@@ -126,2 +130,4 @@ colors?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -146,2 +152,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -148,0 +156,0 @@ flags?: string[]; |
@@ -139,2 +139,4 @@ /* tslint:disable */ | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -168,2 +170,4 @@ flags?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -223,2 +227,4 @@ flags?: string[]; | ||
* List of order customers | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -240,2 +246,4 @@ buyers?: { | ||
* List of customer email addresses | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -283,2 +291,4 @@ emails?: { | ||
* List of customer phone numbers | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -330,2 +340,4 @@ phones?: { | ||
* List of shipping methods and address for this order | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -337,151 +349,5 @@ shipping_lines?: { | ||
_id?: string; | ||
from: Address; | ||
to: Address1; | ||
/** | ||
* Sender's address | ||
*/ | ||
from: { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
}; | ||
/** | ||
* Shipping address (recipient) | ||
*/ | ||
to: { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
}; | ||
/** | ||
* Shipping object information | ||
@@ -600,2 +466,4 @@ */ | ||
* List of other additional services for this shipping line | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -618,2 +486,4 @@ other_additionals?: { | ||
* List of taxes or other additional services for this shipping line | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -694,2 +564,4 @@ taxes?: { | ||
* List of codes for delivery status follow-up | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -712,2 +584,4 @@ tracking_codes?: { | ||
* List of invoices | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -789,2 +663,4 @@ invoices?: { | ||
* List of order items related with this shipping line, use only if items are divided | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -794,2 +670,4 @@ items?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -799,2 +677,4 @@ flags?: string[]; | ||
* List of custom fields | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -818,2 +698,4 @@ custom_fields?: { | ||
* List of payment transactions for this order | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -917,77 +799,4 @@ transactions?: { | ||
}; | ||
billing_address?: Address2; | ||
/** | ||
* The mailing address associated with the payment method | ||
*/ | ||
billing_address?: { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
}; | ||
/** | ||
* Payment method (by application) chosen by customer | ||
@@ -1127,2 +936,4 @@ */ | ||
* Text lines on ticket | ||
* | ||
* @maxItems 5 | ||
*/ | ||
@@ -1217,2 +1028,4 @@ text_lines?: string[]; | ||
* List of order items related with this transaction, use only if items are divided | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1222,2 +1035,4 @@ items?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1227,2 +1042,4 @@ flags?: string[]; | ||
* List of custom fields | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1246,2 +1063,4 @@ custom_fields?: { | ||
* Historical of payments and financial status changes | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1284,2 +1103,4 @@ payments_history?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1290,2 +1111,4 @@ flags?: string[]; | ||
* Fulfillment and tracking events | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1328,2 +1151,4 @@ fulfillments?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1334,2 +1159,4 @@ flags?: string[]; | ||
* Products composing the order | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1384,2 +1211,4 @@ items?: { | ||
* Item customization fields | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1444,2 +1273,4 @@ customizations?: { | ||
* Current kit composition | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1496,2 +1327,4 @@ composition?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1531,2 +1364,4 @@ flags?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1550,2 +1385,4 @@ flags?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1570,2 +1407,4 @@ metafields?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1590,2 +1429,4 @@ hidden_metafields?: { | ||
* List of custom attributes, hidden by default, visible for the order buyers | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1610,2 +1451,4 @@ private_metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1622,1 +1465,223 @@ flags?: string[]; | ||
} | ||
/** | ||
* Sender's address | ||
*/ | ||
export interface Address { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
} | ||
/** | ||
* Shipping address (recipient) | ||
*/ | ||
export interface Address1 { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
} | ||
/** | ||
* The mailing address associated with the payment method | ||
*/ | ||
export interface Address2 { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
} |
@@ -13,2 +13,5 @@ /* tslint:disable */ | ||
store_id: number; | ||
/** | ||
* @maxItems 10 | ||
*/ | ||
channel_ids?: string[]; | ||
@@ -106,2 +109,4 @@ /** | ||
* Tags related with product for internal search | ||
* | ||
* @maxItems 200 | ||
*/ | ||
@@ -273,2 +278,4 @@ keywords?: string[]; | ||
* List of product brands | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -325,2 +332,4 @@ brands?: { | ||
* List of product categories | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -414,2 +423,4 @@ categories?: { | ||
* Grids for specifications and variations | ||
* | ||
* @maxItems 200 | ||
*/ | ||
@@ -453,2 +464,4 @@ grids?: { | ||
* Attribute to tell users the energy efficiency class of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -485,2 +498,4 @@ energy_efficiency_class?: { | ||
* Attribute to set the demographic that your product is designed for | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -517,2 +532,4 @@ age_group?: { | ||
* Specify for what gender your product is designed | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -549,2 +566,4 @@ gender?: { | ||
* Attribute to describe the main fabric or material that your product is made of | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -581,2 +600,4 @@ material?: { | ||
* Attribute to describe the pattern or graphic printed on your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -613,2 +634,4 @@ pattern?: { | ||
* Attribute to describe the standardized size of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -645,2 +668,4 @@ size?: { | ||
* Attribute to describe the cut of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -677,2 +702,4 @@ size_type?: { | ||
* Which country's sizing system your product uses | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -740,2 +767,5 @@ size_system?: { | ||
* | ||
* @minItems 1 | ||
* @maxItems 30 | ||
* | ||
* This interface was referenced by `undefined`'s JSON-Schema definition | ||
@@ -786,2 +816,4 @@ * via the `patternProperty` "^.{2,70}$". | ||
* List of product images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -801,2 +833,4 @@ pictures?: ( | ||
* List of videos related to your product | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -815,2 +849,4 @@ videos?: { | ||
* List of product customization fields | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -827,2 +863,4 @@ customizations?: ( | ||
* Product variations list | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -869,2 +907,4 @@ variations?: { | ||
* List of product NCM codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -965,2 +1005,4 @@ ncm?: string[]; | ||
* Attribute to describe the main fabric or material that your product is made of | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -997,2 +1039,4 @@ material?: { | ||
* Attribute to describe the pattern or graphic printed on your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -1029,2 +1073,4 @@ pattern?: { | ||
* Attribute to describe the standardized size of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -1092,2 +1138,5 @@ size?: { | ||
* | ||
* @minItems 1 | ||
* @maxItems 6 | ||
* | ||
* This interface was referenced by `undefined`'s JSON-Schema definition | ||
@@ -1142,2 +1191,4 @@ * via the `patternProperty` "^.{2,70}$". | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1148,2 +1199,4 @@ flags?: string[]; | ||
* If this product is a kit, set its composition | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1195,2 +1248,4 @@ kit_composition?: { | ||
* Lists of related products | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -1208,2 +1263,4 @@ related_products?: { | ||
* List of products | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1234,2 +1291,4 @@ product_ids: string[]; | ||
* List of product GTIN codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1239,2 +1298,4 @@ gtin?: string[]; | ||
* List of product MPN codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1244,2 +1305,4 @@ mpn?: string[]; | ||
* List of product NCM codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1270,2 +1333,4 @@ ncm?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1290,2 +1355,4 @@ metafields?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1310,2 +1377,4 @@ hidden_metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1312,0 +1381,0 @@ flags?: string[]; |
@@ -115,2 +115,5 @@ /* tslint:disable */ | ||
contact_cellphone?: string; | ||
/** | ||
* @maxItems 30 | ||
*/ | ||
sales_channels?: { | ||
@@ -117,0 +120,0 @@ channel_id: string; |
{ | ||
"name": "@cloudcommerce/api", | ||
"type": "module", | ||
"version": "0.0.24", | ||
"version": "0.0.25", | ||
"description": "E-Com Plus Cloud Commerce APIs client/adapter", | ||
@@ -6,0 +6,0 @@ "main": "lib/index.js", |
@@ -49,93 +49,9 @@ /* tslint:disable */ | ||
modules?: { | ||
/** | ||
* Triggered after each term searched on storefront | ||
*/ | ||
term_searched?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered after each cart saves on storefront, just before checkout | ||
*/ | ||
cart_confirmed?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered to calculate shipping options, must return calculated values and times | ||
*/ | ||
calculate_shipping?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered when listing payments, must return available methods | ||
*/ | ||
list_payments?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered to validate and apply discout value, must return discount and conditions | ||
*/ | ||
apply_discount?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered when order is being closed, must create payment transaction and return info | ||
*/ | ||
create_transaction?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
/** | ||
* Triggered after each order created from storefront, could return custom fields | ||
*/ | ||
checkout_done?: { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
}; | ||
term_searched?: Module; | ||
cart_confirmed?: Module1; | ||
calculate_shipping?: Module2; | ||
list_payments?: Module3; | ||
apply_discount?: Module4; | ||
create_transaction?: Module5; | ||
checkout_done?: Module6; | ||
}; | ||
@@ -203,2 +119,4 @@ /** | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -211,1 +129,92 @@ flags?: string[]; | ||
} | ||
/** | ||
* Triggered after each term searched on storefront | ||
*/ | ||
export interface Module { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered after each cart saves on storefront, just before checkout | ||
*/ | ||
export interface Module1 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered to calculate shipping options, must return calculated values and times | ||
*/ | ||
export interface Module2 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered when listing payments, must return available methods | ||
*/ | ||
export interface Module3 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered to validate and apply discout value, must return discount and conditions | ||
*/ | ||
export interface Module4 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered when order is being closed, must create payment transaction and return info | ||
*/ | ||
export interface Module5 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} | ||
/** | ||
* Triggered after each order created from storefront, could return custom fields | ||
*/ | ||
export interface Module6 { | ||
/** | ||
* Whether current app is enabled to handle the module requests | ||
*/ | ||
enabled: boolean; | ||
/** | ||
* URL to receive POST request of respective module | ||
*/ | ||
endpoint: string; | ||
} |
@@ -12,2 +12,5 @@ /* tslint:disable */ | ||
updated_at: string; | ||
/** | ||
* @maxItems 500 | ||
*/ | ||
store_ids: number[]; | ||
@@ -56,2 +59,4 @@ /** | ||
* List of dashboard cards chosen by user | ||
* | ||
* @maxItems 40 | ||
*/ | ||
@@ -81,2 +86,5 @@ panel_cards?: { | ||
* Aggregation pipeline | ||
* | ||
* @minItems 1 | ||
* @maxItems 50 | ||
*/ | ||
@@ -94,2 +102,4 @@ pipeline: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -96,0 +106,0 @@ flags?: string[]; |
@@ -13,2 +13,5 @@ /* tslint:disable */ | ||
store_id: number; | ||
/** | ||
* @maxItems 10 | ||
*/ | ||
channel_ids?: string[]; | ||
@@ -99,2 +102,4 @@ /** | ||
* List of brand images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -125,2 +130,4 @@ pictures?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -145,2 +152,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -147,0 +156,0 @@ flags?: string[]; |
@@ -71,2 +71,4 @@ /* tslint:disable */ | ||
* List of customers associated with this cart | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -80,2 +82,4 @@ customers?: string[]; | ||
* Products composing the cart | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -130,2 +134,4 @@ items: { | ||
* Item customization fields | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -190,2 +196,4 @@ customizations?: { | ||
* Current kit composition | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -258,2 +266,4 @@ composition?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -268,2 +278,4 @@ flags?: string[]; | ||
* List of orders completed with this cart | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -273,2 +285,4 @@ orders?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -293,2 +307,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -295,0 +311,0 @@ flags?: string[]; |
@@ -13,2 +13,5 @@ /* tslint:disable */ | ||
store_id: number; | ||
/** | ||
* @maxItems 10 | ||
*/ | ||
channel_ids?: string[]; | ||
@@ -133,2 +136,4 @@ /** | ||
* List of category images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -167,2 +172,4 @@ pictures?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -187,2 +194,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -189,0 +198,0 @@ flags?: string[]; |
@@ -80,2 +80,4 @@ /* tslint:disable */ | ||
* List of collection products | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -102,2 +104,4 @@ products?: string[]; | ||
* List of collection images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -128,2 +132,4 @@ pictures?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -148,2 +154,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -150,0 +158,0 @@ flags?: string[]; |
@@ -67,2 +67,4 @@ /* tslint:disable */ | ||
* Providers for OAuth authentication | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -89,2 +91,4 @@ oauth_providers?: { | ||
* Customer email addresses list | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -153,2 +157,4 @@ emails?: { | ||
* User profile pictures | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -158,2 +164,4 @@ photos?: string[]; | ||
* List of customer phone numbers | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -200,2 +208,4 @@ phones?: { | ||
* List of customer shipping addresses | ||
* | ||
* @maxItems 40 | ||
*/ | ||
@@ -279,2 +289,4 @@ addresses?: { | ||
* Products marked as favorites | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -284,2 +296,4 @@ favorites?: string[]; | ||
* Last products visited by the customer | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -289,2 +303,4 @@ last_visited_products?: string[]; | ||
* Last terms searched on shop by the customer | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -310,2 +326,4 @@ last_searched_terms?: string[]; | ||
* List of customer accumulated loyalty points by program and expiration | ||
* | ||
* @maxItems 1000 | ||
*/ | ||
@@ -352,2 +370,4 @@ loyalty_points_entries?: { | ||
* List of customer orders | ||
* | ||
* @maxItems 1000 | ||
*/ | ||
@@ -419,2 +439,4 @@ orders?: { | ||
* List of customer saved credit cards | ||
* | ||
* @maxItems 40 | ||
*/ | ||
@@ -458,2 +480,4 @@ credit_cards?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -478,2 +502,4 @@ metafields?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -498,2 +524,4 @@ hidden_metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -500,0 +528,0 @@ flags?: string[]; |
@@ -40,2 +40,4 @@ /* tslint:disable */ | ||
* Pre-defined options for this grid, used in specifications, customization and variations | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -86,2 +88,4 @@ options?: { | ||
* Option color palette (if the grid involves colors), starting by main color | ||
* | ||
* @maxItems 6 | ||
*/ | ||
@@ -126,2 +130,4 @@ colors?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -146,2 +152,4 @@ metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -148,0 +156,0 @@ flags?: string[]; |
@@ -139,2 +139,4 @@ /* tslint:disable */ | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -168,2 +170,4 @@ flags?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -223,2 +227,4 @@ flags?: string[]; | ||
* List of order customers | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -240,2 +246,4 @@ buyers?: { | ||
* List of customer email addresses | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -283,2 +291,4 @@ emails?: { | ||
* List of customer phone numbers | ||
* | ||
* @maxItems 20 | ||
*/ | ||
@@ -330,2 +340,4 @@ phones?: { | ||
* List of shipping methods and address for this order | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -337,151 +349,5 @@ shipping_lines?: { | ||
_id?: string; | ||
from: Address; | ||
to: Address1; | ||
/** | ||
* Sender's address | ||
*/ | ||
from: { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
}; | ||
/** | ||
* Shipping address (recipient) | ||
*/ | ||
to: { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
}; | ||
/** | ||
* Shipping object information | ||
@@ -600,2 +466,4 @@ */ | ||
* List of other additional services for this shipping line | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -618,2 +486,4 @@ other_additionals?: { | ||
* List of taxes or other additional services for this shipping line | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -694,2 +564,4 @@ taxes?: { | ||
* List of codes for delivery status follow-up | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -712,2 +584,4 @@ tracking_codes?: { | ||
* List of invoices | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -789,2 +663,4 @@ invoices?: { | ||
* List of order items related with this shipping line, use only if items are divided | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -794,2 +670,4 @@ items?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -799,2 +677,4 @@ flags?: string[]; | ||
* List of custom fields | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -818,2 +698,4 @@ custom_fields?: { | ||
* List of payment transactions for this order | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -917,77 +799,4 @@ transactions?: { | ||
}; | ||
billing_address?: Address2; | ||
/** | ||
* The mailing address associated with the payment method | ||
*/ | ||
billing_address?: { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
}; | ||
/** | ||
* Payment method (by application) chosen by customer | ||
@@ -1127,2 +936,4 @@ */ | ||
* Text lines on ticket | ||
* | ||
* @maxItems 5 | ||
*/ | ||
@@ -1217,2 +1028,4 @@ text_lines?: string[]; | ||
* List of order items related with this transaction, use only if items are divided | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1222,2 +1035,4 @@ items?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1227,2 +1042,4 @@ flags?: string[]; | ||
* List of custom fields | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1246,2 +1063,4 @@ custom_fields?: { | ||
* Historical of payments and financial status changes | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1284,2 +1103,4 @@ payments_history?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1290,2 +1111,4 @@ flags?: string[]; | ||
* Fulfillment and tracking events | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1328,2 +1151,4 @@ fulfillments?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1334,2 +1159,4 @@ flags?: string[]; | ||
* Products composing the order | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -1384,2 +1211,4 @@ items?: { | ||
* Item customization fields | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1444,2 +1273,4 @@ customizations?: { | ||
* Current kit composition | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1496,2 +1327,4 @@ composition?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1531,2 +1364,4 @@ flags?: string[]; | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1550,2 +1385,4 @@ flags?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1570,2 +1407,4 @@ metafields?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1590,2 +1429,4 @@ hidden_metafields?: { | ||
* List of custom attributes, hidden by default, visible for the order buyers | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1610,2 +1451,4 @@ private_metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1622,1 +1465,223 @@ flags?: string[]; | ||
} | ||
/** | ||
* Sender's address | ||
*/ | ||
export interface Address { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
} | ||
/** | ||
* Shipping address (recipient) | ||
*/ | ||
export interface Address1 { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
} | ||
/** | ||
* The mailing address associated with the payment method | ||
*/ | ||
export interface Address2 { | ||
/** | ||
* ZIP (CEP, postal...) code | ||
*/ | ||
zip: string; | ||
/** | ||
* Street or public place name | ||
*/ | ||
street?: string; | ||
/** | ||
* House or building street number | ||
*/ | ||
number?: number; | ||
/** | ||
* Address complement or second line, such as apartment number | ||
*/ | ||
complement?: string; | ||
/** | ||
* Borough name | ||
*/ | ||
borough?: string; | ||
/** | ||
* Some optional other reference for this address | ||
*/ | ||
near_to?: string; | ||
/** | ||
* Full in line mailing address, should include street, number and borough | ||
*/ | ||
line_address?: string; | ||
/** | ||
* City name | ||
*/ | ||
city?: string; | ||
/** | ||
* Country name | ||
*/ | ||
country?: string; | ||
/** | ||
* An ISO 3166-2 country code | ||
*/ | ||
country_code?: string; | ||
/** | ||
* Province or state name | ||
*/ | ||
province?: string; | ||
/** | ||
* The two-letter code for the province or state | ||
*/ | ||
province_code?: string; | ||
/** | ||
* The name of recipient, generally is the customer's name | ||
*/ | ||
name?: string; | ||
/** | ||
* The recipient's last name | ||
*/ | ||
last_name?: string; | ||
/** | ||
* Customer phone number for this mailing address | ||
*/ | ||
phone?: { | ||
/** | ||
* Country calling code (without +), defined by standards E.123 and E.164 | ||
*/ | ||
country_code?: number; | ||
/** | ||
* The actual phone number, digits only | ||
*/ | ||
number: string; | ||
}; | ||
} |
@@ -13,2 +13,5 @@ /* tslint:disable */ | ||
store_id: number; | ||
/** | ||
* @maxItems 10 | ||
*/ | ||
channel_ids?: string[]; | ||
@@ -106,2 +109,4 @@ /** | ||
* Tags related with product for internal search | ||
* | ||
* @maxItems 200 | ||
*/ | ||
@@ -273,2 +278,4 @@ keywords?: string[]; | ||
* List of product brands | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -325,2 +332,4 @@ brands?: { | ||
* List of product categories | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -414,2 +423,4 @@ categories?: { | ||
* Grids for specifications and variations | ||
* | ||
* @maxItems 200 | ||
*/ | ||
@@ -453,2 +464,4 @@ grids?: { | ||
* Attribute to tell users the energy efficiency class of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -485,2 +498,4 @@ energy_efficiency_class?: { | ||
* Attribute to set the demographic that your product is designed for | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -517,2 +532,4 @@ age_group?: { | ||
* Specify for what gender your product is designed | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -549,2 +566,4 @@ gender?: { | ||
* Attribute to describe the main fabric or material that your product is made of | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -581,2 +600,4 @@ material?: { | ||
* Attribute to describe the pattern or graphic printed on your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -613,2 +634,4 @@ pattern?: { | ||
* Attribute to describe the standardized size of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -645,2 +668,4 @@ size?: { | ||
* Attribute to describe the cut of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -677,2 +702,4 @@ size_type?: { | ||
* Which country's sizing system your product uses | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -740,2 +767,5 @@ size_system?: { | ||
* | ||
* @minItems 1 | ||
* @maxItems 30 | ||
* | ||
* This interface was referenced by `undefined`'s JSON-Schema definition | ||
@@ -786,2 +816,4 @@ * via the `patternProperty` "^.{2,70}$". | ||
* List of product images | ||
* | ||
* @maxItems 50 | ||
*/ | ||
@@ -801,2 +833,4 @@ pictures?: ( | ||
* List of videos related to your product | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -815,2 +849,4 @@ videos?: { | ||
* List of product customization fields | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -827,2 +863,4 @@ customizations?: ( | ||
* Product variations list | ||
* | ||
* @maxItems 3000 | ||
*/ | ||
@@ -869,2 +907,4 @@ variations?: { | ||
* List of product NCM codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -965,2 +1005,4 @@ ncm?: string[]; | ||
* Attribute to describe the main fabric or material that your product is made of | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -997,2 +1039,4 @@ material?: { | ||
* Attribute to describe the pattern or graphic printed on your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -1029,2 +1073,4 @@ pattern?: { | ||
* Attribute to describe the standardized size of your product | ||
* | ||
* @maxItems 1 | ||
*/ | ||
@@ -1092,2 +1138,5 @@ size?: { | ||
* | ||
* @minItems 1 | ||
* @maxItems 6 | ||
* | ||
* This interface was referenced by `undefined`'s JSON-Schema definition | ||
@@ -1142,2 +1191,4 @@ * via the `patternProperty` "^.{2,70}$". | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1148,2 +1199,4 @@ flags?: string[]; | ||
* If this product is a kit, set its composition | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1195,2 +1248,4 @@ kit_composition?: { | ||
* Lists of related products | ||
* | ||
* @maxItems 30 | ||
*/ | ||
@@ -1208,2 +1263,4 @@ related_products?: { | ||
* List of products | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1234,2 +1291,4 @@ product_ids: string[]; | ||
* List of product GTIN codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1239,2 +1298,4 @@ gtin?: string[]; | ||
* List of product MPN codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1244,2 +1305,4 @@ mpn?: string[]; | ||
* List of product NCM codes | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1270,2 +1333,4 @@ ncm?: string[]; | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1290,2 +1355,4 @@ metafields?: { | ||
* List of custom attributes | ||
* | ||
* @maxItems 100 | ||
*/ | ||
@@ -1310,2 +1377,4 @@ hidden_metafields?: { | ||
* Flags to associate additional info | ||
* | ||
* @maxItems 10 | ||
*/ | ||
@@ -1312,0 +1381,0 @@ flags?: string[]; |
@@ -115,2 +115,5 @@ /* tslint:disable */ | ||
contact_cellphone?: string; | ||
/** | ||
* @maxItems 30 | ||
*/ | ||
sales_channels?: { | ||
@@ -117,0 +120,0 @@ channel_id: string; |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
267704
10633