├── .depcheckignore ├── .depcheckrc.yml ├── .eslintignore ├── .eslintrc.json ├── .git2gus └── config.json ├── .github ├── CODEOWNERS └── workflows │ ├── publish.yml │ └── test.yml ├── .gitignore ├── .lintstagedrc ├── .npmignore ├── .nvmrc ├── .prettierrc ├── .snyk ├── .stylelintrc ├── CHANGELOG.md ├── CODE_OF_CONDUCT.md ├── Contributing.md ├── LICENSE.txt ├── README.md ├── SECURITY.md ├── __mocks__ └── @commerce-apps │ └── raml-toolkit.js ├── apis ├── shopper-baskets │ ├── .metadata.json │ ├── examples │ │ ├── basket │ │ │ ├── basket-get-response.raml │ │ │ ├── basket-item-tax-get-response.raml │ │ │ ├── basket-item-tax-put-request.raml │ │ │ ├── basket-patch-request.raml │ │ │ ├── basket-patch-response.raml │ │ │ ├── basket-post-request.raml │ │ │ ├── basket-post-response.raml │ │ │ ├── basket-put-agent-response.raml │ │ │ ├── basket-put-storefront-response.raml │ │ │ ├── basket-tax-get-response.raml │ │ │ ├── basket-tax-put-request.raml │ │ │ ├── billing-address-put-request.raml │ │ │ ├── billing-address-put-response.raml │ │ │ ├── coupon-code-post-request.raml │ │ │ ├── coupon-code-post-response.raml │ │ │ ├── customer-put-request.raml │ │ │ ├── customer-put-response.raml │ │ │ ├── gift-cert-patch-request.raml │ │ │ ├── gift-cert-patch-response.raml │ │ │ ├── gift-cert-post-request.raml │ │ │ ├── gift-cert-post-response.raml │ │ │ ├── item-patch-request.raml │ │ │ ├── item-patch-response.raml │ │ │ ├── item-post-request.raml │ │ │ ├── item-post-response.raml │ │ │ ├── items-patch-request.raml │ │ │ ├── items-patch-response.raml │ │ │ ├── payment-instrument-patch-request.raml │ │ │ ├── payment-instrument-patch-response.raml │ │ │ ├── payment-instrument-post-request.raml │ │ │ ├── payment-instrument-post-response.raml │ │ │ ├── payment-methods-get-response.raml │ │ │ ├── price-adjustment-patch-request.raml │ │ │ ├── price-adjustment-patch-response.raml │ │ │ ├── price-adjustment-post-request.raml │ │ │ ├── price-adjustment-post-response.raml │ │ │ ├── price-books.raml │ │ │ ├── shipments-address-put-request.raml │ │ │ ├── shipments-address-put-response.raml │ │ │ ├── shipments-method-get-response.raml │ │ │ ├── shipments-method-put-request.raml │ │ │ ├── shipments-method-put-response.raml │ │ │ ├── shipments-patch-request.raml │ │ │ ├── shipments-patch-response.raml │ │ │ ├── shipments-post-request.raml │ │ │ └── shipments-post-response.raml │ │ └── error │ │ │ ├── basket-merge-exception.raml │ │ │ ├── basket-transfer-exception.raml │ │ │ ├── customer-basket-quota-exceeded-exception.raml │ │ │ ├── customer-temporary-basket-quota-exceeded-exception.raml │ │ │ ├── price-adjustment-id-not-found-exception.raml │ │ │ ├── slas-jwt-exception.raml │ │ │ └── source-basket-exception.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ ├── checkout-data-types │ │ │ └── 2.0.6 │ │ │ │ ├── checkout-data-types.raml │ │ │ │ ├── examples │ │ │ │ └── error │ │ │ │ │ ├── bad-request-auth.raml │ │ │ │ │ ├── bad-request-example.raml │ │ │ │ │ ├── basket-not-found.raml │ │ │ │ │ ├── forbidden.raml │ │ │ │ │ ├── invalid-tax-mode.raml │ │ │ │ │ ├── order-not-found.raml │ │ │ │ │ ├── shipment-not-found.raml │ │ │ │ │ └── unsupported-request.raml │ │ │ │ └── exchange.json │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-baskets-description.md │ ├── shopper-baskets-traits.raml │ └── shopper-baskets.raml ├── shopper-context │ ├── .metadata.json │ ├── Examples │ │ ├── shopper-context-400-example.raml │ │ ├── shopper-context-401-example.raml │ │ ├── shopper-context-403-example.raml │ │ ├── shopper-context-404-example.raml │ │ ├── shopper-context-example.raml │ │ ├── shopper-context-update-request-example.raml │ │ └── shopper-context-update-response-example.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-context-description.md │ └── shopper-context.raml ├── shopper-customers │ ├── .metadata.json │ ├── Customer-traits-library.raml │ ├── Examples │ │ ├── Basket.raml │ │ ├── BonusDiscountLineItem.raml │ │ ├── BundledProduct.raml │ │ ├── CouponItem.raml │ │ ├── Customer.raml │ │ ├── CustomerAddressRequest.raml │ │ ├── CustomerAddressResponse.raml │ │ ├── CustomerAddressResult.raml │ │ ├── CustomerBasketsResult.raml │ │ ├── CustomerExternalProfile.raml │ │ ├── CustomerPaymentInstrument.raml │ │ ├── CustomerPaymentInstrumentRequest.raml │ │ ├── CustomerPaymentInstrumentResult.raml │ │ ├── CustomerProductList.raml │ │ ├── CustomerProductListItem.raml │ │ ├── CustomerProductListItemRequest.raml │ │ ├── CustomerProductListItemResult.raml │ │ ├── CustomerProductListRequest.raml │ │ ├── CustomerProductListResult.raml │ │ ├── CustomerRegistrationRequest.raml │ │ ├── CustomerRegistrationResponse.raml │ │ ├── CustomersOrdersResult.raml │ │ ├── ExternalProfileRequest.raml │ │ ├── GetCustomerProductListByListId.raml │ │ ├── PostCustomerProductList.raml │ │ ├── PublicProductListItem.raml │ │ ├── ResetPasswordRequest.raml │ │ ├── ResetTokenResult.raml │ │ ├── TrustedAuthResponse.raml │ │ ├── UpdateCustomerProductListByListId.raml │ │ ├── UpdateCustomerProductListItem.raml │ │ ├── UpdateCustomerRequest.raml │ │ ├── UpdateCustomerResponse.raml │ │ ├── guestAuthResponse.raml │ │ ├── productLists-result-example.raml │ │ ├── productListsID-result-example.raml │ │ └── productListsIDItems-result-example.raml │ ├── Traits │ │ ├── BadRequest.raml │ │ ├── CustomerAuthenticationFailed.raml │ │ ├── ExternalProfileBadRequest.raml │ │ ├── ExternalProfileNotFound.raml │ │ ├── NotFound.raml │ │ └── Unauthorized.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-customers-description.md │ └── shopper-customers.raml ├── shopper-discovery-search │ ├── .metadata.json │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.9 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── error-response.raml │ │ │ │ ├── identifers.raml │ │ │ │ └── pagination-types.raml │ │ │ │ ├── example.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── securitySchemes │ │ │ │ └── gdot.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ ├── commerce-cloud-standards │ │ │ └── 1.0.16 │ │ │ │ ├── Documentation │ │ │ │ ├── ErrorResponseMapping.raml │ │ │ │ └── baseUri.raml │ │ │ │ ├── Examples │ │ │ │ ├── BoolFilter.json │ │ │ │ ├── BoolQuery.json │ │ │ │ ├── BoolQuery.raml │ │ │ │ ├── Filter.json │ │ │ │ ├── FilteredQuery.json │ │ │ │ ├── NestedQuery.json │ │ │ │ ├── PaginatedSearchResultBase.json │ │ │ │ ├── Query.json │ │ │ │ ├── QueryFilter.json │ │ │ │ ├── Range2Filter.json │ │ │ │ ├── RangeFilter.json │ │ │ │ ├── SearchRequestBase.json │ │ │ │ ├── SimpleSearchResultBase.json │ │ │ │ ├── TermFilter.json │ │ │ │ ├── TermQuery.json │ │ │ │ └── TextQuery.json │ │ │ │ ├── SecuritySchemes │ │ │ │ ├── am-oauth-2.raml │ │ │ │ ├── bearer-token.raml │ │ │ │ └── shopper-token.raml │ │ │ │ ├── Types │ │ │ │ ├── ISO-standards.raml │ │ │ │ ├── additional-properties.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── search-types.raml │ │ │ │ ├── commerce-cloud-standards.raml │ │ │ │ ├── example.raml │ │ │ │ └── exchange.json │ │ │ ├── discovery-examples │ │ │ └── 1.0.2 │ │ │ │ ├── discovery-examples.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── results-400-error-example.raml │ │ │ │ ├── results-example.raml │ │ │ │ ├── suggestions-400-error-example.raml │ │ │ │ └── suggestions-example.raml │ │ │ ├── discovery-query-common-library │ │ │ └── 1.0.8 │ │ │ │ ├── discovery-facet-library.raml │ │ │ │ ├── discovery-grouping-library.raml │ │ │ │ ├── discovery-query-library.raml │ │ │ │ ├── discovery-query-output-library.raml │ │ │ │ ├── discovery-refinement-library.raml │ │ │ │ ├── discovery-sorting-library.raml │ │ │ │ ├── discovery-suggestion-library.raml │ │ │ │ └── exchange.json │ │ │ └── discovery-standards │ │ │ └── 0.0.27 │ │ │ ├── Errors │ │ │ ├── Examples │ │ │ │ ├── Authentication.json │ │ │ │ ├── Authorization.json │ │ │ │ ├── InternalServerError.json │ │ │ │ ├── InvalidRequest.json │ │ │ │ ├── LimitExceeded.json │ │ │ │ ├── NonReadableHttpMessage.json │ │ │ │ ├── NotFound.json │ │ │ │ ├── RateLimitExceeded.json │ │ │ │ └── ServiceUnavailable.json │ │ │ ├── Traits │ │ │ │ ├── common-errors.raml │ │ │ │ └── resource-common-errors.raml │ │ │ └── discovery-error-types.raml │ │ │ ├── Traits │ │ │ ├── bulk-retrieval-filters.raml │ │ │ └── traceable.raml │ │ │ ├── Types │ │ │ ├── base-uri-parameters.raml │ │ │ ├── date-times.raml │ │ │ ├── expansion-attribute.raml │ │ │ ├── identifiers.raml │ │ │ └── links.raml │ │ │ ├── discovery-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── ramltojaxrs.raml │ ├── shopper-discovery-search-description.md │ └── shopper-discovery-search.raml ├── shopper-experience │ ├── .metadata.json │ ├── Examples │ │ ├── carousel-regions-example.raml │ │ ├── header-components-example.raml │ │ └── storepage-regions-example.raml │ ├── Experience-traits-library.raml │ ├── Traits │ │ ├── AspectAttributesInvalid.raml │ │ ├── AspectTypeNotFound.raml │ │ ├── BusinessObjectIdInvalid.raml │ │ ├── LocaleSpecific.raml │ │ └── PageNotFound.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-experience-description.md │ └── shopper-experience.raml ├── shopper-gift-certificates │ ├── .metadata.json │ ├── Examples │ │ └── gift-certificate-example.raml │ ├── Traits │ │ └── NotFoundException.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── gift-certificate-traits-library.raml │ ├── shopper-gift-certificates-description.md │ └── shopper-gift-certificates.raml ├── shopper-orders │ ├── .metadata.json │ ├── examples │ │ └── order │ │ │ ├── order-get-response.raml │ │ │ ├── order-lookup-request.raml │ │ │ ├── order-patch-response.raml │ │ │ ├── order-post-request.raml │ │ │ ├── order-post-response.raml │ │ │ ├── order-tax-get-response.raml │ │ │ ├── payment-instrument-patch-request.raml │ │ │ ├── payment-instrument-patch-response.raml │ │ │ ├── payment-instrument-post-request.raml │ │ │ ├── payment-instrument-post-response.raml │ │ │ └── payment-methods-get-response.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ ├── checkout-data-types │ │ │ └── 2.0.5 │ │ │ │ ├── checkout-data-types.raml │ │ │ │ ├── examples │ │ │ │ └── error │ │ │ │ │ ├── bad-request-auth.raml │ │ │ │ │ ├── bad-request-example.raml │ │ │ │ │ ├── basket-not-found.raml │ │ │ │ │ ├── forbidden.raml │ │ │ │ │ ├── invalid-tax-mode.raml │ │ │ │ │ ├── order-not-found.raml │ │ │ │ │ ├── shipment-not-found.raml │ │ │ │ │ └── unsupported-request.raml │ │ │ │ └── exchange.json │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── order-lookup-description.md │ ├── shopper-orders-description.md │ ├── shopper-orders-traits.raml │ └── shopper-orders.raml ├── shopper-products │ ├── .metadata.json │ ├── Examples │ │ ├── category-example.raml │ │ ├── category-result-example.raml │ │ ├── product-example.raml │ │ └── product-result-example.raml │ ├── Traits │ │ ├── BadRequest.raml │ │ ├── GetProductBadRequest.raml │ │ ├── GetProductsBadRequest.raml │ │ ├── NotFound.raml │ │ ├── Unauthorized.raml │ │ └── product-example.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── products-traits-library.raml │ ├── shopper-products-description.md │ └── shopper-products.raml ├── shopper-promotions │ ├── .metadata.json │ ├── Examples │ │ ├── get_campaings_400.raml │ │ └── promotions_result.raml │ ├── Traits │ │ ├── PromotionNotFound.raml │ │ └── badrequest.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── promotion-traits-library.raml │ ├── shopper-promotions-description.md │ └── shopper-promotions.raml ├── shopper-search │ ├── .metadata.json │ ├── Examples │ │ ├── product-search-400-error-example.raml │ │ ├── product-search-result-example.raml │ │ ├── search-suggestion-400-error-example.raml │ │ └── search-suggestion-result-example.raml │ ├── Traits │ │ ├── ProductSearchSelectBadRequest.raml │ │ └── Unauthorized.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-search-description.md │ ├── shopper-search-library.raml │ └── shopper-search.raml ├── shopper-seo │ ├── .metadata.json │ ├── Example │ │ └── seo-url-mapping-response-example.raml │ ├── Traits │ │ ├── BadRequest.raml │ │ ├── NotFound.raml │ │ ├── ShopperSeoTrait.raml │ │ └── Unauthorized.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-seo-description.md │ ├── shopper-seo-library.raml │ └── shopper-seo.raml ├── shopper-stores │ ├── .metadata.json │ ├── Example │ │ ├── get-stores-result-example.raml │ │ ├── store-search-result-example.raml │ │ └── stores-400-error-example.raml │ ├── Traits │ │ ├── BadRequest.raml │ │ ├── ShopperStoresTrait.raml │ │ └── Unauthorized.raml │ ├── exchange.json │ ├── exchange_modules │ │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ │ ├── api-standards │ │ │ └── 1.1.15 │ │ │ │ ├── api-standards.raml │ │ │ │ ├── dataTypes │ │ │ │ ├── base-types.raml │ │ │ │ ├── error-response.raml │ │ │ │ ├── error-types.raml │ │ │ │ ├── identifers.raml │ │ │ │ ├── pagination-types.raml │ │ │ │ └── uri.raml │ │ │ │ ├── exchange.json │ │ │ │ ├── snippets │ │ │ │ ├── aip180-warn-299-example.raml │ │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ │ └── traits │ │ │ │ ├── async-created.raml │ │ │ │ ├── date-conditional-request.raml │ │ │ │ ├── etag-conditional-request.raml │ │ │ │ ├── etag-response.raml │ │ │ │ ├── offset-paginated.raml │ │ │ │ ├── private │ │ │ │ ├── rate-limited-include-429.raml │ │ │ │ └── rate-limited-include-headers.raml │ │ │ │ ├── rangeFilter.raml │ │ │ │ ├── rate-limited-2.raml │ │ │ │ ├── rate-limited-3.raml │ │ │ │ ├── rate-limited-4.raml │ │ │ │ ├── rate-limited-5.raml │ │ │ │ ├── rate-limited.raml │ │ │ │ └── sync-created.raml │ │ │ └── commerce-cloud-standards │ │ │ └── 2.0.1 │ │ │ ├── Documentation │ │ │ ├── ErrorResponseMapping.raml │ │ │ └── baseUri.raml │ │ │ ├── Examples │ │ │ ├── BoolFilter.json │ │ │ ├── BoolQuery.json │ │ │ ├── BoolQuery.raml │ │ │ ├── Filter.json │ │ │ ├── FilteredQuery.json │ │ │ ├── NestedQuery.json │ │ │ ├── PaginatedSearchResultBase.json │ │ │ ├── Query.json │ │ │ ├── QueryFilter.json │ │ │ ├── Range2Filter.json │ │ │ ├── RangeFilter.json │ │ │ ├── SearchRequestBase.json │ │ │ ├── SimpleSearchResultBase.json │ │ │ ├── TermFilter.json │ │ │ ├── TermQuery.json │ │ │ └── TextQuery.json │ │ │ ├── SecuritySchemes │ │ │ ├── am-oauth-2.raml │ │ │ ├── shopper-token-taob.raml │ │ │ ├── shopper-token-tsob.raml │ │ │ └── shopper-token.raml │ │ │ ├── Types │ │ │ ├── ISO-standards.raml │ │ │ ├── additional-properties.raml │ │ │ ├── attribute-definition-types.raml │ │ │ ├── error-response.raml │ │ │ ├── pagination-types.raml │ │ │ └── search-types.raml │ │ │ ├── commerce-cloud-standards.raml │ │ │ ├── example.raml │ │ │ └── exchange.json │ ├── shopper-stores-description.md │ ├── shopper-stores.raml │ └── stores-library.raml └── slas-shopper-login-uap │ ├── examples │ └── jwks-get-response.json │ ├── exchange.json │ ├── exchange_modules │ └── 893f605e-10e2-423a-bdb4-f952f56eb6d8 │ │ ├── api-standards │ │ └── 1.1.15 │ │ │ ├── api-standards.raml │ │ │ ├── dataTypes │ │ │ ├── base-types.raml │ │ │ ├── error-response.raml │ │ │ ├── error-types.raml │ │ │ ├── identifers.raml │ │ │ ├── pagination-types.raml │ │ │ └── uri.raml │ │ │ ├── exchange.json │ │ │ ├── snippets │ │ │ ├── aip180-warn-299-example.raml │ │ │ └── aip193-errors-403-forbidden.raml │ │ │ └── traits │ │ │ ├── async-created.raml │ │ │ ├── date-conditional-request.raml │ │ │ ├── etag-conditional-request.raml │ │ │ ├── etag-response.raml │ │ │ ├── offset-paginated.raml │ │ │ ├── private │ │ │ ├── rate-limited-include-429.raml │ │ │ └── rate-limited-include-headers.raml │ │ │ ├── rangeFilter.raml │ │ │ ├── rate-limited-2.raml │ │ │ ├── rate-limited-3.raml │ │ │ ├── rate-limited-4.raml │ │ │ ├── rate-limited-5.raml │ │ │ ├── rate-limited.raml │ │ │ └── sync-created.raml │ │ └── commerce-cloud-standards │ │ └── 2.0.1 │ │ ├── Documentation │ │ ├── ErrorResponseMapping.raml │ │ └── baseUri.raml │ │ ├── Examples │ │ ├── BoolFilter.json │ │ ├── BoolQuery.json │ │ ├── BoolQuery.raml │ │ ├── Filter.json │ │ ├── FilteredQuery.json │ │ ├── NestedQuery.json │ │ ├── PaginatedSearchResultBase.json │ │ ├── Query.json │ │ ├── QueryFilter.json │ │ ├── Range2Filter.json │ │ ├── RangeFilter.json │ │ ├── SearchRequestBase.json │ │ ├── SimpleSearchResultBase.json │ │ ├── TermFilter.json │ │ ├── TermQuery.json │ │ └── TextQuery.json │ │ ├── SecuritySchemes │ │ ├── am-oauth-2.raml │ │ ├── shopper-token-taob.raml │ │ ├── shopper-token-tsob.raml │ │ └── shopper-token.raml │ │ ├── Types │ │ ├── ISO-standards.raml │ │ ├── additional-properties.raml │ │ ├── attribute-definition-types.raml │ │ ├── error-response.raml │ │ ├── pagination-types.raml │ │ └── search-types.raml │ │ ├── commerce-cloud-standards.raml │ │ ├── example.raml │ │ └── exchange.json │ ├── shopper-login-and-api-access-description.md │ ├── shopper-login.raml │ ├── slasJWT-BearerSecurityScheme.raml │ └── traits │ ├── private │ └── slasRateLimitHeaders.raml │ └── slasRateLimit.raml ├── babel.config.jest.js ├── babel.config.js ├── docs ├── .nojekyll ├── assets │ ├── css │ │ └── main.css │ ├── images │ │ ├── icons.png │ │ ├── icons@2x.png │ │ ├── widgets.png │ │ └── widgets@2x.png │ └── js │ │ ├── main.js │ │ └── search.json ├── classes │ ├── clientconfig.clientconfig-1.html │ ├── responseerror.responseerror-1.html │ ├── shopperbaskets.shopperbaskets-1.html │ ├── shoppercontexts.shoppercontexts-1.html │ ├── shoppercustomers.shoppercustomers-1.html │ ├── shopperdiscoverysearch.shopperdiscoverysearch-1.html │ ├── shopperexperience.shopperexperience-1.html │ ├── shoppergiftcertificates.shoppergiftcertificates-1.html │ ├── shopperlogin.shopperlogin-1.html │ ├── shopperorders.shopperorders-1.html │ ├── shopperproducts.shopperproducts-1.html │ ├── shopperpromotions.shopperpromotions-1.html │ ├── shoppersearch.shoppersearch-1.html │ ├── shopperseo.shopperseo-1.html │ ├── shopperstores.shopperstores-1.html │ └── templateurl.templateurl-1.html ├── globals.html ├── index.html ├── interfaces │ ├── clientconfig.clientconfiginit.html │ ├── helpers.baseuriparameters-1.html │ ├── helpers.customparams-1.html │ ├── helpers.pathparameters-1.html │ └── helpers.queryparameters-1.html └── modules │ ├── clientconfig.html │ ├── config.html │ ├── helpers.html │ ├── responseerror.html │ ├── shopperbaskets.html │ ├── shoppercontexts.html │ ├── shoppercustomers.html │ ├── shopperdiscoverysearch.html │ ├── shopperexperience.html │ ├── shoppergiftcertificates.html │ ├── shopperlogin.html │ ├── shopperorders.html │ ├── shopperproducts.html │ ├── shopperpromotions.html │ ├── shoppersearch.html │ ├── shopperseo.html │ ├── shopperstores.html │ ├── templateurl.html │ └── version.html ├── netlify.toml ├── package.json ├── public ├── favicon.ico ├── index.html ├── logo192.png ├── logo512.png ├── manifest.json └── robots.txt ├── rollup.config.js ├── scripts ├── config.ts ├── generate.ts ├── templateHelpers.test.ts ├── templateHelpers.ts ├── updateApis.ts ├── utils.test.ts └── utils.ts ├── src ├── environment │ ├── App │ │ ├── App.css │ │ ├── App.jsx │ │ ├── App.module.css │ │ ├── App.spec.jsx │ │ ├── __snapshots__ │ │ │ └── App.spec.jsx.snap │ │ └── index.js │ └── config.js ├── index.jsx ├── static │ ├── clientConfig.test.ts │ ├── clientConfig.ts │ ├── config.ts │ ├── helpers │ │ ├── customApi.test.ts │ │ ├── customApi.ts │ │ ├── environment.test.ts │ │ ├── environment.ts │ │ ├── fetchHelper.test.ts │ │ ├── fetchHelper.ts │ │ ├── index.ts │ │ ├── slasHelper.test.ts │ │ ├── slasHelper.ts │ │ └── types.ts │ ├── responseError.ts │ ├── templateUrl.test.ts │ └── templateUrl.ts └── test │ ├── crossFetchNode.test.ts │ ├── parameters.test.ts │ └── requests.test.ts ├── templates ├── client.ts.hbs ├── dtoPartial.ts.hbs ├── index.ts.hbs ├── operations.ts.hbs ├── paramKeys.ts.hbs └── version.ts.hbs ├── tsconfig.json └── yarn.lock /.depcheckignore: -------------------------------------------------------------------------------- 1 | # This file is required because otherwise depcheck will skip checking files in the .gitignore, 2 | # but we want to check some of those files (namely, the generated code in /src/lib). 3 | 4 | # We don't strictly need to ignore /apis and /docs, because there's nothing in them that depcheck 5 | # recognizes, but we can get a minor performance boost by skipping all of those files. 6 | /apis 7 | /docs 8 | /node_modules 9 | -------------------------------------------------------------------------------- /.depcheckrc.yml: -------------------------------------------------------------------------------- 1 | ignores: 2 | # Include an explanation why the package is ignored 3 | - '@babel/*' # Used in babel.config.js and babel.config.jest.js 4 | - '@types/react-dom' # Used in src/index.jsx 5 | - jest-environment-jsdom-sixteen # Used by test:react script in package.json 6 | - lib # Used in App.jsx, references local directory 7 | - node-fetch # False positive - clientConfig.ts imports the type from @types/node-fetch 8 | - sort-package-json # Used in lint-staged config in package.json 9 | - stylelint-* # Used in .stylelintrc 10 | - typedoc-plugin-* # Automatically loaded by typedoc, never directly referenced 11 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | /build/ 2 | /docs/ 3 | /lib/ 4 | /src/lib/ 5 | /src/react-app-env.d.ts 6 | -------------------------------------------------------------------------------- /.git2gus/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "productTag": "a1aEE000000T2HlYAK", 3 | "issueTypeLabels": { 4 | "type:feature": "", 5 | "type:bug": "BUG P3", 6 | "type:security": "BUG P2", 7 | "type:dependency": "USER STORY", 8 | "type:duplicate": "", 9 | "type:community-contrib": "USER STORY" 10 | }, 11 | "defaultBuild": "backlog", 12 | "hideWorkItemUrl": "true", 13 | "statusWhenClosed": "CLOSED" 14 | } 15 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # https://help.github.com/en/enterprise/2.17/user/articles/about-code-owners 2 | 3 | # These owners will be the default owners for everything in 4 | # the repo. Unless a later match takes precedence, 5 | # @global-owner1 and @global-owner2 will be requested for 6 | # review when someone opens a pull request. 7 | 8 | * @SalesforceCommerceCloud/mobifyers 9 | #ECCN:Open Source 10 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Publish to NPM 2 | 3 | on: 4 | release: 5 | types: [published] 6 | jobs: 7 | publish-to-npm: 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v3 11 | - uses: actions/setup-node@v3 12 | with: 13 | node-version: '22.x' 14 | registry-url: 'https://registry.npmjs.org' 15 | - run: yarn install 16 | - run: yarn run renderTemplates 17 | - run: yarn build:lib 18 | - run: npm publish 19 | env: 20 | NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # See https://help.github.com/articles/ignoring-files/ for more about ignoring files. 2 | 3 | # build files 4 | /src/lib 5 | src/react-app-env.d.ts 6 | 7 | # dependencies 8 | /node_modules 9 | /.pnp 10 | .pnp.js 11 | 12 | # testing 13 | /coverage 14 | 15 | # production 16 | /build 17 | 18 | # misc 19 | .DS_Store 20 | .env 21 | 22 | npm-debug.log* 23 | yarn-debug.log* 24 | yarn-error.log* 25 | 26 | # lib 27 | /lib 28 | 29 | # Optional npm cache directory 30 | .npm 31 | 32 | # Output of 'npm pack' 33 | *.tgz 34 | 35 | # IDE files 36 | .idea 37 | 38 | # VS Code files 39 | .vscode 40 | 41 | # temp files 42 | /temp -------------------------------------------------------------------------------- /.lintstagedrc: -------------------------------------------------------------------------------- 1 | { 2 | "*.js": [ 3 | "eslint --fix" 4 | ], 5 | "*.css": [ 6 | "stylelint --fix" 7 | ] 8 | } -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | .npm-pack-all-tmp -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 22 2 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "semi": true, 3 | "singleQuote": true, 4 | "jsxSingleQuote": false, 5 | "trailingComma": "es5", 6 | "bracketSpacing": false, 7 | "bracketSameLine": true, 8 | "arrowParens": "avoid" 9 | } 10 | -------------------------------------------------------------------------------- /.snyk: -------------------------------------------------------------------------------- 1 | # Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities. 2 | version: v1.22.1 3 | ignore: {} 4 | patch: {} 5 | -------------------------------------------------------------------------------- /.stylelintrc: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "stylelint-config-standard", 3 | "rules": { 4 | "function-calc-no-unspaced-operator": true, 5 | "order/order": [ 6 | "custom-properties", 7 | "declarations" 8 | ], 9 | "order/properties-alphabetical-order": true, 10 | "property-no-vendor-prefix": true, 11 | "media-feature-name-no-vendor-prefix": true, 12 | "at-rule-no-vendor-prefix": true, 13 | "selector-no-vendor-prefix": true, 14 | "max-nesting-depth": 3, 15 | "selector-max-compound-selectors": 5 16 | }, 17 | "plugins": [ 18 | "stylelint-order" 19 | ], 20 | "ignoreFiles": ["**/*.snap"] 21 | } -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | ## Security 2 | 3 | Please report any security issue to [security@salesforce.com](mailto:security@salesforce.com) 4 | as soon as it is discovered. This library limits its runtime dependencies in 5 | order to reduce the total cost of ownership as much as can be, but all consumers 6 | should remain vigilant and have their security stakeholders review all third-party 7 | products (3PP) like this one and their dependencies. -------------------------------------------------------------------------------- /apis/shopper-baskets/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-baskets/2.0.10", 3 | "name": "Shopper Baskets", 4 | "description": "Build a checkout experience.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-baskets", 7 | "version": "2.0.10", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Checkout" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/basket-item-tax-get-response.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "taxItems":[ 5 | { 6 | "id":"DE_7", 7 | "rate":0.07, 8 | "value":13.99 9 | }, 10 | { 11 | "id":"DE_19", 12 | "rate":0.19 13 | } 14 | ] 15 | } 16 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/basket-item-tax-put-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "taxItems":[ 5 | { 6 | "id":"DE_7", 7 | "rate":0.07, 8 | "value":13.99 9 | }, 10 | { 11 | "id":"DE_19", 12 | "rate":0.19 13 | } 14 | ] 15 | } 16 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/basket-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "c_textValue":"oak" 5 | } 6 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/billing-address-put-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "firstName": "Stephanie", 5 | "lastName": "Miller", 6 | "address1": "385 Prospect Valley Road", 7 | "city": "Woburn", 8 | "postalCode": "01801", 9 | "stateCode": "MA", 10 | "countryCode": "US" 11 | } 12 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/coupon-code-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "code": "10_percent_off" 5 | } 6 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/customer-put-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "email": "shopperUpdate@salesforce-test.com" 5 | } 6 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/gift-cert-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount" : 1.00, 5 | "recipientEmail" : "miller@salesforce-test.com" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/gift-cert-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount" : 1.00, 5 | "recipientEmail" : "miller@salesforce-test.com", 6 | "shipmentId" : "me" 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/item-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "quantity" : 1 5 | } 6 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/item-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | [{ 4 | "productId": "green-bag", 5 | "quantity": 1 6 | }] 7 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/items-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | [{ 4 | "itemId": "051e908cca031ebf8ee80cbb0a", 5 | "productId": "green-bag", 6 | "quantity": 1 7 | },{ 8 | "itemId": "078a492cca031ebf8ee80739ab", 9 | "optionItems" : [{ 10 | "optionId":"Option1", 11 | "optionValueId":"ValueA" 12 | }], 13 | "quantity": 1 14 | }] 15 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/payment-instrument-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount": 0, 5 | "paymentCard": 6 | { 7 | "holder": "Miller", 8 | "cardType": "Visa" 9 | }, 10 | "paymentMethodId": "CREDIT_CARD" 11 | } 12 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/payment-instrument-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount": 1, 5 | "paymentCard":{ 6 | "expirationYear":1990, 7 | "expirationMonth":7, 8 | "validFromMonth":8, 9 | "validFromYear":2007, 10 | "issueNumber":"i117", 11 | "maskedNumber":"*********1234", 12 | "holder":"Miller", 13 | "cardType":"Visa" 14 | }, 15 | "paymentMethodId": "CREDIT_CARD" 16 | } 17 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/price-adjustment-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "appliedDiscount" : 5 | { 6 | "amount" : 15, 7 | "type" : "amount" 8 | }, 9 | "itemText" : "AgentOrderAdjustment", 10 | "reasonCode" : "override manual promo" 11 | 12 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/price-adjustment-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | 5 | "discount" : 6 | { 7 | "value" : 5, 8 | "type" : "percentage" 9 | }, 10 | "itemText" : "MyOrderAdjustment", 11 | "level" : "order", 12 | "promotionId" : "manual adjustment" 13 | 14 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/price-books.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | ["price-book-id1", "price-book-id2"] -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/shipments-address-put-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "firstName": "Ward J", 5 | "lastName": "Adamek", 6 | "address1": "4911 Lincoln Street", 7 | "city": "IDANHA", 8 | "postalCode": "97350", 9 | "stateCode": "OR", 10 | "countryCode": "US" 11 | } 12 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/shipments-method-put-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "id": "003" 5 | } 6 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/shipments-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "shipmentId": "me", 5 | "shipmentNo": "ignored shipment no", 6 | "shippingMethod": { 7 | "id": "003" 8 | }, 9 | "shippingAddress": { 10 | "firstName": "Ward J", 11 | "lastName": "Adamek", 12 | "address1": "4911 Lincoln Street", 13 | "city": "IDANHA", 14 | "postalCode": "97350", 15 | "stateCode": "OR", 16 | "countryCode": "US" 17 | }, 18 | "c_wapi-string": "shipment_custom_property" 19 | } 20 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/basket/shipments-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "shipmentId": "me2", 5 | "shippingMethod": { 6 | "id": "001" 7 | }, 8 | "shippingAddress": { 9 | "firstName": "Stephanie", 10 | "lastName": "Miller", 11 | "address1": "385 Prospect Valley Road", 12 | "city": "Woburn", 13 | "postalCode": "01801", 14 | "stateCode": "MA", 15 | "countryCode": "US" 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/basket-merge-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/basket-merge-no-current-basket-exception", 5 | "title": "Conflict", 6 | "detail": "The current customer with ID 'cdo7rJNie7ahERqXSb51Yvz2M4' has no active basket." 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/basket-transfer-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/basket-transfer-basket-already-exists-exception", 5 | "title": "Conflict", 6 | "detail": "The current customer with ID 'cdo7rJNie7ahERqXSb51Yvz2M4' has an active basket." 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/customer-basket-quota-exceeded-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "title": "Customer Baskets Quota Exceeded", 5 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/customer-baskets-quota-exceeded", 6 | "detail": "The maximum number of baskets per customer was exceeded. Please reuse or delete one of the existing baskets (40e91e04aba6e42a6836f79308).", 7 | "basketIds": "40e91e04aba6e42a6836f79308" 8 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/customer-temporary-basket-quota-exceeded-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "title": "Customer Temporary Baskets Quota Exceeded", 5 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/customer-temporary-baskets-quota-exceeded", 6 | "detail": "The maximum number of temporary baskets per customer was exceeded. Please reuse or delete one of the existing temporary baskets (40e91e04aba6e42a6836f79308, 73ca0f0860a67df946782c2688).", 7 | "basketIds": "40e91e04aba6e42a6836f79308, 73ca0f0860a67df946782c2688" 8 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/price-adjustment-id-not-found-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/price-adjustment-not-found", 5 | "title": "Price Adjustment Not Found", 6 | "detail": "No price adjustment with ID '453599643347eac5e4ebd85b49' could be found." 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/slas-jwt-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "title": "Forbidden", 5 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden", 6 | "detail": "Your access-token is valid, but it contains no previous customer to process this action." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/examples/error/source-basket-exception.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/no-source-basket-exception", 5 | "title": "Conflict", 6 | "detail": "The previous customer with ID 'cdo7rJNie7ahERqXSb51Yvz2M4' has no active basket." 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/bad-request-auth.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request", 5 | "title": "Bad Request", 6 | "detail": "The customer is invalid." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/bad-request-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request", 5 | "title": "Bad Request", 6 | "detail": "Decoding of the property with path '$.failedExample.[1].intProperty' failed because the expected type is 'Integer|Decimal' but the actual type was 'String'." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/basket-not-found.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/basket-not-found", 5 | "title": "Basket Not Found", 6 | "detail": "No basket with ID '123' could be found." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden", 5 | "title": "Forbidden", 6 | "detail": "The shipment with ID 'me' corresponds to the default shipment and can't be deleted." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/invalid-tax-mode.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-tax-mode", 5 | "title": "Invalid Tax Mode", 6 | "detail": "Basket with ID 'a10ff320829cb0eef93ca5310a' has invalid tax mode." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/order-not-found.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/order-not-found", 5 | "title": "Order Not Found", 6 | "detail": "No order with number '123' was found." 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/shipment-not-found.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/shipment-not-found", 5 | "title": "Shipment Not Found", 6 | "detail": "The shipping method with ID '123' is unknown or can't be applied to the basket." 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/examples/error/unsupported-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unsupported-request-if-scapi-hooks-enabled", 5 | "title": "Unsupported Request If SCAPI Hooks Enabled", 6 | "detail": "You can't call this endpoint because Salesforce Commerce API hook execution is enabled." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.6/exchange.json: -------------------------------------------------------------------------------- 1 | {"dependencies":[{"version":"2.0.1","assetId":"commerce-cloud-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8"}],"version":"2.0.6","originalFormatVersion":"1.0","apiVersion":"v1","descriptorVersion":"0.1.0","classifier":"raml-fragment","main":"checkout-data-types.raml","assetId":"checkout-data-types","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","organizationId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","name":"Checkout Data Types","tags":[],"metadata":{"projectId":"ac07ef0d-aa14-4469-95b7-95c115af175a","branchId":"v2","commitId":"c2e92b6a330fb7dda1e494b148c506dc9e44ab0f"}} -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-baskets/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-context/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-context/0.0.30", 3 | "name": "Shopper Context", 4 | "description": "The Shopper Context API enables developers to build highly contextualized shopping experiences for shoppers.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-context", 7 | "version": "0.0.30", 8 | "categories": { 9 | "API layer": [ 10 | "System" 11 | ], 12 | "CC API Family": [ 13 | "Customer" 14 | ], 15 | "CC API Visibility": [ 16 | "External" 17 | ] 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /apis/shopper-context/Examples/shopper-context-400-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/usid-not-matching-with-token", 5 | "detail": "Usid in incoming request does not match Usid in token.", 6 | "title": "Usid not matching with token" 7 | } -------------------------------------------------------------------------------- /apis/shopper-context/Examples/shopper-context-401-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unauthorized", 5 | "title": "Unauthorized", 6 | "detail": "Your shopper JWT is invalid and could not be used to identify the API client." 7 | } -------------------------------------------------------------------------------- /apis/shopper-context/Examples/shopper-context-403-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden", 5 | "title": "Forbidden", 6 | "detail": "Your shopper JWT is valid, but you have no permissions to access the resource." 7 | } -------------------------------------------------------------------------------- /apis/shopper-context/Examples/shopper-context-404-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/shopper-context-no-found", 5 | "detail": "Shopper Context for ORGANIZATION_ID: f_ecom_bhbv_prd and USID: 7e1f65fb-185c-4788-8cec-05fef8dac77d not found in Repository.", 6 | "title": "Shopper Context Not Found" 7 | } -------------------------------------------------------------------------------- /apis/shopper-context/Examples/shopper-context-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | # This example is for shopper context request/response 3 | value: 4 | { 5 | "effectiveDateTime": "2020-12-20T00:00:00Z", 6 | "sourceCode": "wii1-98", 7 | "customQualifiers" : 8 | { 9 | "deviceType": "mobile", 10 | "ipAddress": "189.0.0.0", 11 | "operatingSystem": "Android" 12 | }, 13 | "assignmentQualifiers" : 14 | { 15 | "store": "boston" 16 | }, 17 | "customerGroupIds" : [ "BigSpenders","MobileUsers" ], 18 | "clientIp": "12.12.12.1" 19 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-context/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-customers/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-customers/0.0.50", 3 | "name": "Shopper Customers", 4 | "description": "Allow customers to manage their own profiles and product lists.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-customers", 7 | "version": "0.0.50", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Customer" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/BonusDiscountLineItem.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "bonusProducts": [ 5 | { 6 | "link": "bonus product link", 7 | "productDescription": "Bonus Product", 8 | "productId": "34984327448", 9 | "productName": "Extra Fluffy Bonus Product", 10 | "title": "Bonus Product" 11 | } 12 | ], 13 | "couponCode": "BONUS", 14 | "id": "qhegj345ruhrfkj", 15 | "maxBonusItems": 1, 16 | "promotionId": "basds98295jsafi" 17 | } 18 | -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CouponItem.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "code": "5634573", 5 | "couponItemId": "100-89038", 6 | "statusCode": "coupon_code_already_in_basket", 7 | "valid": true 8 | } 9 | -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerAddressRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "addressId": "home_address", 5 | "address1" : "5 Wall St", 6 | "address2" : "24 Presidential Way", 7 | "city" : "Burlington", 8 | "companyName" : "Salesforce Commerce Cloud", 9 | "countryCode" : "US", 10 | "firstName": "John", 11 | "jobTitle" : "Developer", 12 | "lastName" : "Murphy", 13 | "phone" : "408-555-1212", 14 | "postalCode" : "01805", 15 | "postBox" : "12a", 16 | "preferred" : false, 17 | "salutation" : "Mr.", 18 | "secondName" : "Jim", 19 | "stateCode": "MA", 20 | "title": "Dr." 21 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerAddressResult.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "limit" : 1, 5 | "data" : 6 | [ 7 | { 8 | "address1" : "10 Free Way", 9 | "addressId" : "private", 10 | "city" : "Woburn", 11 | "countryCode" : "US", 12 | "firstName" : "James", 13 | "fullName" : "James Last", 14 | "lastName" : "Last", 15 | "postalCode" : "01827", 16 | "salutation" : "Mr.", 17 | "stateCode" : "MA" 18 | } 19 | ], 20 | "offset" : 0, 21 | "total" : 2 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerExternalProfile.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | 5 | "authenticationProviderId": "Google", 6 | "firstName" : "John", 7 | "lastName" : "Doe", 8 | "customerId": "bfqcN48dn2y4EaV9Qj5bNpVJVj", 9 | "email": "testCustomer@test.com", 10 | "externalId": "testCustomer@test.com" 11 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerPaymentInstrumentRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "paymentCard": { 5 | "expirationYear":2027, 6 | "expirationMonth":7, 7 | "validFromMonth":8, 8 | "validFromYear":2007, 9 | "issueNumber":"i117", 10 | "number":"1234567", 11 | "holder":"John Smith", 12 | "cardType":"MasterCard" 13 | }, 14 | "giftCertificateCode": "gift_code7", 15 | "paymentMethodId": "OCAPI_Payment_Simple", 16 | "bankRoutingNumber": "bankrouting3776" 17 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerProductListItemRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "productId": "RedDress1", 5 | "id": "1", 6 | "purchasedQuantity": 0, 7 | "priority": 3, 8 | "quantity": 4, 9 | "public": false, 10 | "type": "product" 11 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerRegistrationRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "password": "12345!aBcD", 5 | "customer": { 6 | "login": "jsmith", 7 | "email": "jsmith@test.com", 8 | "firstName": "John", 9 | "lastName": "Smith" 10 | } 11 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/CustomerRegistrationResponse.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "authType": "registered", 5 | "creationDate": "2020-02-13T17:44:15.892Z", 6 | "customerId": "abkd9LhOWzAiAFubdEDChtkMHW", 7 | "customerNo": "00006002", 8 | "email": "jsmith@test.com", 9 | "enabled": true, 10 | "firstName": "John", 11 | "lastModified": "2020-02-13T17:44:15.898Z", 12 | "lastName": "Smith", 13 | "login": "jsmith" 14 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/ExternalProfileRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | 5 | "authenticationProviderId": "Google", 6 | "firstName" : "John", 7 | "lastName" : "Doe", 8 | "email": "testCustomer@test.com", 9 | "externalId": "testCustomer@test.com" 10 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/ResetPasswordRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "resetToken": "R1e2s3e4t5T6o7k8e9n0", 5 | "login": "janedoe@test.com", 6 | "newPassword": "p@assword2" 7 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/ResetTokenResult.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "login": "janedoe@test.com", 5 | "email": "janedoe@test.com", 6 | "resetToken": "R1e2s3e4t5T6o7k8e9n0", 7 | "expiresInMinutes": 30 8 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/TrustedAuthResponse.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "authType": "registered", 5 | "creationDate": "2020-02-14T20:39:53.818Z", 6 | "customerId": "bf9FlYiDM7849QcbnkJ76AMBad", 7 | "customerNo": "00010009", 8 | "email": "jwild1@yourstore.com", 9 | "enabled": true, 10 | "lastLoginTime": "2020-02-14T20:40:00.543Z", 11 | "lastModified": "2020-02-14T20:40:00.543Z", 12 | "lastName": "wild1", 13 | "lastVisitTime": "2020-02-14T20:40:00.543Z", 14 | "login": "f0a43dc2-692a-43bf-b008-e10918ea935d", 15 | "previousLoginTime": "2020-02-14T20:40:00.543Z", 16 | "previousVisitTime": "2020-02-14T20:40:00.543Z" 17 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/UpdateCustomerProductListItem.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "id" : "1d447daa4d25805fd682bd4ce1", 5 | "priority" : 4, 6 | "productId" : "RedDress1", 7 | "public" : true, 8 | "purchasedQuantity" : 0, 9 | "quantity" : 2, 10 | "type" : "product" 11 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/UpdateCustomerRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "customerNo": "00010009", 5 | "firstName": "John", 6 | "lastName": "Wild", 7 | "email": "jwild@yourstore.com", 8 | "fax": "+49 03641 78393 346" 9 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Examples/guestAuthResponse.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "authType": "guest", 5 | "customerId": "bc4db2DZE5xMg7Tnjwa20NrC0X", 6 | "preferredLocale": "en_US" 7 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Traits/BadRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 400 response when there is a bad request for a customer. 3 | responses: 4 | '400': 5 | description: | 6 | CustomerId URL parameter does not match the verified customer represented by the JWT token. 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Invalid Customer", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-customer", 14 | "detail": "The customer is invalid." 15 | } 16 | -------------------------------------------------------------------------------- /apis/shopper-customers/Traits/ExternalProfileBadRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 400 response when there is a bad request for a customer. 3 | responses: 4 | '400': 5 | description: | 6 | Customer ExternalId URL parameter is not valid. 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Invalid Customer External Profile", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-customer-external-profile", 14 | "detail": "The customer external profile is invalid." 15 | } 16 | -------------------------------------------------------------------------------- /apis/shopper-customers/Traits/ExternalProfileNotFound.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 404 response when a customer external profile is not found. 3 | responses: 4 | '404': 5 | description: | 6 | Requested Resource Not Found 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Not Found", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/not-found", 14 | "detail": "No customer with external profile with ID 'abfTWMDZOgi3JPzkHjv9IhmziI' could be found.", 15 | "externalId": "abfTWMDZOgi3JPzkHjv9IhmziI" 16 | } -------------------------------------------------------------------------------- /apis/shopper-customers/Traits/NotFound.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 404 response when a customer is not found. 3 | responses: 4 | '404': 5 | description: | 6 | Requested Resource Not Found 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Not Found", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/not-found", 14 | "detail": "No customer with ID 'abfTWMDZOgi3JPzkHjv9IhmziI' could be found.", 15 | "customerId": "abfTWMDZOgi3JPzkHjv9IhmziI" 16 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-customers/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-discovery-search/1.1.6", 3 | "name": "Shopper Discovery Search", 4 | "description": "Einstein-powered product search and search suggestions.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-discovery-search", 7 | "version": "1.1.6", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Discovery" 14 | ], 15 | "CC Version Status": [ 16 | "Beta" 17 | ] 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.9/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.9","apiVersion":"v1","dependencies":[]} -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.9/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.9/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.9/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per hour. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/SecuritySchemes/bearer-token.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 SecurityScheme 2 | description: A security scheme that supplements APIs secured with `AmOAuth2` to support the usage of the mocking service. Expects a valid Bearer token passed in the 'Authorization' header to permit API access. 3 | type: x-custom 4 | displayName: BearerToken 5 | describedBy: 6 | headers: 7 | Authorization: 8 | description: |- 9 | Bearer token 10 | type: string 11 | pattern: "Bearer .*" 12 | examples: 13 | authenticatedUser: Bearer b325e95c-2cd7-11e5-b345-feff819cdc9f 14 | -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/1.0.16/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"commerce-cloud-standards.raml","name":"Commerce Cloud Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"commerce-cloud-standards","version":"1.0.16"} -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-examples/1.0.2/discovery-examples.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | Discovery Examples: -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-examples/1.0.2/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"discovery-examples.raml","name":"Discovery Examples","organizationId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"discovery-examples","version":"1.0.2","classifier":"raml-fragment","dependencies":[],"tags":["example"]} -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-examples/1.0.2/results-400-error-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | 3 | value: 4 | { 5 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/invalid-request", 6 | "title": "Invalid Request", 7 | "detail": "Limit 'limit.max' out of bounds" 8 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-examples/1.0.2/suggestions-400-error-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | 3 | value: 4 | { 5 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/invalid-request", 6 | "title": "Invalid Request", 7 | "detail": "Limit 'searchTextLength.max' out of bounds" 8 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-query-common-library/1.0.8/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"discovery-query-library.raml","name":"Discovery Query Common Library","organizationId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"discovery-query-common-library","version":"1.0.8","classifier":"raml-fragment","dependencies":[{"assetId":"api-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","version":"1.1.9"},{"assetId":"commerce-cloud-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","version":"1.0.16"},{"assetId":"discovery-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","version":"0.0.27"}],"tags":[]} -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/Authentication.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/authentication-failure", 3 | "title": "Authentication Failure", 4 | "detail": "Authentication failed due to missing or invalid token.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/Authorization.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/authorization-failure", 3 | "title": "Authorization Failure", 4 | "detail": "The provided credentials are not authorized to access this resource.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/InternalServerError.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/internal-server-error", 3 | "title": "Internal Server Error", 4 | "detail": "There was an error completing your request.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/InvalidRequest.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/invalid-request", 3 | "title": "Invalid Request", 4 | "detail": "The provided request information is of an invalid format.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/LimitExceeded.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/limit-exceeded", 3 | "title": "Limit Exceeded", 4 | "detail": "You have exceeded a limit for the provided attibutes.", 5 | "instance": "{Resource URI}", 6 | "limits": [ 7 | { 8 | "limitDetails": "ATTRIBUTE_USAGE_FACETABLE_COUNT", 9 | "count": 90, 10 | "limit": 50 11 | }, 12 | { 13 | "limitDetails": "ATTRIBUTE_USAGE_FILTERABLE_COUNT", 14 | "count": 15, 15 | "limit": 12 16 | } 17 | ] 18 | } 19 | -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/NonReadableHttpMessage.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/non-readable-http-message", 3 | "title": "Non-Readable HTTP Message", 4 | "detail": "The request could not be processed.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/NotFound.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/not-found", 3 | "title": "Resource Not Found", 4 | "detail": "The requested {resource} was not found.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/RateLimitExceeded.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/rate-limit-reached", 3 | "title": "Rate Limit Reached", 4 | "detail": "The request could not be processed due to the current volume of requests.", 5 | "instance": "{Resource URI}", 6 | "requestLimit": 1000 7 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Errors/Examples/ServiceUnavailable.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "https://discovery.commercecloud.salesforce.com/documentation/error/v2/errors/service-unavailable", 3 | "title": "Service Unavailable", 4 | "detail": "The server is temporarily unable to handle the request.", 5 | "instance": "{Resource URI}" 6 | } -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Traits/traceable.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: This trait allows for taking in an input header containing a request identifier. 4 | 5 | headers: 6 | RequestId?: 7 | description: Client defined unique identifier, used for tracking within the domain. 8 | type: string 9 | maxLength: 256 10 | example: f20c37c8-f153-4001-b033-c7b32e1e8651 11 | -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Types/base-uri-parameters.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Library 2 | usage: 3 | 4 | types: 5 | 6 | Region: 7 | description: Region in which the service is exposed. 8 | example: en-US 9 | 10 | Version: 11 | description: The version of the commerce cloud API. 12 | example: v2 -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Types/date-times.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Library 2 | 3 | types: 4 | 5 | CreationDateTime: 6 | description: The date time the resource was created. 7 | type: datetime 8 | example: 2020-02-28T10:41:50Z 9 | 10 | LastUpdateDateTime: 11 | description: The date time when the resource was last modified. 12 | type: datetime 13 | example: 2020-02-27T06:13:07Z -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Types/expansion-attribute.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 DataType 2 | 3 | uses: 4 | IDs: identifiers.raml 5 | 6 | description: An entity containing an attribute ID, the attribute's path, and the attribute's value for a corresponding item. 7 | properties: 8 | attributeId: IDs.AttributeId 9 | path: 10 | description: The path, using dot notation, that this attribute corresponds to. 11 | type: string 12 | example: item.brand 13 | value: 14 | description: The data for the given attribute. 15 | type: any -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/Types/identifiers.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Library 2 | 3 | types: 4 | 5 | DataSetId: 6 | description: The unique identifier of a Data Set resource. 7 | type: string 8 | maxLength: 256 9 | example: d4330450-df8a-439f-80f8-847ae3cb564f 10 | 11 | AttributeId: 12 | description: User defined unique identifier for a specific attribute. 13 | type: string 14 | maxLength: 256 15 | example: name -------------------------------------------------------------------------------- /apis/shopper-discovery-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/discovery-standards/0.0.27/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"discovery-standards.raml","name":"Discovery Standards","organizationId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","assetId":"discovery-standards","version":"0.0.27","classifier":"raml-fragment","dependencies":[],"tags":[]} -------------------------------------------------------------------------------- /apis/shopper-discovery-search/shopper-discovery-search-description.md: -------------------------------------------------------------------------------- 1 | These APIs provide the capability to search Discovery services based on channel identifier and also get Suggestions that show the most recently searched items, items that are popular in the user's locale, and items that are recommended based on the user's search history. -------------------------------------------------------------------------------- /apis/shopper-experience/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-experience/1.0.5", 3 | "name": "Shopper Experience", 4 | "description": "", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-experience", 7 | "version": "1.0.5", 8 | "categories": { 9 | "CC API Family": [ 10 | "Experience" 11 | ], 12 | "CC API Visibility": [ 13 | "External" 14 | ] 15 | } 16 | } 17 | -------------------------------------------------------------------------------- /apis/shopper-experience/Examples/carousel-regions-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | [ 4 | { 5 | "id" : "tiles", 6 | "components" : [ 7 | { 8 | "id" : "w3reö9wsjf3", 9 | "typeId" : "commerce_assets.productTile", 10 | "data" : { 11 | "product" : "iphone6" 12 | } 13 | }, 14 | { 15 | "id" : "cgn8d4ngdl4n", 16 | "typeId" : "commerce_assets.productTile", 17 | "data" : { 18 | "product" : "iphone7" 19 | } 20 | } 21 | ] 22 | } 23 | ] -------------------------------------------------------------------------------- /apis/shopper-experience/Examples/header-components-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | [ 4 | { 5 | "id" : "iofwj38fhw3f", 6 | "typeId" : "commerce_assets.banner", 7 | "data" : { 8 | "title" : "Products On Sale", 9 | "bannerImage" : "sale/topsellerPromo.jpg" 10 | }, 11 | "custom" : { 12 | "thumbnail_full" : "http://static.myshop.com/sale/topsellerPromo.jpg" 13 | } 14 | } 15 | ] -------------------------------------------------------------------------------- /apis/shopper-experience/Traits/AspectAttributesInvalid.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 400 response when an aspect attribute does not suffice its definition. 3 | responses: 4 | 400: 5 | description: | 6 | Provided Aspect Attribute Invalid 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Aspect Attribute Invalid", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/aspect-attribute-invalid", 14 | "detail": "Aspect attribute value '5555' does not fulfill its respective definition {\"id\" : \"foobar\", \"type\" : \"string\",\"required\" : false\"}" 15 | } -------------------------------------------------------------------------------- /apis/shopper-experience/Traits/AspectTypeNotFound.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 404 response when an aspect type is not found. 3 | responses: 4 | 404: 5 | description: | 6 | Requested Aspect Type Not Found 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Aspect Type Not Found", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/aspect-type-not-found", 14 | "detail": "No aspect type with ID 'pdp' was found in site 'RefArch'." 15 | } -------------------------------------------------------------------------------- /apis/shopper-experience/Traits/PageNotFound.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: 404 response when a page is not found, i.e. does not exist or isn't visible. 3 | responses: 4 | 404: 5 | description: | 6 | Requested Page Not Found 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: 11 | { 12 | "title": "Page Not Found", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/page-not-found", 14 | "detail": "No visible page with ID 'homepage' was found in site 'RefArch'." 15 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-experience/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-gift-certificates/1.0.17", 3 | "name": "Shopper Gift Certificates", 4 | "description": "Obtain details about a gift certificate.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-gift-certificates", 7 | "version": "1.0.17", 8 | "categories": { 9 | "API layer": [ 10 | "System" 11 | ], 12 | "CC API Family": [ 13 | "Pricing" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/Examples/gift-certificate-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount": 100, 5 | "balance": 100, 6 | "enabled": true, 7 | "maskedGiftCertificateCode": "************FJWQ", 8 | "merchantId": "00000001", 9 | "recipientEmail": "p@gmail.com", 10 | "recipientName": "sampleuser", 11 | "senderName": "Salesforce Support", 12 | "status": "issued" 13 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/Traits/NotFoundException.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 404 response in Shop Gift Certificate API. 3 | 4 | responses: 5 | 404: 6 | description: | 7 | Thrown if the given gift certificate code is not valid. 8 | body: 9 | application/json: 10 | type: ApiStandards.ErrorResponse 11 | example: | 12 | { 13 | "type": "/NotFoundException", 14 | "detail": "The gift certificate with the provided code could not be retrieved.", 15 | "title": "Not Found", 16 | "instance":"/foo" 17 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-gift-certificates/gift-certificate-traits-library.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Library 2 | usage: Use the following traits for request and response status information. 3 | 4 | uses: 5 | ApiStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/api-standards.raml 6 | 7 | traits: 8 | NotFound: !include Traits/NotFoundException.raml 9 | -------------------------------------------------------------------------------- /apis/shopper-orders/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-orders/0.4.8", 3 | "name": "Shopper Orders", 4 | "description": "Finish the shopper checkout experience resulting in an order.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-orders", 7 | "version": "0.4.8", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Checkout" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-orders/examples/order/order-lookup-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | order-lookup-request: 3 | { 4 | "email": "no-reply@salesforce.com", 5 | "orderViewCode": "YGXrGbZWlr29tIsGnYgR5o_8OxBMXWigevx1WD0X1Hc" 6 | } -------------------------------------------------------------------------------- /apis/shopper-orders/examples/order/order-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "basketId":"a10ff320829cb0eef93ca5310a" 5 | } 6 | -------------------------------------------------------------------------------- /apis/shopper-orders/examples/order/payment-instrument-patch-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount": 2, 5 | "paymentMethodId": "CREDIT_CARD", 6 | "paymentCard": { 7 | "cardType": "Visa", 8 | "maskedNumber" : "****-****-****-4567" 9 | } 10 | } -------------------------------------------------------------------------------- /apis/shopper-orders/examples/order/payment-instrument-post-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "amount": 700, 5 | "paymentCard":{ 6 | "expirationYear":1990, 7 | "expirationMonth":7, 8 | "validFromMonth":8, 9 | "validFromYear":2007, 10 | "issueNumber":"i117", 11 | "maskedNumber":"************4567", 12 | "holder":"Miller", 13 | "cardType":"Visa" 14 | }, 15 | "paymentMethodId": "CREDIT_CARD" 16 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/bad-request-auth.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request", 5 | "title": "Bad Request", 6 | "detail": "The customer is invalid." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/bad-request-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/bad-request", 5 | "title": "Bad Request", 6 | "detail": "Decoding of the property with path '$.failedExample.[1].intProperty' failed because the expected type is 'Integer|Decimal' but the actual type was 'String'." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/basket-not-found.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/basket-not-found", 5 | "title": "Basket Not Found", 6 | "detail": "No basket with ID '123' could be found." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/forbidden", 5 | "title": "Forbidden", 6 | "detail": "The shipment with ID 'me' corresponds to the default shipment and can't be deleted." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/invalid-tax-mode.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-tax-mode", 5 | "title": "Invalid Tax Mode", 6 | "detail": "Basket with ID 'a10ff320829cb0eef93ca5310a' has invalid tax mode." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/order-not-found.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/order-not-found", 5 | "title": "Order Not Found", 6 | "detail": "No order with number '123' was found." 7 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/shipment-not-found.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/shipment-not-found", 5 | "title": "Shipment Not Found", 6 | "detail": "The shipping method with ID '123' is unknown or can't be applied to the basket." 7 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/examples/error/unsupported-request.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unsupported-request-if-scapi-hooks-enabled", 5 | "title": "Unsupported Request If SCAPI Hooks Enabled", 6 | "detail": "You can't call this endpoint because Salesforce Commerce API hook execution is enabled." 7 | } 8 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/checkout-data-types/2.0.5/exchange.json: -------------------------------------------------------------------------------- 1 | {"dependencies":[{"version":"2.0.1","assetId":"commerce-cloud-standards","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8"}],"version":"2.0.5","originalFormatVersion":"1.0","apiVersion":"v1","descriptorVersion":"0.1.0","classifier":"raml-fragment","main":"checkout-data-types.raml","assetId":"checkout-data-types","groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","organizationId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","name":"Checkout Data Types","tags":[],"metadata":{"projectId":"ac07ef0d-aa14-4469-95b7-95c115af175a","branchId":"v2","commitId":"e7cad8834ddd908357c9160b31f3f9de2939fa01"}} -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-orders/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-products/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-products/0.0.37", 3 | "name": "Shopper Products", 4 | "description": "Display product details across your storefront.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-products", 7 | "version": "0.0.37", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Product" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-products/Traits/BadRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 400 response. 3 | responses: 4 | 400: 5 | description: Bad Request. 6 | body: 7 | application/problem+json: 8 | type: ErrorResponse 9 | example: | 10 | { 11 | "title": "Bad Request", 12 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/validation", 13 | "detail": "Maximum number of products you can request in one call is 25." 14 | } -------------------------------------------------------------------------------- /apis/shopper-products/Traits/GetProductsBadRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 400 response. 3 | responses: 4 | 400: 5 | description: Bad Request. 6 | body: 7 | application/problem+json: 8 | type: ErrorResponse 9 | examples: 10 | MalformedSelectorGetProducts: | 11 | { 12 | "title": "Malformed Selector", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/malformed-selector", 14 | "detail": "The property selector '(data.(name, imageGroups.(**))' is malformed.", 15 | "selector": "(data.(name, imageGroups.(**))" 16 | } 17 | -------------------------------------------------------------------------------- /apis/shopper-products/Traits/NotFound.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 404 response. 3 | 4 | responses: 5 | 404: 6 | description: Not Found. 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: | 11 | { 12 | "title": "Product Not Found", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/product-not-found", 14 | "detail": "No product with ID 'pple-ipod-shuffle' for site 'SiteGenesis' could be found.", 15 | "productId": "pple-ipod-shuffle", 16 | "siteId": "SiteGenesis" 17 | } -------------------------------------------------------------------------------- /apis/shopper-products/Traits/Unauthorized.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 401 response in case of authorization failure. 3 | 4 | responses: 5 | 401: 6 | description: Unauthorized. 7 | body: 8 | application/problem+json: 9 | type: ErrorResponse 10 | example: | 11 | { 12 | "title": "Invalid Access Token", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-access-token", 14 | "detail": "The request is unauthorized, the access token is invalid.", 15 | "accessToken": "hbGciOiJIUzI1NiIsInR5cCI6Ikp" 16 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-products/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-products/products-traits-library.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Library 2 | usage: Use the following traits for request and response status information 3 | 4 | uses: 5 | ApiStandards: exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/api-standards.raml 6 | types: 7 | ErrorResponse: ApiStandards.ErrorResponse 8 | 9 | traits: 10 | Unauthorized: !include Traits/Unauthorized.raml 11 | BadRequest1: !include Traits/GetProductBadRequest.raml 12 | BadRequest2: !include Traits/GetProductsBadRequest.raml 13 | BadRequest: !include Traits/BadRequest.raml 14 | NotFound: !include Traits/NotFound.raml -------------------------------------------------------------------------------- /apis/shopper-promotions/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-promotions/1.0.27", 3 | "name": "Shopper Promotions", 4 | "description": "View details for active promotions.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-promotions", 7 | "version": "1.0.27", 8 | "categories": { 9 | "API layer": [ 10 | "System" 11 | ], 12 | "CC API Family": [ 13 | "Pricing" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-promotions/Examples/get_campaings_400.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-operation", 5 | "detail": "Thrown when a start date but no end date was given, when an end date but no start date was given, or when the given end date is before the given start date", 6 | "title": "Incorrect Syntax" 7 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/Examples/promotions_result.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "limit": 2, 5 | "data": [ 6 | { 7 | "calloutMsg": "Buy5for50", 8 | "details": "Buy5for50", 9 | "id": "Buy5for50", 10 | "name": "Buy5for50" 11 | }, 12 | { 13 | "calloutMsg": "$5 off Men's Ties", 14 | "details": "$5 off Men's Ties (with coupon)", 15 | "id": "$5_off_ties_promotion", 16 | "name": "5 Off Ties Promotion" 17 | } 18 | ], 19 | "total": 2 20 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/Traits/PromotionNotFound.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 404 response in Shop Products API. 3 | responses: 4 | 404: 5 | description: 6 | Thrown when there is no promotion found with the given ID for the requested site. 7 | body: 8 | application/json: 9 | type: Error 10 | example: | 11 | { 12 | "type": "/PromotionNotFoundException", 13 | "detail": "There is no promotion found with the given ID for the requested site.", 14 | "title": "Not Found", 15 | "instance":"/foo" 16 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/Traits/badrequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 400 response in Data Promotions API. 3 | responses: 4 | 400: 5 | description: 6 | Thrown when a start date but no end date was given, when an end date but no start date was given, or when the given end date is before the given start date. 7 | body: 8 | application/json: 9 | type: Error 10 | example: | 11 | { 12 | "type": "/InvalidDateException", 13 | "detail": "Invalid Start or End Date", 14 | "title": "Invalid Start or End Date", 15 | "instance":"/foo" 16 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-promotions/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-promotions/promotion-traits-library.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Library 2 | usage: Use the following traits for request and response status information 3 | 4 | types: 5 | Error: !include exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/dataTypes/error-response.raml 6 | 7 | traits: 8 | PromotionNotFound: !include Traits/PromotionNotFound.raml 9 | badrequest: !include Traits/badrequest.raml -------------------------------------------------------------------------------- /apis/shopper-search/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-search/1.0.42", 3 | "name": "Shopper Search", 4 | "description": "product search and helpful search suggestions.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-search", 7 | "version": "1.0.42", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Discovery" 14 | ], 15 | "CC Version Status": [ 16 | "GA" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-search/Examples/product-search-400-error-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | 3 | value: 4 | { 5 | "title": "Malformed Price Refinement", 6 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/malformed-price-refinement", 7 | "detail": "The price refinement '(0.500)' is malformed. Something similar to '(0..100)' was expected.", 8 | "malformedPrice": "(0.500)" 9 | } -------------------------------------------------------------------------------- /apis/shopper-search/Examples/search-suggestion-400-error-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "title": "String Constraint Violation", 5 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/string-constraint-violation", 6 | "detail": "The string length constraint was violated by 'q'. The expected length is '(3..50)'.", 7 | "expected": "(3..50)", 8 | "parameter": "q" 9 | } -------------------------------------------------------------------------------- /apis/shopper-search/Traits/Unauthorized.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 401 response in case of authorization failure. 3 | 4 | responses: 5 | 401: 6 | description: Unauthorized. 7 | body: 8 | application/problem+json: 9 | type: ApiStandards.ErrorResponse 10 | example: 11 | { 12 | "title": "Invalid Access Token", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-access-token", 14 | "detail": "The request is unauthorized, the access token is invalid.", 15 | "accessToken": "hbGciOiJIUzI1NiIsInR5cCI6Ikp" 16 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-search/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-seo/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-seo/1.0.9", 3 | "name": "Shopper Seo", 4 | "description": "", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-seo", 7 | "version": "1.0.9", 8 | "categories": { 9 | "API layer": [ 10 | "System" 11 | ], 12 | "CC API Family": [ 13 | "Customer" 14 | ], 15 | "CC API Visibility": [ 16 | "External" 17 | ] 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /apis/shopper-seo/Example/seo-url-mapping-response-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "resourceType": "CATEGORY", 5 | "resourceId": "new-arrivals-tops", 6 | "refinements": { 7 | "refinementColor": "Blue" 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-seo/Traits/BadRequest.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: Thrown if the request is malformed, incomplete or otherwise erroneous. 3 | responses: 4 | '400': 5 | description: The locale is invalid. Confirm that you passed in a locale in the valid format of ISO 639-1 for the language code and ISO 3166-1 for the country code. For example, en-US. 6 | body: 7 | application/problem+json: 8 | type: ApiStandards.ErrorResponse 9 | example: | 10 | { 11 | "title": "Unknown Locale", 12 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/unknown-locale", 13 | "detail": "The locale 'ab-CD' is unknown.", 14 | "locale": "ab-CD" 15 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "dependencies": [ 3 | { 4 | "version": "1.1.15", 5 | "assetId": "api-standards", 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 7 | }, 8 | { 9 | "version": "2.0.1", 10 | "assetId": "commerce-cloud-standards", 11 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 12 | } 13 | ], 14 | "version": "1.0.9", 15 | "apiVersion": "v1", 16 | "descriptorVersion": "0.1.0", 17 | "classifier": "raml", 18 | "main": "shopper-seo.raml", 19 | "assetId": "shopper-seo", 20 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 21 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 22 | "name": "Shopper Seo", 23 | "tags": [] 24 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-seo/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-stores/.metadata.json: -------------------------------------------------------------------------------- 1 | { 2 | "id": "893f605e-10e2-423a-bdb4-f952f56eb6d8/shopper-stores/1.0.15", 3 | "name": "Shopper Stores", 4 | "description": "Search for a specific store or stores in an area.", 5 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 6 | "assetId": "shopper-stores", 7 | "version": "1.0.15", 8 | "categories": { 9 | "API layer": [ 10 | "Process" 11 | ], 12 | "CC API Family": [ 13 | "Seller" 14 | ], 15 | "CC Version Status": [ 16 | "Beta" 17 | ], 18 | "CC API Visibility": [ 19 | "External" 20 | ] 21 | } 22 | } 23 | -------------------------------------------------------------------------------- /apis/shopper-stores/Example/stores-400-error-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | value: 3 | { 4 | "title": "Missing Postal Code", 5 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/missing-postal-code", 6 | "detail": "The input parameter 'postal_code' is required when no coordinates are provided." 7 | } -------------------------------------------------------------------------------- /apis/shopper-stores/Traits/Unauthorized.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | description: This trait represents API behavior for a 401 response in case of authorization failure. 3 | 4 | responses: 5 | 401: 6 | description: Unauthorized. 7 | body: 8 | application/problem+json: 9 | type: ApiStandards.ErrorResponse 10 | example: | 11 | { 12 | "title": "Invalid Access Token", 13 | "type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/invalid-access-token", 14 | "detail": "The request is unauthorized, the access token is invalid.", 15 | "accessToken": "hbGciOiJIUzI1NiIsInR5cCI6Ikp" 16 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/shopper-stores/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /apis/shopper-stores/shopper-stores-description.md: -------------------------------------------------------------------------------- 1 | # API Overview 2 | 3 | Provides access to stores via search or ID lookup. 4 | 5 | 6 | ## Authentication & Authorization 7 | 8 | The Shopper Stores API requires a shopper access token from the [Shopper Login and API Access Service (SLAS).](https://developer.salesforce.com/docs/commerce/commerce-api/guide/authorization-for-shopper-apis.html) 9 | 10 | You must include the relevant scope(s) in the client ID used to generate the SLAS token. For details, see [Authorization Scopes Catalog.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/auth-z-scope-catalog.html) -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "dependencies": [ 3 | { 4 | "version": "1.1.15", 5 | "assetId": "api-standards", 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "provided": false 8 | }, 9 | { 10 | "version": "2.0.1", 11 | "assetId": "commerce-cloud-standards", 12 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 13 | "provided": false 14 | } 15 | ], 16 | "version": "1.39.36", 17 | "apiVersion": "1.39.36", 18 | "descriptorVersion": "1.0.0", 19 | "classifier": "raml", 20 | "main": "shopper-login.raml", 21 | "assetId": "slas-shopper-login-uap", 22 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 23 | "name": "SLAS Shopper Login-UAP" 24 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/exchange.json: -------------------------------------------------------------------------------- 1 | {"main":"api-standards.raml","name":"API Standards","classifier":"raml-fragment","tags":[],"groupId":"893f605e-10e2-423a-bdb4-f952f56eb6d8","backwardsCompatible":false,"assetId":"api-standards","version":"1.1.15","apiVersion":"v1","dependencies":[],"originalFormatVersion":"1.0"} -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip180-warn-299-example.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip180-warn-299-example: -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/snippets/aip193-errors-403-forbidden.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 NamedExample 2 | aip193-errors-403-forbidden: -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/async-created.raml: -------------------------------------------------------------------------------- 1 | #%RAML 1.0 Trait 2 | 3 | usage: | 4 | To be applied on endpoints that synchronously create resources. 5 | 6 | responses: 7 | 202: 8 | description: A successful response for an asyncronous resource provisioning request, with a Location header indicating where the created resource can be found. 9 | headers: 10 | Location: 11 | description: URL where the new <> can be found 12 | examples: 13 | deployment-location: <>/3f6b7470-dcba-11e6-bf26-cec0c932ce01 14 | 15 | -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-429.raml: -------------------------------------------------------------------------------- 1 | description: The user has sent too many requests in a given amount of time ("rate limiting") 2 | headers: 3 | Retry-After: 4 | examples: 5 | after-seconds: "120" 6 | body: 7 | application/problem+json: 8 | type: !include ../../dataTypes/error-response.raml 9 | example: 10 | type: "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests" 11 | title: Too Many Requests 12 | detail: You have performed too many requests in a short period of time. -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/api-standards/1.1.15/traits/private/rate-limited-include-headers.raml: -------------------------------------------------------------------------------- 1 | headers: 2 | X-RateLimit-Limit: 3 | description: The maximum number of requests permitted per minute. 4 | X-RateLimit-Remaining: 5 | description: The number of requests remaining in the current rate limit window. 6 | X-RateLimit-Reset: 7 | description: The time at which the current rate limit window resets in UTC epoch seconds. -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "operator": "and", 3 | "filters": [ 4 | { 5 | "termFilter": { 6 | "field": "id", 7 | "operator": "is", 8 | "values": [ 9 | "myId" 10 | ] 11 | } 12 | }, 13 | { 14 | "termFilter": { 15 | "field": "couponId", 16 | "operator": "is", 17 | "values": [ 18 | "couponOne" 19 | ] 20 | } 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/BoolQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "must": [ 3 | { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "DEAL" 9 | } 10 | }, 11 | { 12 | "textQuery": { 13 | "fields": [ 14 | "description" 15 | ], 16 | "searchPhrase": "Big bargain deal" 17 | } 18 | } 19 | ], 20 | "mustNot": [ 21 | { 22 | "termQuery": { 23 | "fields": [ 24 | "enabled" 25 | ], 26 | "operator": "is", 27 | "values": [ 28 | false 29 | ] 30 | } 31 | } 32 | ] 33 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "termFilter": { 3 | "field": "enabled", 4 | "operator": "is", 5 | "values": [ 6 | false 7 | ] 8 | } 9 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/FilteredQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "textQuery": { 4 | "fields": [ 5 | "couponId" 6 | ], 7 | "searchPhrase": "disabled" 8 | } 9 | }, 10 | "filter": { 11 | "termFilter": { 12 | "field": "enabled", 13 | "operator": "is", 14 | "values": [ 15 | false 16 | ] 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Query.json: -------------------------------------------------------------------------------- 1 | { 2 | "filteredQuery": { 3 | "query": { 4 | "textQuery": { 5 | "fields": [ 6 | "couponId" 7 | ], 8 | "searchPhrase": "disabled" 9 | } 10 | }, 11 | "filter": { 12 | "termFilter": { 13 | "field": "enabled", 14 | "operator": "is", 15 | "values": [ 16 | false 17 | ] 18 | } 19 | } 20 | } 21 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/QueryFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "query": { 3 | "termQuery": { 4 | "fields": [ 5 | "enabled", 6 | "active" 7 | ], 8 | "operator": "is", 9 | "values": [ 10 | false 11 | ] 12 | } 13 | } 14 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/Range2Filter.json: -------------------------------------------------------------------------------- 1 | { 2 | "fromField": "validFrom", 3 | "toField": "validTo", 4 | "filterMode": "overlap", 5 | "fromValue": "2007-01-01T00:00:00.000Z", 6 | "toValue": "2017-01-01T00:00:00.000Z" 7 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/RangeFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "redemptionCount", 3 | "from": 0, 4 | "to": 10, 5 | "fromInclusive": false 6 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/SearchRequestBase.json: -------------------------------------------------------------------------------- 1 | { 2 | "limit" : 4, 3 | "query" : { 4 | "textQuery": { 5 | "fields": ["id", "description"], 6 | "searchPhrase": "campaign" 7 | } 8 | }, 9 | "offset" : 2 10 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermFilter.json: -------------------------------------------------------------------------------- 1 | { 2 | "field": "id", 3 | "operator": "is", 4 | "values": [ 5 | "myId" 6 | ] 7 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TermQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "enabled" 4 | ], 5 | "operator": "is", 6 | "values": [ 7 | false 8 | ] 9 | } -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/Examples/TextQuery.json: -------------------------------------------------------------------------------- 1 | { 2 | "fields": [ 3 | "couponId" 4 | ], 5 | "searchPhrase": "limit" 6 | } 7 | -------------------------------------------------------------------------------- /apis/slas-shopper-login-uap/exchange_modules/893f605e-10e2-423a-bdb4-f952f56eb6d8/commerce-cloud-standards/2.0.1/exchange.json: -------------------------------------------------------------------------------- 1 | { 2 | "main": "commerce-cloud-standards.raml", 3 | "name": "Commerce Cloud Standards", 4 | "classifier": "raml-fragment", 5 | "tags": [], 6 | "groupId": "893f605e-10e2-423a-bdb4-f952f56eb6d8", 7 | "assetId": "commerce-cloud-standards", 8 | "version": "2.0.1", 9 | "organizationId": "893f605e-10e2-423a-bdb4-f952f56eb6d8" 10 | } -------------------------------------------------------------------------------- /babel.config.jest.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2021, salesforce.com, inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | module.exports = { 8 | plugins: ['@babel/plugin-proposal-class-properties'], 9 | presets: [ 10 | [ 11 | '@babel/preset-env', 12 | { 13 | targets: { 14 | node: 'current', 15 | }, 16 | }, 17 | ], 18 | '@babel/typescript', 19 | ], 20 | ignore: ['node_modules/**'], 21 | }; 22 | -------------------------------------------------------------------------------- /docs/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/docs/.nojekyll -------------------------------------------------------------------------------- /docs/assets/images/icons.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/docs/assets/images/icons.png -------------------------------------------------------------------------------- /docs/assets/images/icons@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/docs/assets/images/icons@2x.png -------------------------------------------------------------------------------- /docs/assets/images/widgets.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/docs/assets/images/widgets.png -------------------------------------------------------------------------------- /docs/assets/images/widgets@2x.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/docs/assets/images/widgets@2x.png -------------------------------------------------------------------------------- /netlify.toml: -------------------------------------------------------------------------------- 1 | # COMMENT: This a rule for Single Page Applications as Docz site is one 2 | [[redirects]] 3 | from = "/*" 4 | to = "/" 5 | status = 200 -------------------------------------------------------------------------------- /public/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/public/favicon.ico -------------------------------------------------------------------------------- /public/logo192.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/public/logo192.png -------------------------------------------------------------------------------- /public/logo512.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/SalesforceCommerceCloud/commerce-sdk-isomorphic/24c65fbafb1833fb4ec0165b36009fb443f518e6/public/logo512.png -------------------------------------------------------------------------------- /public/manifest.json: -------------------------------------------------------------------------------- 1 | { 2 | "short_name": "React App", 3 | "name": "Create React App Sample", 4 | "icons": [ 5 | { 6 | "src": "favicon.ico", 7 | "sizes": "64x64 32x32 24x24 16x16", 8 | "type": "image/x-icon" 9 | }, 10 | { 11 | "src": "logo192.png", 12 | "type": "image/png", 13 | "sizes": "192x192" 14 | }, 15 | { 16 | "src": "logo512.png", 17 | "type": "image/png", 18 | "sizes": "512x512" 19 | } 20 | ], 21 | "start_url": ".", 22 | "display": "standalone", 23 | "theme_color": "#000000", 24 | "background_color": "#ffffff" 25 | } 26 | -------------------------------------------------------------------------------- /public/robots.txt: -------------------------------------------------------------------------------- 1 | # https://www.robotstxt.org/robotstxt.html 2 | User-agent: * 3 | -------------------------------------------------------------------------------- /src/environment/App/index.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020, salesforce.com, inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | export {default} from './App'; 8 | -------------------------------------------------------------------------------- /src/environment/config.js: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020, salesforce.com, inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | const config = { 8 | proxy: 'https://localhost:3000', 9 | headers: {}, 10 | parameters: { 11 | clientId: 'CLIENT_ID', 12 | organizationId: 'ORGANIZATION_ID', 13 | shortCode: 'SHORT_CODE', 14 | siteId: 'SITE_ID', 15 | }, 16 | }; 17 | export {config as default}; 18 | -------------------------------------------------------------------------------- /src/index.jsx: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2020, salesforce.com, inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | 8 | // eslint-disable-next-line no-use-before-define 9 | import React from 'react'; 10 | import ReactDOM from 'react-dom'; 11 | import App from './environment/App'; 12 | 13 | ReactDOM.render(, document.getElementById('root')); 14 | -------------------------------------------------------------------------------- /src/static/config.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2024, Salesforce, Inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | // eslint-disable-next-line import/prefer-default-export 8 | export const CUSTOM_API_DEFAULT_BASE_URI = 9 | 'https://{shortCode}.api.commercecloud.salesforce.com/custom/{apiName}/{apiVersion}'; 10 | -------------------------------------------------------------------------------- /src/static/helpers/index.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2022, Salesforce, Inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | // This file should not be used for internal package imports. 8 | // Doing so may lead to circular dependencies or duplicate exports (due to rollup mangling the types) 9 | export * from './environment'; 10 | export * from './slasHelper'; 11 | export * from './types'; 12 | export * from './customApi'; 13 | export * from './fetchHelper'; 14 | -------------------------------------------------------------------------------- /src/static/responseError.ts: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2022, salesforce.com, inc. 3 | * All rights reserved. 4 | * SPDX-License-Identifier: BSD-3-Clause 5 | * For full license text, see the LICENSE file in the repo root or https://opensource.org/licenses/BSD-3-Clause 6 | */ 7 | 8 | /** 9 | * Extends the Error class with the the error being a combination of status code 10 | * and text retrieved from the response. 11 | * 12 | * @class ResponseError 13 | * @extends Error 14 | */ 15 | export default class ResponseError extends Error { 16 | constructor(public response: Response) { 17 | super(`${response.status} ${response.statusText}`); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /templates/dtoPartial.ts.hbs: -------------------------------------------------------------------------------- 1 | {{#if (isArrayType typeDto)}} 2 | {{{getDataType typeDto}}}; 3 | {{else}} 4 | { 5 | {{#each (getProperties typeDto)}} 6 | {{#if (isRequiredProperty .)}} 7 | {{{getValue name}}}: {{#or (eq (getTypeFromProperty this) "object")}}{{> dtoPartial typeDto=range }}{{else}}{{{getTypeFromProperty this}}}{{/or}}; 8 | {{else if (isOptionalProperty .)}} 9 | {{{getValue name}}}?: {{#or (eq (getTypeFromProperty this) "object")}}{{> dtoPartial typeDto=range }}{{else}}{{{getTypeFromProperty this}}}{{/or}}; 10 | {{/if}} 11 | {{/each}} 12 | } 13 | 14 | {{~#if (isAdditionalPropertiesAllowed typeDto)}} 15 | & { [key: string]: any } 16 | {{/if}} 17 | {{/if}} 18 | -------------------------------------------------------------------------------- /templates/index.ts.hbs: -------------------------------------------------------------------------------- 1 | {{#each children}} 2 | export { {{name.upperCamelCase}} } from "./{{name.lowerCamelCase}}"; 3 | import type * as {{name.upperCamelCase}}Types from "./{{name.lowerCamelCase}}"; 4 | export type { {{name.upperCamelCase}}Types }; 5 | {{/each}} 6 | export type { ClientConfigInit } from "./clientConfig"; 7 | // Can't currently use `export from` with default exports 8 | import ClientConfig from "./clientConfig"; 9 | import TemplateURL from "./templateUrl"; 10 | export { ClientConfig, TemplateURL }; 11 | 12 | import * as helpers from "./helpers"; 13 | export { helpers }; 14 | -------------------------------------------------------------------------------- /templates/paramKeys.ts.hbs: -------------------------------------------------------------------------------- 1 | static readonly paramKeys = { 2 | {{#each encodes.endPoints}} 3 | {{#each operations}} 4 | {{{name}}}: [ 5 | {{#each ../parameters}} 6 | '{{{name}}}', 7 | {{/each}} 8 | {{#each request.queryParameters}} 9 | '{{{name}}}', 10 | {{/each}} 11 | ], 12 | {{{name}}}Required: [ 13 | {{#each ../parameters}} 14 | '{{{name}}}', 15 | {{/each}} 16 | {{#each request.queryParameters}} 17 | {{#if (is required "true")}} 18 | '{{{name}}}', 19 | {{/if}} 20 | {{/each}} 21 | ], 22 | {{/each}} 23 | {{/each}} 24 | } as const; 25 | -------------------------------------------------------------------------------- /templates/version.ts.hbs: -------------------------------------------------------------------------------- 1 | export const USER_AGENT_HEADER = "user-agent"; 2 | export const USER_AGENT_VALUE = "commerce-sdk-isomorphic@{{metadata.sdkVersion}}"; 3 | --------------------------------------------------------------------------------