@salesforce/b2c-tooling-sdk 2.3.0 → 2.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/enrichment.json +291 -0
- package/data/guides/index.json +426 -37
- package/data/schemas/dw.schema.json +590 -0
- package/data/tooling/index.json +18 -9
- package/dist/esm/cli/base-command.d.ts +20 -1
- package/dist/esm/cli/base-command.js +61 -11
- package/dist/esm/cli/base-command.js.map +1 -1
- package/dist/esm/cli/cartridge-command.js +2 -1
- package/dist/esm/cli/cartridge-command.js.map +1 -1
- package/dist/esm/cli/command-search.d.ts +85 -0
- package/dist/esm/cli/command-search.js +147 -0
- package/dist/esm/cli/command-search.js.map +1 -0
- package/dist/esm/cli/config.d.ts +10 -1
- package/dist/esm/cli/config.js +18 -9
- package/dist/esm/cli/config.js.map +1 -1
- package/dist/esm/cli/hooks.d.ts +13 -0
- package/dist/esm/cli/hooks.js +11 -0
- package/dist/esm/cli/hooks.js.map +1 -1
- package/dist/esm/cli/index.d.ts +2 -0
- package/dist/esm/cli/index.js +2 -0
- package/dist/esm/cli/index.js.map +1 -1
- package/dist/esm/cli/instance-command.d.ts +1 -0
- package/dist/esm/cli/instance-command.js +2 -1
- package/dist/esm/cli/instance-command.js.map +1 -1
- package/dist/esm/cli/mrt-command.d.ts +3 -2
- package/dist/esm/cli/mrt-command.js +4 -4
- package/dist/esm/cli/mrt-command.js.map +1 -1
- package/dist/esm/cli/oauth-command.d.ts +1 -0
- package/dist/esm/cli/ods-command.d.ts +1 -0
- package/dist/esm/cli/webdav-command.d.ts +1 -0
- package/dist/esm/clients/custom-apis.d.ts +36 -2
- package/dist/esm/clients/custom-apis.js +57 -4
- package/dist/esm/clients/custom-apis.js.map +1 -1
- package/dist/esm/clients/index.d.ts +1 -1
- package/dist/esm/clients/index.js +1 -1
- package/dist/esm/clients/index.js.map +1 -1
- package/dist/esm/clients/scapi-backend-utils.d.ts +15 -0
- package/dist/esm/clients/scapi-backend-utils.js +28 -1
- package/dist/esm/clients/scapi-backend-utils.js.map +1 -1
- package/dist/esm/clients/scapi-fallback-backend.js +2 -2
- package/dist/esm/clients/scapi-fallback-backend.js.map +1 -1
- package/dist/esm/clients/scapi-schemas.generated.d.ts +2 -2
- package/dist/esm/compat/dispatcher.js +2 -2
- package/dist/esm/compat/dispatcher.js.map +1 -1
- package/dist/esm/config/config-origins.d.ts +19 -0
- package/dist/esm/config/config-origins.js +11 -0
- package/dist/esm/config/config-origins.js.map +1 -0
- package/dist/esm/config/config-write.d.ts +86 -0
- package/dist/esm/config/config-write.js +296 -0
- package/dist/esm/config/config-write.js.map +1 -0
- package/dist/esm/config/dw-json-schema.d.ts +14 -0
- package/dist/esm/config/dw-json-schema.js +269 -0
- package/dist/esm/config/dw-json-schema.js.map +1 -0
- package/dist/esm/config/dw-json.d.ts +2 -0
- package/dist/esm/config/dw-json.js +10 -6
- package/dist/esm/config/dw-json.js.map +1 -1
- package/dist/esm/config/index.d.ts +13 -4
- package/dist/esm/config/index.js +8 -3
- package/dist/esm/config/index.js.map +1 -1
- package/dist/esm/config/instance-manager.d.ts +64 -28
- package/dist/esm/config/instance-manager.js +145 -63
- package/dist/esm/config/instance-manager.js.map +1 -1
- package/dist/esm/config/mapping.d.ts +5 -0
- package/dist/esm/config/mapping.js +20 -1
- package/dist/esm/config/mapping.js.map +1 -1
- package/dist/esm/config/project-environment.d.ts +62 -0
- package/dist/esm/config/project-environment.js +113 -0
- package/dist/esm/config/project-environment.js.map +1 -1
- package/dist/esm/config/resolver.d.ts +22 -0
- package/dist/esm/config/resolver.js +106 -37
- package/dist/esm/config/resolver.js.map +1 -1
- package/dist/esm/config/sources/dw-json-source.d.ts +9 -1
- package/dist/esm/config/sources/dw-json-source.js +59 -23
- package/dist/esm/config/sources/dw-json-source.js.map +1 -1
- package/dist/esm/config/sources/env-source.d.ts +70 -9
- package/dist/esm/config/sources/env-source.js +205 -47
- package/dist/esm/config/sources/env-source.js.map +1 -1
- package/dist/esm/config/sources/index.d.ts +1 -1
- package/dist/esm/config/sources/index.js +1 -1
- package/dist/esm/config/sources/index.js.map +1 -1
- package/dist/esm/config/types.d.ts +53 -3
- package/dist/esm/docs/search.js +3 -1
- package/dist/esm/docs/search.js.map +1 -1
- package/dist/esm/docs/types.d.ts +3 -1
- package/dist/esm/guidance/bundle.d.ts +33 -0
- package/dist/esm/guidance/bundle.js +268 -0
- package/dist/esm/guidance/bundle.js.map +1 -0
- package/dist/esm/guidance/catalog.d.ts +8 -1
- package/dist/esm/guidance/catalog.js +48 -6
- package/dist/esm/guidance/catalog.js.map +1 -1
- package/dist/esm/guidance/index.d.ts +1 -0
- package/dist/esm/guidance/index.js +1 -0
- package/dist/esm/guidance/index.js.map +1 -1
- package/dist/esm/guidance/types.d.ts +17 -1
- package/dist/esm/guidance/types.js.map +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/operations/jobs/run-system-job.js +2 -2
- package/dist/esm/operations/jobs/run-system-job.js.map +1 -1
- package/dist/esm/plugins/discovery.js +2 -1
- package/dist/esm/plugins/discovery.js.map +1 -1
- package/dist/esm/scapi/catalog.d.ts +5 -2
- package/dist/esm/scapi/catalog.js.map +1 -1
- package/dist/esm/scapi/index.d.ts +6 -2
- package/dist/esm/scapi/index.js +4 -2
- package/dist/esm/scapi/index.js.map +1 -1
- package/dist/esm/scapi/live.d.ts +14 -3
- package/dist/esm/scapi/live.js +33 -5
- package/dist/esm/scapi/live.js.map +1 -1
- package/dist/esm/scapi/local.d.ts +26 -0
- package/dist/esm/scapi/local.js +143 -0
- package/dist/esm/scapi/local.js.map +1 -0
- package/dist/esm/scapi/request.d.ts +2 -2
- package/dist/esm/scapi/request.js +4 -2
- package/dist/esm/scapi/request.js.map +1 -1
- package/dist/esm/scapi/runtime.d.ts +5 -0
- package/dist/esm/scapi/runtime.js.map +1 -1
- package/dist/esm/scapi/schema-source.d.ts +90 -0
- package/dist/esm/scapi/schema-source.js +146 -0
- package/dist/esm/scapi/schema-source.js.map +1 -0
- package/dist/esm/scapi/worker-source.js +31 -7
- package/dist/esm/scapi/worker-source.js.map +1 -1
- package/dist/esm/telemetry/telemetry.d.ts +1 -0
- package/dist/esm/telemetry/telemetry.js +18 -1
- package/dist/esm/telemetry/telemetry.js.map +1 -1
- package/dist/esm/telemetry/types.d.ts +9 -0
- package/dist/esm/test-utils/config-isolation.js +21 -15
- package/dist/esm/test-utils/config-isolation.js.map +1 -1
- package/dist/esm/ux/agent-context.d.ts +69 -0
- package/dist/esm/ux/agent-context.js +133 -0
- package/dist/esm/ux/agent-context.js.map +1 -0
- package/dist/esm/ux/confirm.d.ts +27 -0
- package/dist/esm/ux/confirm.js +32 -0
- package/dist/esm/ux/confirm.js.map +1 -1
- package/dist/esm/ux/index.d.ts +2 -1
- package/dist/esm/ux/index.js +2 -1
- package/dist/esm/ux/index.js.map +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/manifest.json +83 -42
- package/node_modules/@salesforce/b2c-api-schemas/package.json +1 -1
- package/node_modules/@salesforce/b2c-api-schemas/scapi/cdn/zones/v1.json +6798 -238
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/orders/v1.json +2296 -205
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v1.json +5571 -666
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-baskets/v2.json +6062 -371
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-orders/v1.json +3426 -360
- package/node_modules/@salesforce/b2c-api-schemas/scapi/checkout/shopper-payments/v1.json +351 -99
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/cors/v1.json +172 -12
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/preferences/v1.json +1497 -111
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/shopper-configurations/v1.json +202 -36
- package/node_modules/@salesforce/b2c-api-schemas/scapi/configuration/timeouts/v1.json +79 -10
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/custom-objects/v1.json +785 -49
- package/node_modules/@salesforce/b2c-api-schemas/scapi/custom-object/shopper-custom-objects/v1.json +191 -40
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/customers/v1.json +1483 -107
- package/node_modules/@salesforce/b2c-api-schemas/scapi/customer/shopper-customers/v1.json +4854 -787
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/custom-apis/v1.json +119 -15
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/object-definitions/v1.json +1699 -80
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scapi-schemas/v1.json +252 -18
- package/node_modules/@salesforce/b2c-api-schemas/scapi/dx/scripts/v1.json +329 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/experiences/v1.json +4208 -234
- package/node_modules/@salesforce/b2c-api-schemas/scapi/experience/shopper-experience/v1.json +1591 -247
- package/node_modules/@salesforce/b2c-api-schemas/scapi/intelligence/analytics/v1.json +396 -8
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/availability/v1.json +1242 -69
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/impex/v1.json +2354 -248
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/reservation/v1.json +1550 -45
- package/node_modules/@salesforce/b2c-api-schemas/scapi/inventory/segmentation/v1.json +6615 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/roles/v1.json +1520 -59
- package/node_modules/@salesforce/b2c-api-schemas/scapi/merchant/users/v1.json +397 -17
- package/node_modules/@salesforce/b2c-api-schemas/scapi/observability/metrics/v1.json +1241 -27
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/jobs/v1.json +1069 -68
- package/node_modules/@salesforce/b2c-api-schemas/scapi/operation/replications/v1.json +410 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/assignments/v1.json +502 -102
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/campaigns/v1.json +1112 -94
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/coupons/v1.json +820 -93
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/gift-certificates/v1.json +845 -92
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/promotions/v1.json +2716 -674
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-gift-certificates/v1.json +130 -47
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/shopper-promotions/v1.json +233 -63
- package/node_modules/@salesforce/b2c-api-schemas/scapi/pricing/source-code-groups/v1.json +630 -70
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/catalogs/v1.json +2886 -348
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/inventory-lists/v1.json +520 -19
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/price-books/v1.json +3115 -293
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/products/v1.json +3313 -138
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-availability/v1.json +266 -52
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-delivery-estimates/v1.json +256 -48
- package/node_modules/@salesforce/b2c-api-schemas/scapi/product/shopper-products/v1.json +1744 -306
- package/node_modules/@salesforce/b2c-api-schemas/scapi/search/shopper-search/v1.json +1661 -120
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth/v1.json +2174 -118
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/auth-admin/v1.json +1373 -24
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/consents/v1.json +531 -20
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-agents/v1.json +154 -6
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-consents/v1.json +596 -79
- package/node_modules/@salesforce/b2c-api-schemas/scapi/shopper/shopper-context/v1.json +456 -42
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/seo/v1.json +101 -23
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/shopper-seo/v1.json +184 -41
- package/node_modules/@salesforce/b2c-api-schemas/scapi/site/sites/v1.json +995 -47
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/shopper-stores/v1.json +370 -67
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/store-redirect-mappings/v1.json +319 -11
- package/node_modules/@salesforce/b2c-api-schemas/scapi/store/stores/v1.json +1109 -64
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/deployments/v1.json +1442 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/environments/v1.json +4293 -0
- package/node_modules/@salesforce/b2c-api-schemas/scapi/storefront/storefronts/v1.json +1371 -0
- package/package.json +5 -2
- package/specs/scapi-schemas-v1.yaml +4 -1
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
"openapi": "3.0.3",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Inventory Availability",
|
|
5
|
+
"description": "[Download API specification](https://developer.salesforce.com/static/commercecloud/commerce-api/inventory-availability/availability-oas-v1-public.yaml)\n\n# API Overview\n\nInventory Availability APIs enable you to get inventory availability and perform inventory updates within Omnichannel Inventory.\n\nInventory Availability API can be segregated into the following functional categories:\n\n| Category | Endpoint Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Inventory Availability | API endpoints for getting inventory SKU availability for groups and locations. You can query for multiple SKUs either by a single group or by multiple locations |\n| Inventory Updates and Deletes | API endpoints for updating and deleting inventory availability for specific SKUs. |\n| Deltas | API endpoint for reading the stream of changes that have occurred to SKUs in groups or locations. |\n\n**Note**: Omnichannel Inventory uses the Tenant Group ID in place of the Organization ID. For more information, see [Configuration Values](https://developer.salesforce.com/docs/commerce/commerce-api/guide/commerce-api-configuration-values).\n\n## Rate Limits\n\nFor load shedding and rate limiting information, see [Load Shedding and Rate Limiting.](https://developer.salesforce.com/docs/commerce/commerce-api/guide/throttle-rates.html)\n\n## Authentication and Authorization\n\nClients calling Omnichannel Inventory can be authenticated in one of two ways.\n\n- Authenticate using Account Manager with your B2C Commerce credentials.\n- Authenticate using your Salesforce org credentials.\n\nIf you are using both B2C Commerce and Salesforce Order Management, you can use either authentication approach. However, we recommend choosing only one to avoid mixing approaches across your integrations.\nThe different authentication approaches do not impact the purpose or performance of the APIs.\nEach authentication approach uses a unique set of scopes.\n\n| Scopes for Account Manager Authentication | Scopes for Salesforce org Authentication |\n| ----------------------------------------- | ---------------------------------------- |\n| sfcc.inventory.impex-graphs | sfcc_inventory_impex_graphs |\n| --- | --- |\n| sfcc.inventory.impex-inventory.rw | sfcc_inventory_impex_inventory_rw |\n| sfcc.inventory.impex-inventory | sfcc_inventory_impex_inventory |\n| sfcc.inventory.availability | sfcc_inventory_availability |\n| sfcc.inventory.availability.rw | sfcc_inventory_availability_rw |\n| sfcc.inventory.reservations | sfcc_inventory_reservations |\n| sfcc.inventory.reservations.rw | sfcc_inventory_reservations_rw |\n\nCalls through the API gateway to Omnichannel Inventory must have a valid OAUTH bearer token. The tenant identifier used by Omnichannel Inventory is supplied in the header of the token.\nAll request and response body entities are composed in JSON.\n\n## Use Cases\n\n### Inventory Availability\n\nUse these API endpoints to get inventory SKU availability for groups and locations. You can query multiple SKUs either by a single group or by multiple locations.\n\n#### Group Availability\n\nUse this endpoint to retrieve inventory availability for a group identifier and multiple SKUs with the criteria specified as parameters of the URL. A successful response contains the item availability data for the requested group and SKUs\n\n#### Location Availability\n\nUse this endpoint to retrieve inventory availability for multiple location identifiers and SKUs with the criteria specified in the body of the request. A successful response contains the item availability data for the requested locations and SKUs\n\n### Inventory Updates and Deletes\n\nUse these API endpoints to update and delete inventory availability for specific SKUs.\n\n#### Updates\n\nUse these endpoints to update inventory availability data for a single location or in a batch of locations.\n\n#### Single Location\n\nUse this endpoint to update inventory availability for a specific location identifier and SKU. The data to update is supplied in the body of the request.\n\n#### Batch of Locations\n\nUse this endpoint to update multiple locations and SKUS. The stream of item availability records is supplied in the body of the request.\n\n#### Deletes\n\nThe client calls these endpoints to delete inventory availability data. Although the current values are reset, history is maintained.\n\n#### Location\n\nUse this endpoint to delete a SKU at a location with the criteria specified as URL parameters.\n\n#### Group\n\nUse this endpoint to delete a SKU at a group with the criteria specified as URL parameters.\n\n### Deltas\n\nUse this endpoint to request inventory availability changes by providing a place identifier (for example, group or location) and a token as parameters of the URL. The response contains a stream of inventory availability data with the changes that have occurred since the token was created. Each successful response contains a _new_ token for the next delta call. There are multiple ways that you can generate a delta token. The first is through running an export process. See the Inventory Impex API for details on how to retrieve a delta token from the Inventory Export. A Delta token can also be created using the Create New Delta Token api call. See the Inventory Availability API documentation for details on that call.\n\nIt is strongly advised that when implementing the get deltas functionality, the calls for retrieving the delta information are collapsed into two streams. In the first stream, a delta token is created and then processed for all stand alone locations. In the second stream, a delta token is created and then processed for all location groups. These delta tokens are created using the Create New Delta Token API call mentioned above. You, as the caller, can then filter the results to process them and provide optimal performance when using the get deltas functionality. \n\nWhen using the two-streams method outlined above, there may be times that the location graph is changed and a new delta token is required. In these cases, use the Upadte Delta Token API call outlined in the Inventory Availability API documentation. Using this update delta token call, you can add or remove locations or groups from an existing delta token, eliminating the previous requirement to perform an export to retrieve a new delta token.\n\n### Futures\n\nBe advised that this API references Future inventory collections as `futures` and `futureStock`. These are the same thing. Also the Inventory Impex API references Future inventory collections as `futures`.\n\n### attributeSet\n\nThe attributeSet is a list of attributes that can be applied to an item to change it's behavior. An example of this is the `groupEligibilityExclusion` attribute, which allows you to apply an array of Groups that are excluded from aggregating the sku for a particular location.\n\n## Common Response Codes\n\nThe following error codes apply to all API endpoints. See the API documentation for a complete list of the error codes and response bodies that can be expected on each endpoint.\n\n- 401 - The OATH bearer token is not valid for the tenant or is no longer valid. The response body has the details.\n- 403 - The tenant is not provisioned in the system.\n- 5XX - There was a server error. The response body has the details.\n- Unknown - If an Unknown error type is returned, it indicates that an unknown internal error occurred.\n\n## External Reference Identifier\n\nCurrently, there are a number of places where a consumer can submit an `ExternalRefId` with their request. This allows the consumer to submit user generated data along with their request as a link to other external systems data. For example, if you're pulling data from an order that has an order ID, you can submit that order ID with your reservation request as the `externalRefId`. Then, if there is a problem with the reservation, there is a way to connect it with the order in the external system that generated the error or problem. This is NOT to be confused with `externalRefId` used in Salesforce Core, or any other services. The usage is exclusive to OCI and is not used anywhere else.\n\n## Correlation-ID\n\nTo facilitate operations tracking in Omnichannel Inventory, populate a header with the name Correlation-ID which will be passed through the CDN and sent with the request to OCI. This helps trace requests as they move through the service. To be accepted, Correlation-ID must be a valid UUIDv2 or it'll be ignored.\n\nWhen a web-request is passed through the CDN, the CDN's x-correlation-id header value (which comes from their ray-id) also comes into play. In this case, the correlation-id provided is prepended to the CDN's x-correlation-id and both values are passed through, separated by a comma.\n\nSome services use a header X-Correlation-ID. If this header is used with Omnichannel Inventory, it's overwritten by the CDN with a new value and the initial purpose of the header is defeated. Use the Correlation-ID instead for a consistent result.",
|
|
5
6
|
"version": "1.1.31",
|
|
6
7
|
"x-api-type": "Admin",
|
|
7
8
|
"x-api-family": "Inventory"
|
|
@@ -19,17 +20,20 @@
|
|
|
19
20
|
"paths": {
|
|
20
21
|
"/organizations/{organizationId}/availability-records/delta-token": {
|
|
21
22
|
"post": {
|
|
23
|
+
"summary": "Create a new Delta Token.",
|
|
22
24
|
"operationId": "createNewDeltaToken",
|
|
23
25
|
"parameters": [
|
|
24
26
|
{
|
|
25
27
|
"name": "organizationId",
|
|
26
28
|
"in": "path",
|
|
29
|
+
"description": "An identifier for the organization the request is being made by",
|
|
27
30
|
"required": true,
|
|
28
31
|
"style": "simple",
|
|
29
32
|
"explode": false,
|
|
30
33
|
"schema": {
|
|
31
34
|
"$ref": "#/components/schemas/OrganizationId"
|
|
32
|
-
}
|
|
35
|
+
},
|
|
36
|
+
"example": "f_ecom_zzxy_prd"
|
|
33
37
|
}
|
|
34
38
|
],
|
|
35
39
|
"requestBody": {
|
|
@@ -37,6 +41,14 @@
|
|
|
37
41
|
"application/json": {
|
|
38
42
|
"schema": {
|
|
39
43
|
"$ref": "#/components/schemas/CreateNewDeltaTokenBody"
|
|
44
|
+
},
|
|
45
|
+
"examples": {
|
|
46
|
+
"CreateDeltaTokenGroups": {
|
|
47
|
+
"$ref": "#/components/examples/CreateDeltaTokenGroups"
|
|
48
|
+
},
|
|
49
|
+
"CreateDeltaTokenLocations": {
|
|
50
|
+
"$ref": "#/components/examples/CreateDeltaTokenLocations"
|
|
51
|
+
}
|
|
40
52
|
}
|
|
41
53
|
}
|
|
42
54
|
},
|
|
@@ -47,6 +59,7 @@
|
|
|
47
59
|
"description": "New Delta Token was created successfully.",
|
|
48
60
|
"headers": {
|
|
49
61
|
"X-RateLimit-Limit": {
|
|
62
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
50
63
|
"style": "simple",
|
|
51
64
|
"explode": false,
|
|
52
65
|
"schema": {
|
|
@@ -54,6 +67,7 @@
|
|
|
54
67
|
}
|
|
55
68
|
},
|
|
56
69
|
"X-RateLimit-Remaining": {
|
|
70
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
57
71
|
"style": "simple",
|
|
58
72
|
"explode": false,
|
|
59
73
|
"schema": {
|
|
@@ -61,6 +75,7 @@
|
|
|
61
75
|
}
|
|
62
76
|
},
|
|
63
77
|
"X-RateLimit-Reset": {
|
|
78
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
64
79
|
"style": "simple",
|
|
65
80
|
"explode": false,
|
|
66
81
|
"schema": {
|
|
@@ -72,6 +87,11 @@
|
|
|
72
87
|
"application/json": {
|
|
73
88
|
"schema": {
|
|
74
89
|
"$ref": "#/components/schemas/CreateNewDeltaTokenResponse"
|
|
90
|
+
},
|
|
91
|
+
"examples": {
|
|
92
|
+
"createNewDeltaToken200": {
|
|
93
|
+
"$ref": "#/components/examples/createNewDeltaToken200"
|
|
94
|
+
}
|
|
75
95
|
}
|
|
76
96
|
}
|
|
77
97
|
}
|
|
@@ -80,6 +100,7 @@
|
|
|
80
100
|
"description": "Invalid request.",
|
|
81
101
|
"headers": {
|
|
82
102
|
"X-RateLimit-Limit": {
|
|
103
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
83
104
|
"style": "simple",
|
|
84
105
|
"explode": false,
|
|
85
106
|
"schema": {
|
|
@@ -87,6 +108,7 @@
|
|
|
87
108
|
}
|
|
88
109
|
},
|
|
89
110
|
"X-RateLimit-Remaining": {
|
|
111
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
90
112
|
"style": "simple",
|
|
91
113
|
"explode": false,
|
|
92
114
|
"schema": {
|
|
@@ -94,6 +116,7 @@
|
|
|
94
116
|
}
|
|
95
117
|
},
|
|
96
118
|
"X-RateLimit-Reset": {
|
|
119
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
97
120
|
"style": "simple",
|
|
98
121
|
"explode": false,
|
|
99
122
|
"schema": {
|
|
@@ -105,6 +128,11 @@
|
|
|
105
128
|
"application/problem+json": {
|
|
106
129
|
"schema": {
|
|
107
130
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
131
|
+
},
|
|
132
|
+
"examples": {
|
|
133
|
+
"createNewDeltaToken400": {
|
|
134
|
+
"$ref": "#/components/examples/DeltaTokenInvalidPlaces"
|
|
135
|
+
}
|
|
108
136
|
}
|
|
109
137
|
}
|
|
110
138
|
}
|
|
@@ -123,18 +151,31 @@
|
|
|
123
151
|
"content": {
|
|
124
152
|
"application/problem+json": {
|
|
125
153
|
"schema": {
|
|
154
|
+
"example": {
|
|
155
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
156
|
+
"title": "Too Many Requests",
|
|
157
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
158
|
+
},
|
|
126
159
|
"properties": {
|
|
127
160
|
"title": {
|
|
128
|
-
"type": "string"
|
|
161
|
+
"type": "string",
|
|
162
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
163
|
+
"example": "You do not have enough credit."
|
|
129
164
|
},
|
|
130
165
|
"type": {
|
|
131
|
-
"type": "string"
|
|
166
|
+
"type": "string",
|
|
167
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
168
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
132
169
|
},
|
|
133
170
|
"detail": {
|
|
134
|
-
"type": "string"
|
|
171
|
+
"type": "string",
|
|
172
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
173
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
135
174
|
},
|
|
136
175
|
"instance": {
|
|
137
|
-
"type": "string"
|
|
176
|
+
"type": "string",
|
|
177
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
178
|
+
"example": "/account/12345/msgs/abc"
|
|
138
179
|
}
|
|
139
180
|
},
|
|
140
181
|
"required": [
|
|
@@ -157,17 +198,20 @@
|
|
|
157
198
|
},
|
|
158
199
|
"/organizations/{organizationId}/availability-records/delta-token/actions/update": {
|
|
159
200
|
"post": {
|
|
201
|
+
"summary": "Update a Delta Token stream.",
|
|
160
202
|
"operationId": "updateDeltaToken",
|
|
161
203
|
"parameters": [
|
|
162
204
|
{
|
|
163
205
|
"name": "organizationId",
|
|
164
206
|
"in": "path",
|
|
207
|
+
"description": "An identifier for the organization the request is being made by",
|
|
165
208
|
"required": true,
|
|
166
209
|
"style": "simple",
|
|
167
210
|
"explode": false,
|
|
168
211
|
"schema": {
|
|
169
212
|
"$ref": "#/components/schemas/OrganizationId"
|
|
170
|
-
}
|
|
213
|
+
},
|
|
214
|
+
"example": "f_ecom_zzxy_prd"
|
|
171
215
|
}
|
|
172
216
|
],
|
|
173
217
|
"requestBody": {
|
|
@@ -175,6 +219,11 @@
|
|
|
175
219
|
"application/json": {
|
|
176
220
|
"schema": {
|
|
177
221
|
"$ref": "#/components/schemas/UpdateDeltaTokenBody"
|
|
222
|
+
},
|
|
223
|
+
"examples": {
|
|
224
|
+
"UpdateDeltaTokenGroups": {
|
|
225
|
+
"$ref": "#/components/examples/UpdateDeltaTokenGroups"
|
|
226
|
+
}
|
|
178
227
|
}
|
|
179
228
|
}
|
|
180
229
|
},
|
|
@@ -185,6 +234,7 @@
|
|
|
185
234
|
"description": "Delta Token stream updated successfully.",
|
|
186
235
|
"headers": {
|
|
187
236
|
"X-RateLimit-Limit": {
|
|
237
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
188
238
|
"style": "simple",
|
|
189
239
|
"explode": false,
|
|
190
240
|
"schema": {
|
|
@@ -192,6 +242,7 @@
|
|
|
192
242
|
}
|
|
193
243
|
},
|
|
194
244
|
"X-RateLimit-Remaining": {
|
|
245
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
195
246
|
"style": "simple",
|
|
196
247
|
"explode": false,
|
|
197
248
|
"schema": {
|
|
@@ -199,6 +250,7 @@
|
|
|
199
250
|
}
|
|
200
251
|
},
|
|
201
252
|
"X-RateLimit-Reset": {
|
|
253
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
202
254
|
"style": "simple",
|
|
203
255
|
"explode": false,
|
|
204
256
|
"schema": {
|
|
@@ -210,6 +262,11 @@
|
|
|
210
262
|
"application/json": {
|
|
211
263
|
"schema": {
|
|
212
264
|
"$ref": "#/components/schemas/UpdateDeltaTokenResponse"
|
|
265
|
+
},
|
|
266
|
+
"examples": {
|
|
267
|
+
"updateDeltaTokenSuccess": {
|
|
268
|
+
"$ref": "#/components/examples/updateDeltaTokenSuccess"
|
|
269
|
+
}
|
|
213
270
|
}
|
|
214
271
|
}
|
|
215
272
|
}
|
|
@@ -218,6 +275,7 @@
|
|
|
218
275
|
"description": "Invalid request.",
|
|
219
276
|
"headers": {
|
|
220
277
|
"X-RateLimit-Limit": {
|
|
278
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
221
279
|
"style": "simple",
|
|
222
280
|
"explode": false,
|
|
223
281
|
"schema": {
|
|
@@ -225,6 +283,7 @@
|
|
|
225
283
|
}
|
|
226
284
|
},
|
|
227
285
|
"X-RateLimit-Remaining": {
|
|
286
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
228
287
|
"style": "simple",
|
|
229
288
|
"explode": false,
|
|
230
289
|
"schema": {
|
|
@@ -232,6 +291,7 @@
|
|
|
232
291
|
}
|
|
233
292
|
},
|
|
234
293
|
"X-RateLimit-Reset": {
|
|
294
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
235
295
|
"style": "simple",
|
|
236
296
|
"explode": false,
|
|
237
297
|
"schema": {
|
|
@@ -243,6 +303,11 @@
|
|
|
243
303
|
"application/problem+json": {
|
|
244
304
|
"schema": {
|
|
245
305
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
306
|
+
},
|
|
307
|
+
"examples": {
|
|
308
|
+
"updateDeltaToken400": {
|
|
309
|
+
"$ref": "#/components/examples/DeltaToken400"
|
|
310
|
+
}
|
|
246
311
|
}
|
|
247
312
|
}
|
|
248
313
|
}
|
|
@@ -253,6 +318,11 @@
|
|
|
253
318
|
"application/problem+json": {
|
|
254
319
|
"schema": {
|
|
255
320
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
321
|
+
},
|
|
322
|
+
"examples": {
|
|
323
|
+
"updateDeltaToken403": {
|
|
324
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
325
|
+
}
|
|
256
326
|
}
|
|
257
327
|
}
|
|
258
328
|
}
|
|
@@ -261,6 +331,7 @@
|
|
|
261
331
|
"description": "Delta Token link expired.",
|
|
262
332
|
"headers": {
|
|
263
333
|
"X-RateLimit-Limit": {
|
|
334
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
264
335
|
"style": "simple",
|
|
265
336
|
"explode": false,
|
|
266
337
|
"schema": {
|
|
@@ -268,6 +339,7 @@
|
|
|
268
339
|
}
|
|
269
340
|
},
|
|
270
341
|
"X-RateLimit-Remaining": {
|
|
342
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
271
343
|
"style": "simple",
|
|
272
344
|
"explode": false,
|
|
273
345
|
"schema": {
|
|
@@ -275,6 +347,7 @@
|
|
|
275
347
|
}
|
|
276
348
|
},
|
|
277
349
|
"X-RateLimit-Reset": {
|
|
350
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
278
351
|
"style": "simple",
|
|
279
352
|
"explode": false,
|
|
280
353
|
"schema": {
|
|
@@ -286,6 +359,11 @@
|
|
|
286
359
|
"application/problem+json": {
|
|
287
360
|
"schema": {
|
|
288
361
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
362
|
+
},
|
|
363
|
+
"examples": {
|
|
364
|
+
"updateDeltaToken410": {
|
|
365
|
+
"$ref": "#/components/examples/DeltaToken410"
|
|
366
|
+
}
|
|
289
367
|
}
|
|
290
368
|
}
|
|
291
369
|
}
|
|
@@ -304,18 +382,31 @@
|
|
|
304
382
|
"content": {
|
|
305
383
|
"application/problem+json": {
|
|
306
384
|
"schema": {
|
|
385
|
+
"example": {
|
|
386
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
387
|
+
"title": "Too Many Requests",
|
|
388
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
389
|
+
},
|
|
307
390
|
"properties": {
|
|
308
391
|
"title": {
|
|
309
|
-
"type": "string"
|
|
392
|
+
"type": "string",
|
|
393
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
394
|
+
"example": "You do not have enough credit."
|
|
310
395
|
},
|
|
311
396
|
"type": {
|
|
312
|
-
"type": "string"
|
|
397
|
+
"type": "string",
|
|
398
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
399
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
313
400
|
},
|
|
314
401
|
"detail": {
|
|
315
|
-
"type": "string"
|
|
402
|
+
"type": "string",
|
|
403
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
404
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
316
405
|
},
|
|
317
406
|
"instance": {
|
|
318
|
-
"type": "string"
|
|
407
|
+
"type": "string",
|
|
408
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
409
|
+
"example": "/account/12345/msgs/abc"
|
|
319
410
|
}
|
|
320
411
|
},
|
|
321
412
|
"required": [
|
|
@@ -338,17 +429,20 @@
|
|
|
338
429
|
},
|
|
339
430
|
"/organizations/{organizationId}/availability-records/actions/batch-update": {
|
|
340
431
|
"post": {
|
|
432
|
+
"summary": "Update a batch of inventory items with one call.",
|
|
341
433
|
"operationId": "batchInventoryUpdate",
|
|
342
434
|
"parameters": [
|
|
343
435
|
{
|
|
344
436
|
"name": "organizationId",
|
|
345
437
|
"in": "path",
|
|
438
|
+
"description": "An identifier for the organization the request is being made by",
|
|
346
439
|
"required": true,
|
|
347
440
|
"style": "simple",
|
|
348
441
|
"explode": false,
|
|
349
442
|
"schema": {
|
|
350
443
|
"$ref": "#/components/schemas/OrganizationId"
|
|
351
|
-
}
|
|
444
|
+
},
|
|
445
|
+
"example": "f_ecom_zzxy_prd"
|
|
352
446
|
}
|
|
353
447
|
],
|
|
354
448
|
"requestBody": {
|
|
@@ -356,6 +450,11 @@
|
|
|
356
450
|
"application/json": {
|
|
357
451
|
"schema": {
|
|
358
452
|
"$ref": "#/components/schemas/BatchInventoryUpdateRequest"
|
|
453
|
+
},
|
|
454
|
+
"examples": {
|
|
455
|
+
"BatchUpdateOneRecord": {
|
|
456
|
+
"$ref": "#/components/examples/BatchUpdateOneRecord"
|
|
457
|
+
}
|
|
359
458
|
}
|
|
360
459
|
}
|
|
361
460
|
},
|
|
@@ -366,6 +465,7 @@
|
|
|
366
465
|
"description": "Batch inventory updated successfully.",
|
|
367
466
|
"headers": {
|
|
368
467
|
"X-RateLimit-Limit": {
|
|
468
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
369
469
|
"style": "simple",
|
|
370
470
|
"explode": false,
|
|
371
471
|
"schema": {
|
|
@@ -373,6 +473,7 @@
|
|
|
373
473
|
}
|
|
374
474
|
},
|
|
375
475
|
"X-RateLimit-Remaining": {
|
|
476
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
376
477
|
"style": "simple",
|
|
377
478
|
"explode": false,
|
|
378
479
|
"schema": {
|
|
@@ -380,6 +481,7 @@
|
|
|
380
481
|
}
|
|
381
482
|
},
|
|
382
483
|
"X-RateLimit-Reset": {
|
|
484
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
383
485
|
"style": "simple",
|
|
384
486
|
"explode": false,
|
|
385
487
|
"schema": {
|
|
@@ -391,6 +493,11 @@
|
|
|
391
493
|
"application/json": {
|
|
392
494
|
"schema": {
|
|
393
495
|
"$ref": "#/components/schemas/BatchInventoryUpdateErrors"
|
|
496
|
+
},
|
|
497
|
+
"examples": {
|
|
498
|
+
"batchInventoryUpdate200": {
|
|
499
|
+
"$ref": "#/components/examples/BatchInventoryUpdate200"
|
|
500
|
+
}
|
|
394
501
|
}
|
|
395
502
|
}
|
|
396
503
|
}
|
|
@@ -399,6 +506,7 @@
|
|
|
399
506
|
"description": "Batch inventory updated successfully.",
|
|
400
507
|
"headers": {
|
|
401
508
|
"X-RateLimit-Limit": {
|
|
509
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
402
510
|
"style": "simple",
|
|
403
511
|
"explode": false,
|
|
404
512
|
"schema": {
|
|
@@ -406,6 +514,7 @@
|
|
|
406
514
|
}
|
|
407
515
|
},
|
|
408
516
|
"X-RateLimit-Remaining": {
|
|
517
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
409
518
|
"style": "simple",
|
|
410
519
|
"explode": false,
|
|
411
520
|
"schema": {
|
|
@@ -413,6 +522,7 @@
|
|
|
413
522
|
}
|
|
414
523
|
},
|
|
415
524
|
"X-RateLimit-Reset": {
|
|
525
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
416
526
|
"style": "simple",
|
|
417
527
|
"explode": false,
|
|
418
528
|
"schema": {
|
|
@@ -425,6 +535,7 @@
|
|
|
425
535
|
"description": "Invalid request.",
|
|
426
536
|
"headers": {
|
|
427
537
|
"X-RateLimit-Limit": {
|
|
538
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
428
539
|
"style": "simple",
|
|
429
540
|
"explode": false,
|
|
430
541
|
"schema": {
|
|
@@ -432,6 +543,7 @@
|
|
|
432
543
|
}
|
|
433
544
|
},
|
|
434
545
|
"X-RateLimit-Remaining": {
|
|
546
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
435
547
|
"style": "simple",
|
|
436
548
|
"explode": false,
|
|
437
549
|
"schema": {
|
|
@@ -439,6 +551,7 @@
|
|
|
439
551
|
}
|
|
440
552
|
},
|
|
441
553
|
"X-RateLimit-Reset": {
|
|
554
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
442
555
|
"style": "simple",
|
|
443
556
|
"explode": false,
|
|
444
557
|
"schema": {
|
|
@@ -450,6 +563,11 @@
|
|
|
450
563
|
"application/problem+json": {
|
|
451
564
|
"schema": {
|
|
452
565
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
566
|
+
},
|
|
567
|
+
"examples": {
|
|
568
|
+
"batchInventoryUpdate400": {
|
|
569
|
+
"$ref": "#/components/examples/InvalidCharacterSku"
|
|
570
|
+
}
|
|
453
571
|
}
|
|
454
572
|
}
|
|
455
573
|
}
|
|
@@ -460,6 +578,11 @@
|
|
|
460
578
|
"application/problem+json": {
|
|
461
579
|
"schema": {
|
|
462
580
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
581
|
+
},
|
|
582
|
+
"examples": {
|
|
583
|
+
"batchInventoryUpdate403": {
|
|
584
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
585
|
+
}
|
|
463
586
|
}
|
|
464
587
|
}
|
|
465
588
|
}
|
|
@@ -478,18 +601,31 @@
|
|
|
478
601
|
"content": {
|
|
479
602
|
"application/problem+json": {
|
|
480
603
|
"schema": {
|
|
604
|
+
"example": {
|
|
605
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
606
|
+
"title": "Too Many Requests",
|
|
607
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
608
|
+
},
|
|
481
609
|
"properties": {
|
|
482
610
|
"title": {
|
|
483
|
-
"type": "string"
|
|
611
|
+
"type": "string",
|
|
612
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
613
|
+
"example": "You do not have enough credit."
|
|
484
614
|
},
|
|
485
615
|
"type": {
|
|
486
|
-
"type": "string"
|
|
616
|
+
"type": "string",
|
|
617
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
618
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
487
619
|
},
|
|
488
620
|
"detail": {
|
|
489
|
-
"type": "string"
|
|
621
|
+
"type": "string",
|
|
622
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
623
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
490
624
|
},
|
|
491
625
|
"instance": {
|
|
492
|
-
"type": "string"
|
|
626
|
+
"type": "string",
|
|
627
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
628
|
+
"example": "/account/12345/msgs/abc"
|
|
493
629
|
}
|
|
494
630
|
},
|
|
495
631
|
"required": [
|
|
@@ -510,17 +646,20 @@
|
|
|
510
646
|
]
|
|
511
647
|
},
|
|
512
648
|
"patch": {
|
|
649
|
+
"summary": "Partially update a batch of inventory items with one call. Only fields that are included in the request will be updated.",
|
|
513
650
|
"operationId": "batchInventoryPatch",
|
|
514
651
|
"parameters": [
|
|
515
652
|
{
|
|
516
653
|
"name": "organizationId",
|
|
517
654
|
"in": "path",
|
|
655
|
+
"description": "An identifier for the organization the request is being made by",
|
|
518
656
|
"required": true,
|
|
519
657
|
"style": "simple",
|
|
520
658
|
"explode": false,
|
|
521
659
|
"schema": {
|
|
522
660
|
"$ref": "#/components/schemas/OrganizationId"
|
|
523
|
-
}
|
|
661
|
+
},
|
|
662
|
+
"example": "f_ecom_zzxy_prd"
|
|
524
663
|
}
|
|
525
664
|
],
|
|
526
665
|
"requestBody": {
|
|
@@ -528,6 +667,11 @@
|
|
|
528
667
|
"application/json": {
|
|
529
668
|
"schema": {
|
|
530
669
|
"$ref": "#/components/schemas/BatchInventoryUpdateRequest"
|
|
670
|
+
},
|
|
671
|
+
"examples": {
|
|
672
|
+
"BatchInventoryPatchRequest": {
|
|
673
|
+
"$ref": "#/components/examples/BatchInventoryPatchRequest"
|
|
674
|
+
}
|
|
531
675
|
}
|
|
532
676
|
}
|
|
533
677
|
},
|
|
@@ -538,6 +682,7 @@
|
|
|
538
682
|
"description": "Batch inventory partially updated with potentially some errors reported.",
|
|
539
683
|
"headers": {
|
|
540
684
|
"X-RateLimit-Limit": {
|
|
685
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
541
686
|
"style": "simple",
|
|
542
687
|
"explode": false,
|
|
543
688
|
"schema": {
|
|
@@ -545,6 +690,7 @@
|
|
|
545
690
|
}
|
|
546
691
|
},
|
|
547
692
|
"X-RateLimit-Remaining": {
|
|
693
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
548
694
|
"style": "simple",
|
|
549
695
|
"explode": false,
|
|
550
696
|
"schema": {
|
|
@@ -552,6 +698,7 @@
|
|
|
552
698
|
}
|
|
553
699
|
},
|
|
554
700
|
"X-RateLimit-Reset": {
|
|
701
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
555
702
|
"style": "simple",
|
|
556
703
|
"explode": false,
|
|
557
704
|
"schema": {
|
|
@@ -563,6 +710,11 @@
|
|
|
563
710
|
"application/json": {
|
|
564
711
|
"schema": {
|
|
565
712
|
"$ref": "#/components/schemas/BatchInventoryUpdateErrors"
|
|
713
|
+
},
|
|
714
|
+
"examples": {
|
|
715
|
+
"batchInventoryPatch200": {
|
|
716
|
+
"$ref": "#/components/examples/BatchInventoryPatch200"
|
|
717
|
+
}
|
|
566
718
|
}
|
|
567
719
|
}
|
|
568
720
|
}
|
|
@@ -571,6 +723,7 @@
|
|
|
571
723
|
"description": "All batch inventory items updated successfully.",
|
|
572
724
|
"headers": {
|
|
573
725
|
"X-RateLimit-Limit": {
|
|
726
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
574
727
|
"style": "simple",
|
|
575
728
|
"explode": false,
|
|
576
729
|
"schema": {
|
|
@@ -578,6 +731,7 @@
|
|
|
578
731
|
}
|
|
579
732
|
},
|
|
580
733
|
"X-RateLimit-Remaining": {
|
|
734
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
581
735
|
"style": "simple",
|
|
582
736
|
"explode": false,
|
|
583
737
|
"schema": {
|
|
@@ -585,6 +739,7 @@
|
|
|
585
739
|
}
|
|
586
740
|
},
|
|
587
741
|
"X-RateLimit-Reset": {
|
|
742
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
588
743
|
"style": "simple",
|
|
589
744
|
"explode": false,
|
|
590
745
|
"schema": {
|
|
@@ -597,6 +752,7 @@
|
|
|
597
752
|
"description": "Invalid request.",
|
|
598
753
|
"headers": {
|
|
599
754
|
"X-RateLimit-Limit": {
|
|
755
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
600
756
|
"style": "simple",
|
|
601
757
|
"explode": false,
|
|
602
758
|
"schema": {
|
|
@@ -604,6 +760,7 @@
|
|
|
604
760
|
}
|
|
605
761
|
},
|
|
606
762
|
"X-RateLimit-Remaining": {
|
|
763
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
607
764
|
"style": "simple",
|
|
608
765
|
"explode": false,
|
|
609
766
|
"schema": {
|
|
@@ -611,6 +768,7 @@
|
|
|
611
768
|
}
|
|
612
769
|
},
|
|
613
770
|
"X-RateLimit-Reset": {
|
|
771
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
614
772
|
"style": "simple",
|
|
615
773
|
"explode": false,
|
|
616
774
|
"schema": {
|
|
@@ -622,6 +780,11 @@
|
|
|
622
780
|
"application/problem+json": {
|
|
623
781
|
"schema": {
|
|
624
782
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
783
|
+
},
|
|
784
|
+
"examples": {
|
|
785
|
+
"batchInventoryPatch400": {
|
|
786
|
+
"$ref": "#/components/examples/BatchInventoryPatch400"
|
|
787
|
+
}
|
|
625
788
|
}
|
|
626
789
|
}
|
|
627
790
|
}
|
|
@@ -632,6 +795,11 @@
|
|
|
632
795
|
"application/problem+json": {
|
|
633
796
|
"schema": {
|
|
634
797
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
798
|
+
},
|
|
799
|
+
"examples": {
|
|
800
|
+
"batchInventoryPatch403": {
|
|
801
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
802
|
+
}
|
|
635
803
|
}
|
|
636
804
|
}
|
|
637
805
|
}
|
|
@@ -650,18 +818,31 @@
|
|
|
650
818
|
"content": {
|
|
651
819
|
"application/problem+json": {
|
|
652
820
|
"schema": {
|
|
821
|
+
"example": {
|
|
822
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
823
|
+
"title": "Too Many Requests",
|
|
824
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
825
|
+
},
|
|
653
826
|
"properties": {
|
|
654
827
|
"title": {
|
|
655
|
-
"type": "string"
|
|
828
|
+
"type": "string",
|
|
829
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
830
|
+
"example": "You do not have enough credit."
|
|
656
831
|
},
|
|
657
832
|
"type": {
|
|
658
|
-
"type": "string"
|
|
833
|
+
"type": "string",
|
|
834
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
835
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
659
836
|
},
|
|
660
837
|
"detail": {
|
|
661
|
-
"type": "string"
|
|
838
|
+
"type": "string",
|
|
839
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
840
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
662
841
|
},
|
|
663
842
|
"instance": {
|
|
664
|
-
"type": "string"
|
|
843
|
+
"type": "string",
|
|
844
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
845
|
+
"example": "/account/12345/msgs/abc"
|
|
665
846
|
}
|
|
666
847
|
},
|
|
667
848
|
"required": [
|
|
@@ -684,17 +865,20 @@
|
|
|
684
865
|
},
|
|
685
866
|
"/organizations/{organizationId}/availability-records/actions/get-deltas": {
|
|
686
867
|
"post": {
|
|
868
|
+
"summary": "Retrieve changes that have occurred since a given Delta Token. An initial Delta Token is obtained from an export call; subsequent Delta Tokens are returned from this call.",
|
|
687
869
|
"operationId": "getAvailabilityDeltas",
|
|
688
870
|
"parameters": [
|
|
689
871
|
{
|
|
690
872
|
"name": "organizationId",
|
|
691
873
|
"in": "path",
|
|
874
|
+
"description": "An identifier for the organization the request is being made by",
|
|
692
875
|
"required": true,
|
|
693
876
|
"style": "simple",
|
|
694
877
|
"explode": false,
|
|
695
878
|
"schema": {
|
|
696
879
|
"$ref": "#/components/schemas/OrganizationId"
|
|
697
|
-
}
|
|
880
|
+
},
|
|
881
|
+
"example": "f_ecom_zzxy_prd"
|
|
698
882
|
}
|
|
699
883
|
],
|
|
700
884
|
"requestBody": {
|
|
@@ -702,6 +886,11 @@
|
|
|
702
886
|
"application/json": {
|
|
703
887
|
"schema": {
|
|
704
888
|
"$ref": "#/components/schemas/GetAvailabilityDeltasPostBody"
|
|
889
|
+
},
|
|
890
|
+
"examples": {
|
|
891
|
+
"getAvailabilityDeltaRequest": {
|
|
892
|
+
"$ref": "#/components/examples/getAvailabilityDeltaRequest"
|
|
893
|
+
}
|
|
705
894
|
}
|
|
706
895
|
}
|
|
707
896
|
},
|
|
@@ -712,6 +901,7 @@
|
|
|
712
901
|
"description": "Changes are returned in the body with a new Delta Token to use for the next call.",
|
|
713
902
|
"headers": {
|
|
714
903
|
"X-RateLimit-Limit": {
|
|
904
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
715
905
|
"style": "simple",
|
|
716
906
|
"explode": false,
|
|
717
907
|
"schema": {
|
|
@@ -719,6 +909,7 @@
|
|
|
719
909
|
}
|
|
720
910
|
},
|
|
721
911
|
"X-RateLimit-Remaining": {
|
|
912
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
722
913
|
"style": "simple",
|
|
723
914
|
"explode": false,
|
|
724
915
|
"schema": {
|
|
@@ -726,6 +917,7 @@
|
|
|
726
917
|
}
|
|
727
918
|
},
|
|
728
919
|
"X-RateLimit-Reset": {
|
|
920
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
729
921
|
"style": "simple",
|
|
730
922
|
"explode": false,
|
|
731
923
|
"schema": {
|
|
@@ -737,6 +929,11 @@
|
|
|
737
929
|
"application/json": {
|
|
738
930
|
"schema": {
|
|
739
931
|
"$ref": "#/components/schemas/GetAvailabilityDeltasResponse200"
|
|
932
|
+
},
|
|
933
|
+
"examples": {
|
|
934
|
+
"getAvailabilityDeltas200": {
|
|
935
|
+
"$ref": "#/components/examples/getAvailabilityDeltas200"
|
|
936
|
+
}
|
|
740
937
|
}
|
|
741
938
|
}
|
|
742
939
|
}
|
|
@@ -745,6 +942,7 @@
|
|
|
745
942
|
"description": "Invalid request.",
|
|
746
943
|
"headers": {
|
|
747
944
|
"X-RateLimit-Limit": {
|
|
945
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
748
946
|
"style": "simple",
|
|
749
947
|
"explode": false,
|
|
750
948
|
"schema": {
|
|
@@ -752,6 +950,7 @@
|
|
|
752
950
|
}
|
|
753
951
|
},
|
|
754
952
|
"X-RateLimit-Remaining": {
|
|
953
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
755
954
|
"style": "simple",
|
|
756
955
|
"explode": false,
|
|
757
956
|
"schema": {
|
|
@@ -759,6 +958,7 @@
|
|
|
759
958
|
}
|
|
760
959
|
},
|
|
761
960
|
"X-RateLimit-Reset": {
|
|
961
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
762
962
|
"style": "simple",
|
|
763
963
|
"explode": false,
|
|
764
964
|
"schema": {
|
|
@@ -770,6 +970,11 @@
|
|
|
770
970
|
"application/problem+json": {
|
|
771
971
|
"schema": {
|
|
772
972
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
973
|
+
},
|
|
974
|
+
"examples": {
|
|
975
|
+
"getAvailabilityDeltas400": {
|
|
976
|
+
"$ref": "#/components/examples/GetAvailabilityDeltas400"
|
|
977
|
+
}
|
|
773
978
|
}
|
|
774
979
|
}
|
|
775
980
|
}
|
|
@@ -780,6 +985,11 @@
|
|
|
780
985
|
"application/problem+json": {
|
|
781
986
|
"schema": {
|
|
782
987
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
988
|
+
},
|
|
989
|
+
"examples": {
|
|
990
|
+
"getAvailabilityDeltas403": {
|
|
991
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
992
|
+
}
|
|
783
993
|
}
|
|
784
994
|
}
|
|
785
995
|
}
|
|
@@ -788,6 +998,7 @@
|
|
|
788
998
|
"description": "Delta Token link expired.",
|
|
789
999
|
"headers": {
|
|
790
1000
|
"X-RateLimit-Limit": {
|
|
1001
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
791
1002
|
"style": "simple",
|
|
792
1003
|
"explode": false,
|
|
793
1004
|
"schema": {
|
|
@@ -795,6 +1006,7 @@
|
|
|
795
1006
|
}
|
|
796
1007
|
},
|
|
797
1008
|
"X-RateLimit-Remaining": {
|
|
1009
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
798
1010
|
"style": "simple",
|
|
799
1011
|
"explode": false,
|
|
800
1012
|
"schema": {
|
|
@@ -802,6 +1014,7 @@
|
|
|
802
1014
|
}
|
|
803
1015
|
},
|
|
804
1016
|
"X-RateLimit-Reset": {
|
|
1017
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
805
1018
|
"style": "simple",
|
|
806
1019
|
"explode": false,
|
|
807
1020
|
"schema": {
|
|
@@ -813,6 +1026,11 @@
|
|
|
813
1026
|
"application/problem+json": {
|
|
814
1027
|
"schema": {
|
|
815
1028
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1029
|
+
},
|
|
1030
|
+
"examples": {
|
|
1031
|
+
"getAvailabilityDeltas410": {
|
|
1032
|
+
"$ref": "#/components/examples/GetAvailabilityDeltas410"
|
|
1033
|
+
}
|
|
816
1034
|
}
|
|
817
1035
|
}
|
|
818
1036
|
}
|
|
@@ -831,18 +1049,31 @@
|
|
|
831
1049
|
"content": {
|
|
832
1050
|
"application/problem+json": {
|
|
833
1051
|
"schema": {
|
|
1052
|
+
"example": {
|
|
1053
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
1054
|
+
"title": "Too Many Requests",
|
|
1055
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
1056
|
+
},
|
|
834
1057
|
"properties": {
|
|
835
1058
|
"title": {
|
|
836
|
-
"type": "string"
|
|
1059
|
+
"type": "string",
|
|
1060
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
1061
|
+
"example": "You do not have enough credit."
|
|
837
1062
|
},
|
|
838
1063
|
"type": {
|
|
839
|
-
"type": "string"
|
|
1064
|
+
"type": "string",
|
|
1065
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1066
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
840
1067
|
},
|
|
841
1068
|
"detail": {
|
|
842
|
-
"type": "string"
|
|
1069
|
+
"type": "string",
|
|
1070
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
1071
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
843
1072
|
},
|
|
844
1073
|
"instance": {
|
|
845
|
-
"type": "string"
|
|
1074
|
+
"type": "string",
|
|
1075
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1076
|
+
"example": "/account/12345/msgs/abc"
|
|
846
1077
|
}
|
|
847
1078
|
},
|
|
848
1079
|
"required": [
|
|
@@ -865,17 +1096,20 @@
|
|
|
865
1096
|
},
|
|
866
1097
|
"/organizations/{organizationId}/availability-records/actions/get-availability": {
|
|
867
1098
|
"post": {
|
|
1099
|
+
"summary": "Get SKU availability by location, by group, or by both.",
|
|
868
1100
|
"operationId": "skuAvailabilityByLocationAndOrGroup",
|
|
869
1101
|
"parameters": [
|
|
870
1102
|
{
|
|
871
1103
|
"name": "organizationId",
|
|
872
1104
|
"in": "path",
|
|
1105
|
+
"description": "An identifier for the organization the request is being made by",
|
|
873
1106
|
"required": true,
|
|
874
1107
|
"style": "simple",
|
|
875
1108
|
"explode": false,
|
|
876
1109
|
"schema": {
|
|
877
1110
|
"$ref": "#/components/schemas/OrganizationId"
|
|
878
|
-
}
|
|
1111
|
+
},
|
|
1112
|
+
"example": "f_ecom_zzxy_prd"
|
|
879
1113
|
}
|
|
880
1114
|
],
|
|
881
1115
|
"requestBody": {
|
|
@@ -883,6 +1117,17 @@
|
|
|
883
1117
|
"application/json": {
|
|
884
1118
|
"schema": {
|
|
885
1119
|
"$ref": "#/components/schemas/InventoryAvailabilityRequestBody"
|
|
1120
|
+
},
|
|
1121
|
+
"examples": {
|
|
1122
|
+
"GetATSAllLocations": {
|
|
1123
|
+
"$ref": "#/components/examples/GetATSAllLocations"
|
|
1124
|
+
},
|
|
1125
|
+
"GetATSAllUnassignedLocations": {
|
|
1126
|
+
"$ref": "#/components/examples/GetATSAllUnassignedLocations"
|
|
1127
|
+
},
|
|
1128
|
+
"GetATSLocationsAndGroups": {
|
|
1129
|
+
"$ref": "#/components/examples/GetATSLocationsAndGroups"
|
|
1130
|
+
}
|
|
886
1131
|
}
|
|
887
1132
|
}
|
|
888
1133
|
},
|
|
@@ -893,6 +1138,7 @@
|
|
|
893
1138
|
"description": "Availability information successfully returned.",
|
|
894
1139
|
"headers": {
|
|
895
1140
|
"X-RateLimit-Limit": {
|
|
1141
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
896
1142
|
"style": "simple",
|
|
897
1143
|
"explode": false,
|
|
898
1144
|
"schema": {
|
|
@@ -900,6 +1146,7 @@
|
|
|
900
1146
|
}
|
|
901
1147
|
},
|
|
902
1148
|
"X-RateLimit-Remaining": {
|
|
1149
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
903
1150
|
"style": "simple",
|
|
904
1151
|
"explode": false,
|
|
905
1152
|
"schema": {
|
|
@@ -907,6 +1154,7 @@
|
|
|
907
1154
|
}
|
|
908
1155
|
},
|
|
909
1156
|
"X-RateLimit-Reset": {
|
|
1157
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
910
1158
|
"style": "simple",
|
|
911
1159
|
"explode": false,
|
|
912
1160
|
"schema": {
|
|
@@ -918,6 +1166,17 @@
|
|
|
918
1166
|
"application/json": {
|
|
919
1167
|
"schema": {
|
|
920
1168
|
"$ref": "#/components/schemas/Response200"
|
|
1169
|
+
},
|
|
1170
|
+
"examples": {
|
|
1171
|
+
"GetAllLocationsAndGroupsResponse": {
|
|
1172
|
+
"$ref": "#/components/examples/GetAllLocationsAndGroupsResponse"
|
|
1173
|
+
},
|
|
1174
|
+
"GetAllLocationsResponse": {
|
|
1175
|
+
"$ref": "#/components/examples/GetAllLocationsResponse"
|
|
1176
|
+
},
|
|
1177
|
+
"GetAllUnassignedLocationsResponse": {
|
|
1178
|
+
"$ref": "#/components/examples/GetAllUnassignedLocationsResponse"
|
|
1179
|
+
}
|
|
921
1180
|
}
|
|
922
1181
|
}
|
|
923
1182
|
}
|
|
@@ -926,6 +1185,7 @@
|
|
|
926
1185
|
"description": "Invalid request.",
|
|
927
1186
|
"headers": {
|
|
928
1187
|
"X-RateLimit-Limit": {
|
|
1188
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
929
1189
|
"style": "simple",
|
|
930
1190
|
"explode": false,
|
|
931
1191
|
"schema": {
|
|
@@ -933,6 +1193,7 @@
|
|
|
933
1193
|
}
|
|
934
1194
|
},
|
|
935
1195
|
"X-RateLimit-Remaining": {
|
|
1196
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
936
1197
|
"style": "simple",
|
|
937
1198
|
"explode": false,
|
|
938
1199
|
"schema": {
|
|
@@ -940,6 +1201,7 @@
|
|
|
940
1201
|
}
|
|
941
1202
|
},
|
|
942
1203
|
"X-RateLimit-Reset": {
|
|
1204
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
943
1205
|
"style": "simple",
|
|
944
1206
|
"explode": false,
|
|
945
1207
|
"schema": {
|
|
@@ -951,6 +1213,11 @@
|
|
|
951
1213
|
"application/problem+json": {
|
|
952
1214
|
"schema": {
|
|
953
1215
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1216
|
+
},
|
|
1217
|
+
"examples": {
|
|
1218
|
+
"skuAvailabilityByLocationAndOrGroup400": {
|
|
1219
|
+
"$ref": "#/components/examples/SkuAvailabilityByLocationAndOrGroup400"
|
|
1220
|
+
}
|
|
954
1221
|
}
|
|
955
1222
|
}
|
|
956
1223
|
}
|
|
@@ -961,6 +1228,11 @@
|
|
|
961
1228
|
"application/problem+json": {
|
|
962
1229
|
"schema": {
|
|
963
1230
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1231
|
+
},
|
|
1232
|
+
"examples": {
|
|
1233
|
+
"skuAvailabilityByLocationAndOrGroup403": {
|
|
1234
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
1235
|
+
}
|
|
964
1236
|
}
|
|
965
1237
|
}
|
|
966
1238
|
}
|
|
@@ -979,18 +1251,31 @@
|
|
|
979
1251
|
"content": {
|
|
980
1252
|
"application/problem+json": {
|
|
981
1253
|
"schema": {
|
|
1254
|
+
"example": {
|
|
1255
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
1256
|
+
"title": "Too Many Requests",
|
|
1257
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
1258
|
+
},
|
|
982
1259
|
"properties": {
|
|
983
1260
|
"title": {
|
|
984
|
-
"type": "string"
|
|
1261
|
+
"type": "string",
|
|
1262
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
1263
|
+
"example": "You do not have enough credit."
|
|
985
1264
|
},
|
|
986
1265
|
"type": {
|
|
987
|
-
"type": "string"
|
|
1266
|
+
"type": "string",
|
|
1267
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1268
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
988
1269
|
},
|
|
989
1270
|
"detail": {
|
|
990
|
-
"type": "string"
|
|
1271
|
+
"type": "string",
|
|
1272
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
1273
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
991
1274
|
},
|
|
992
1275
|
"instance": {
|
|
993
|
-
"type": "string"
|
|
1276
|
+
"type": "string",
|
|
1277
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1278
|
+
"example": "/account/12345/msgs/abc"
|
|
994
1279
|
}
|
|
995
1280
|
},
|
|
996
1281
|
"required": [
|
|
@@ -1013,17 +1298,20 @@
|
|
|
1013
1298
|
},
|
|
1014
1299
|
"/organizations/{organizationId}/product-segmentation/actions/batch-update": {
|
|
1015
1300
|
"post": {
|
|
1301
|
+
"summary": "Submit batches of Product Eligibility Segmentations. The body permits requests to append or delete segmentations. For more information on Product Eligibility, see Product Eligibility Segmentation Import in the OCI Impex API.",
|
|
1016
1302
|
"operationId": "batchProductSegmentationRequest",
|
|
1017
1303
|
"parameters": [
|
|
1018
1304
|
{
|
|
1019
1305
|
"name": "organizationId",
|
|
1020
1306
|
"in": "path",
|
|
1307
|
+
"description": "An identifier for the organization the request is being made by",
|
|
1021
1308
|
"required": true,
|
|
1022
1309
|
"style": "simple",
|
|
1023
1310
|
"explode": false,
|
|
1024
1311
|
"schema": {
|
|
1025
1312
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1026
|
-
}
|
|
1313
|
+
},
|
|
1314
|
+
"example": "f_ecom_zzxy_prd"
|
|
1027
1315
|
}
|
|
1028
1316
|
],
|
|
1029
1317
|
"requestBody": {
|
|
@@ -1038,6 +1326,14 @@
|
|
|
1038
1326
|
"$ref": "#/components/schemas/ProductSegmentationDeleteRequestBody"
|
|
1039
1327
|
}
|
|
1040
1328
|
]
|
|
1329
|
+
},
|
|
1330
|
+
"examples": {
|
|
1331
|
+
"ProductSegmentationAppendRequest": {
|
|
1332
|
+
"$ref": "#/components/examples/ProductSegmentationAppendRequest"
|
|
1333
|
+
},
|
|
1334
|
+
"ProductSegmentationDeleteRequest": {
|
|
1335
|
+
"$ref": "#/components/examples/ProductSegmentationDeleteRequest"
|
|
1336
|
+
}
|
|
1041
1337
|
}
|
|
1042
1338
|
}
|
|
1043
1339
|
},
|
|
@@ -1048,6 +1344,7 @@
|
|
|
1048
1344
|
"description": "Some product segmentations could not be fully processed.",
|
|
1049
1345
|
"headers": {
|
|
1050
1346
|
"X-RateLimit-Limit": {
|
|
1347
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1051
1348
|
"style": "simple",
|
|
1052
1349
|
"explode": false,
|
|
1053
1350
|
"schema": {
|
|
@@ -1055,6 +1352,7 @@
|
|
|
1055
1352
|
}
|
|
1056
1353
|
},
|
|
1057
1354
|
"X-RateLimit-Remaining": {
|
|
1355
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1058
1356
|
"style": "simple",
|
|
1059
1357
|
"explode": false,
|
|
1060
1358
|
"schema": {
|
|
@@ -1062,6 +1360,7 @@
|
|
|
1062
1360
|
}
|
|
1063
1361
|
},
|
|
1064
1362
|
"X-RateLimit-Reset": {
|
|
1363
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1065
1364
|
"style": "simple",
|
|
1066
1365
|
"explode": false,
|
|
1067
1366
|
"schema": {
|
|
@@ -1073,6 +1372,14 @@
|
|
|
1073
1372
|
"application/json": {
|
|
1074
1373
|
"schema": {
|
|
1075
1374
|
"$ref": "#/components/schemas/Errors"
|
|
1375
|
+
},
|
|
1376
|
+
"examples": {
|
|
1377
|
+
"DeleteError": {
|
|
1378
|
+
"$ref": "#/components/examples/DeleteError"
|
|
1379
|
+
},
|
|
1380
|
+
"AppendError": {
|
|
1381
|
+
"$ref": "#/components/examples/AppendError"
|
|
1382
|
+
}
|
|
1076
1383
|
}
|
|
1077
1384
|
}
|
|
1078
1385
|
}
|
|
@@ -1081,6 +1388,7 @@
|
|
|
1081
1388
|
"description": "Successfully processed all product segmentations.",
|
|
1082
1389
|
"headers": {
|
|
1083
1390
|
"X-RateLimit-Limit": {
|
|
1391
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1084
1392
|
"style": "simple",
|
|
1085
1393
|
"explode": false,
|
|
1086
1394
|
"schema": {
|
|
@@ -1088,6 +1396,7 @@
|
|
|
1088
1396
|
}
|
|
1089
1397
|
},
|
|
1090
1398
|
"X-RateLimit-Remaining": {
|
|
1399
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1091
1400
|
"style": "simple",
|
|
1092
1401
|
"explode": false,
|
|
1093
1402
|
"schema": {
|
|
@@ -1095,6 +1404,7 @@
|
|
|
1095
1404
|
}
|
|
1096
1405
|
},
|
|
1097
1406
|
"X-RateLimit-Reset": {
|
|
1407
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1098
1408
|
"style": "simple",
|
|
1099
1409
|
"explode": false,
|
|
1100
1410
|
"schema": {
|
|
@@ -1107,6 +1417,7 @@
|
|
|
1107
1417
|
"description": "Invalid request.",
|
|
1108
1418
|
"headers": {
|
|
1109
1419
|
"X-RateLimit-Limit": {
|
|
1420
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1110
1421
|
"style": "simple",
|
|
1111
1422
|
"explode": false,
|
|
1112
1423
|
"schema": {
|
|
@@ -1114,6 +1425,7 @@
|
|
|
1114
1425
|
}
|
|
1115
1426
|
},
|
|
1116
1427
|
"X-RateLimit-Remaining": {
|
|
1428
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1117
1429
|
"style": "simple",
|
|
1118
1430
|
"explode": false,
|
|
1119
1431
|
"schema": {
|
|
@@ -1121,6 +1433,7 @@
|
|
|
1121
1433
|
}
|
|
1122
1434
|
},
|
|
1123
1435
|
"X-RateLimit-Reset": {
|
|
1436
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1124
1437
|
"style": "simple",
|
|
1125
1438
|
"explode": false,
|
|
1126
1439
|
"schema": {
|
|
@@ -1132,6 +1445,11 @@
|
|
|
1132
1445
|
"application/problem+json": {
|
|
1133
1446
|
"schema": {
|
|
1134
1447
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1448
|
+
},
|
|
1449
|
+
"examples": {
|
|
1450
|
+
"ErrorInvalidRequestParameterMode": {
|
|
1451
|
+
"$ref": "#/components/examples/ErrorInvalidRequestParameterMode"
|
|
1452
|
+
}
|
|
1135
1453
|
}
|
|
1136
1454
|
}
|
|
1137
1455
|
}
|
|
@@ -1150,18 +1468,31 @@
|
|
|
1150
1468
|
"content": {
|
|
1151
1469
|
"application/problem+json": {
|
|
1152
1470
|
"schema": {
|
|
1471
|
+
"example": {
|
|
1472
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
1473
|
+
"title": "Too Many Requests",
|
|
1474
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
1475
|
+
},
|
|
1153
1476
|
"properties": {
|
|
1154
1477
|
"title": {
|
|
1155
|
-
"type": "string"
|
|
1478
|
+
"type": "string",
|
|
1479
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
1480
|
+
"example": "You do not have enough credit."
|
|
1156
1481
|
},
|
|
1157
1482
|
"type": {
|
|
1158
|
-
"type": "string"
|
|
1483
|
+
"type": "string",
|
|
1484
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1485
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
1159
1486
|
},
|
|
1160
1487
|
"detail": {
|
|
1161
|
-
"type": "string"
|
|
1488
|
+
"type": "string",
|
|
1489
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
1490
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
1162
1491
|
},
|
|
1163
1492
|
"instance": {
|
|
1164
|
-
"type": "string"
|
|
1493
|
+
"type": "string",
|
|
1494
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1495
|
+
"example": "/account/12345/msgs/abc"
|
|
1165
1496
|
}
|
|
1166
1497
|
},
|
|
1167
1498
|
"required": [
|
|
@@ -1184,11 +1515,13 @@
|
|
|
1184
1515
|
},
|
|
1185
1516
|
"/organizations/{organizationId}/locations/{locationId}/availability-records/skus/{sku}/{requestId}": {
|
|
1186
1517
|
"put": {
|
|
1518
|
+
"summary": "Update or create data and quantity information for an item. The PUT call for updating replaces all fields of data. For fields that are not included, the data that currently exists is deleted and everything defaults to 0 (zero).",
|
|
1187
1519
|
"operationId": "replaceSkuLocation",
|
|
1188
1520
|
"parameters": [
|
|
1189
1521
|
{
|
|
1190
1522
|
"name": "locationId",
|
|
1191
1523
|
"in": "path",
|
|
1524
|
+
"description": "The location for the SKU being updated.",
|
|
1192
1525
|
"required": true,
|
|
1193
1526
|
"style": "simple",
|
|
1194
1527
|
"explode": false,
|
|
@@ -1199,6 +1532,7 @@
|
|
|
1199
1532
|
{
|
|
1200
1533
|
"name": "sku",
|
|
1201
1534
|
"in": "path",
|
|
1535
|
+
"description": "The SKU associated with the inventory record you want to update.",
|
|
1202
1536
|
"required": true,
|
|
1203
1537
|
"style": "simple",
|
|
1204
1538
|
"explode": false,
|
|
@@ -1209,23 +1543,27 @@
|
|
|
1209
1543
|
{
|
|
1210
1544
|
"name": "requestId",
|
|
1211
1545
|
"in": "path",
|
|
1546
|
+
"description": "The unique request ID associated with the attempt to update an item in inventory.",
|
|
1212
1547
|
"required": true,
|
|
1213
1548
|
"style": "simple",
|
|
1214
1549
|
"explode": false,
|
|
1215
1550
|
"schema": {
|
|
1216
1551
|
"type": "string",
|
|
1552
|
+
"example": "3678-23456-3456-4567-9999-1232",
|
|
1217
1553
|
"maxLength": 128
|
|
1218
1554
|
}
|
|
1219
1555
|
},
|
|
1220
1556
|
{
|
|
1221
1557
|
"name": "organizationId",
|
|
1222
1558
|
"in": "path",
|
|
1559
|
+
"description": "An identifier for the organization the request is being made by",
|
|
1223
1560
|
"required": true,
|
|
1224
1561
|
"style": "simple",
|
|
1225
1562
|
"explode": false,
|
|
1226
1563
|
"schema": {
|
|
1227
1564
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1228
|
-
}
|
|
1565
|
+
},
|
|
1566
|
+
"example": "f_ecom_zzxy_prd"
|
|
1229
1567
|
}
|
|
1230
1568
|
],
|
|
1231
1569
|
"requestBody": {
|
|
@@ -1233,6 +1571,11 @@
|
|
|
1233
1571
|
"application/json": {
|
|
1234
1572
|
"schema": {
|
|
1235
1573
|
"$ref": "#/components/schemas/InventoryUpdateRequestBodyPut"
|
|
1574
|
+
},
|
|
1575
|
+
"examples": {
|
|
1576
|
+
"InventoryUpdatePutRequest": {
|
|
1577
|
+
"$ref": "#/components/examples/InventoryUpdatePutRequest"
|
|
1578
|
+
}
|
|
1236
1579
|
}
|
|
1237
1580
|
}
|
|
1238
1581
|
},
|
|
@@ -1243,6 +1586,7 @@
|
|
|
1243
1586
|
"description": "Data updated successfully.",
|
|
1244
1587
|
"headers": {
|
|
1245
1588
|
"X-RateLimit-Limit": {
|
|
1589
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1246
1590
|
"style": "simple",
|
|
1247
1591
|
"explode": false,
|
|
1248
1592
|
"schema": {
|
|
@@ -1250,6 +1594,7 @@
|
|
|
1250
1594
|
}
|
|
1251
1595
|
},
|
|
1252
1596
|
"X-RateLimit-Remaining": {
|
|
1597
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1253
1598
|
"style": "simple",
|
|
1254
1599
|
"explode": false,
|
|
1255
1600
|
"schema": {
|
|
@@ -1257,6 +1602,7 @@
|
|
|
1257
1602
|
}
|
|
1258
1603
|
},
|
|
1259
1604
|
"X-RateLimit-Reset": {
|
|
1605
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1260
1606
|
"style": "simple",
|
|
1261
1607
|
"explode": false,
|
|
1262
1608
|
"schema": {
|
|
@@ -1269,6 +1615,7 @@
|
|
|
1269
1615
|
"description": "Invalid request.",
|
|
1270
1616
|
"headers": {
|
|
1271
1617
|
"X-RateLimit-Limit": {
|
|
1618
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1272
1619
|
"style": "simple",
|
|
1273
1620
|
"explode": false,
|
|
1274
1621
|
"schema": {
|
|
@@ -1276,6 +1623,7 @@
|
|
|
1276
1623
|
}
|
|
1277
1624
|
},
|
|
1278
1625
|
"X-RateLimit-Remaining": {
|
|
1626
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1279
1627
|
"style": "simple",
|
|
1280
1628
|
"explode": false,
|
|
1281
1629
|
"schema": {
|
|
@@ -1283,6 +1631,7 @@
|
|
|
1283
1631
|
}
|
|
1284
1632
|
},
|
|
1285
1633
|
"X-RateLimit-Reset": {
|
|
1634
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1286
1635
|
"style": "simple",
|
|
1287
1636
|
"explode": false,
|
|
1288
1637
|
"schema": {
|
|
@@ -1294,6 +1643,11 @@
|
|
|
1294
1643
|
"application/problem+json": {
|
|
1295
1644
|
"schema": {
|
|
1296
1645
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1646
|
+
},
|
|
1647
|
+
"examples": {
|
|
1648
|
+
"ErrorEntityNotFound": {
|
|
1649
|
+
"$ref": "#/components/examples/ErrorEntityNotFound"
|
|
1650
|
+
}
|
|
1297
1651
|
}
|
|
1298
1652
|
}
|
|
1299
1653
|
}
|
|
@@ -1304,6 +1658,11 @@
|
|
|
1304
1658
|
"application/problem+json": {
|
|
1305
1659
|
"schema": {
|
|
1306
1660
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1661
|
+
},
|
|
1662
|
+
"examples": {
|
|
1663
|
+
"tenantNotProvisioned403": {
|
|
1664
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
1665
|
+
}
|
|
1307
1666
|
}
|
|
1308
1667
|
}
|
|
1309
1668
|
}
|
|
@@ -1312,6 +1671,7 @@
|
|
|
1312
1671
|
"description": "Entity not found.",
|
|
1313
1672
|
"headers": {
|
|
1314
1673
|
"X-RateLimit-Limit": {
|
|
1674
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1315
1675
|
"style": "simple",
|
|
1316
1676
|
"explode": false,
|
|
1317
1677
|
"schema": {
|
|
@@ -1319,6 +1679,7 @@
|
|
|
1319
1679
|
}
|
|
1320
1680
|
},
|
|
1321
1681
|
"X-RateLimit-Remaining": {
|
|
1682
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1322
1683
|
"style": "simple",
|
|
1323
1684
|
"explode": false,
|
|
1324
1685
|
"schema": {
|
|
@@ -1326,6 +1687,7 @@
|
|
|
1326
1687
|
}
|
|
1327
1688
|
},
|
|
1328
1689
|
"X-RateLimit-Reset": {
|
|
1690
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1329
1691
|
"style": "simple",
|
|
1330
1692
|
"explode": false,
|
|
1331
1693
|
"schema": {
|
|
@@ -1337,6 +1699,11 @@
|
|
|
1337
1699
|
"application/problem+json": {
|
|
1338
1700
|
"schema": {
|
|
1339
1701
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1702
|
+
},
|
|
1703
|
+
"examples": {
|
|
1704
|
+
"EntityNotFound": {
|
|
1705
|
+
"$ref": "#/components/examples/EntityNotFound"
|
|
1706
|
+
}
|
|
1340
1707
|
}
|
|
1341
1708
|
}
|
|
1342
1709
|
}
|
|
@@ -1355,18 +1722,31 @@
|
|
|
1355
1722
|
"content": {
|
|
1356
1723
|
"application/problem+json": {
|
|
1357
1724
|
"schema": {
|
|
1725
|
+
"example": {
|
|
1726
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
1727
|
+
"title": "Too Many Requests",
|
|
1728
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
1729
|
+
},
|
|
1358
1730
|
"properties": {
|
|
1359
1731
|
"title": {
|
|
1360
|
-
"type": "string"
|
|
1732
|
+
"type": "string",
|
|
1733
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
1734
|
+
"example": "You do not have enough credit."
|
|
1361
1735
|
},
|
|
1362
1736
|
"type": {
|
|
1363
|
-
"type": "string"
|
|
1737
|
+
"type": "string",
|
|
1738
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1739
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
1364
1740
|
},
|
|
1365
1741
|
"detail": {
|
|
1366
|
-
"type": "string"
|
|
1742
|
+
"type": "string",
|
|
1743
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
1744
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
1367
1745
|
},
|
|
1368
1746
|
"instance": {
|
|
1369
|
-
"type": "string"
|
|
1747
|
+
"type": "string",
|
|
1748
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1749
|
+
"example": "/account/12345/msgs/abc"
|
|
1370
1750
|
}
|
|
1371
1751
|
},
|
|
1372
1752
|
"required": [
|
|
@@ -1387,11 +1767,13 @@
|
|
|
1387
1767
|
]
|
|
1388
1768
|
},
|
|
1389
1769
|
"delete": {
|
|
1770
|
+
"summary": "Delete a location SKU. When you call this endpoint, all SKU values are reset and marked for deletion from the system. History is not preservered by this action, and the aggregate for this location SKU is also removed from the group view.",
|
|
1390
1771
|
"operationId": "deleteLocationSku",
|
|
1391
1772
|
"parameters": [
|
|
1392
1773
|
{
|
|
1393
1774
|
"name": "locationId",
|
|
1394
1775
|
"in": "path",
|
|
1776
|
+
"description": "The location for the SKU being updated.",
|
|
1395
1777
|
"required": true,
|
|
1396
1778
|
"style": "simple",
|
|
1397
1779
|
"explode": false,
|
|
@@ -1402,6 +1784,7 @@
|
|
|
1402
1784
|
{
|
|
1403
1785
|
"name": "sku",
|
|
1404
1786
|
"in": "path",
|
|
1787
|
+
"description": "The SKU associated with the inventory record you want to update.",
|
|
1405
1788
|
"required": true,
|
|
1406
1789
|
"style": "simple",
|
|
1407
1790
|
"explode": false,
|
|
@@ -1412,23 +1795,27 @@
|
|
|
1412
1795
|
{
|
|
1413
1796
|
"name": "requestId",
|
|
1414
1797
|
"in": "path",
|
|
1798
|
+
"description": "The unique request ID associated with the attempt to update an item in inventory.",
|
|
1415
1799
|
"required": true,
|
|
1416
1800
|
"style": "simple",
|
|
1417
1801
|
"explode": false,
|
|
1418
1802
|
"schema": {
|
|
1419
1803
|
"type": "string",
|
|
1804
|
+
"example": "3678-23456-3456-4567-9999-1232",
|
|
1420
1805
|
"maxLength": 128
|
|
1421
1806
|
}
|
|
1422
1807
|
},
|
|
1423
1808
|
{
|
|
1424
1809
|
"name": "organizationId",
|
|
1425
1810
|
"in": "path",
|
|
1811
|
+
"description": "An identifier for the organization the request is being made by",
|
|
1426
1812
|
"required": true,
|
|
1427
1813
|
"style": "simple",
|
|
1428
1814
|
"explode": false,
|
|
1429
1815
|
"schema": {
|
|
1430
1816
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1431
|
-
}
|
|
1817
|
+
},
|
|
1818
|
+
"example": "f_ecom_zzxy_prd"
|
|
1432
1819
|
}
|
|
1433
1820
|
],
|
|
1434
1821
|
"responses": {
|
|
@@ -1436,6 +1823,7 @@
|
|
|
1436
1823
|
"description": "Location SKU successfully deleted from the system.",
|
|
1437
1824
|
"headers": {
|
|
1438
1825
|
"X-RateLimit-Limit": {
|
|
1826
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1439
1827
|
"style": "simple",
|
|
1440
1828
|
"explode": false,
|
|
1441
1829
|
"schema": {
|
|
@@ -1443,6 +1831,7 @@
|
|
|
1443
1831
|
}
|
|
1444
1832
|
},
|
|
1445
1833
|
"X-RateLimit-Remaining": {
|
|
1834
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1446
1835
|
"style": "simple",
|
|
1447
1836
|
"explode": false,
|
|
1448
1837
|
"schema": {
|
|
@@ -1450,6 +1839,7 @@
|
|
|
1450
1839
|
}
|
|
1451
1840
|
},
|
|
1452
1841
|
"X-RateLimit-Reset": {
|
|
1842
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1453
1843
|
"style": "simple",
|
|
1454
1844
|
"explode": false,
|
|
1455
1845
|
"schema": {
|
|
@@ -1462,6 +1852,7 @@
|
|
|
1462
1852
|
"description": "Location SKU not found.",
|
|
1463
1853
|
"headers": {
|
|
1464
1854
|
"X-RateLimit-Limit": {
|
|
1855
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1465
1856
|
"style": "simple",
|
|
1466
1857
|
"explode": false,
|
|
1467
1858
|
"schema": {
|
|
@@ -1469,6 +1860,7 @@
|
|
|
1469
1860
|
}
|
|
1470
1861
|
},
|
|
1471
1862
|
"X-RateLimit-Remaining": {
|
|
1863
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1472
1864
|
"style": "simple",
|
|
1473
1865
|
"explode": false,
|
|
1474
1866
|
"schema": {
|
|
@@ -1476,6 +1868,7 @@
|
|
|
1476
1868
|
}
|
|
1477
1869
|
},
|
|
1478
1870
|
"X-RateLimit-Reset": {
|
|
1871
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1479
1872
|
"style": "simple",
|
|
1480
1873
|
"explode": false,
|
|
1481
1874
|
"schema": {
|
|
@@ -1487,6 +1880,11 @@
|
|
|
1487
1880
|
"application/problem+json": {
|
|
1488
1881
|
"schema": {
|
|
1489
1882
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1883
|
+
},
|
|
1884
|
+
"examples": {
|
|
1885
|
+
"SKUNotFound": {
|
|
1886
|
+
"$ref": "#/components/examples/SKUNotFound"
|
|
1887
|
+
}
|
|
1490
1888
|
}
|
|
1491
1889
|
}
|
|
1492
1890
|
}
|
|
@@ -1495,6 +1893,7 @@
|
|
|
1495
1893
|
"description": "There is an inventory export in progress, deletion is not allowed.",
|
|
1496
1894
|
"headers": {
|
|
1497
1895
|
"X-RateLimit-Limit": {
|
|
1896
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1498
1897
|
"style": "simple",
|
|
1499
1898
|
"explode": false,
|
|
1500
1899
|
"schema": {
|
|
@@ -1502,6 +1901,7 @@
|
|
|
1502
1901
|
}
|
|
1503
1902
|
},
|
|
1504
1903
|
"X-RateLimit-Remaining": {
|
|
1904
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1505
1905
|
"style": "simple",
|
|
1506
1906
|
"explode": false,
|
|
1507
1907
|
"schema": {
|
|
@@ -1509,6 +1909,7 @@
|
|
|
1509
1909
|
}
|
|
1510
1910
|
},
|
|
1511
1911
|
"X-RateLimit-Reset": {
|
|
1912
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1512
1913
|
"style": "simple",
|
|
1513
1914
|
"explode": false,
|
|
1514
1915
|
"schema": {
|
|
@@ -1520,6 +1921,11 @@
|
|
|
1520
1921
|
"application/problem+json": {
|
|
1521
1922
|
"schema": {
|
|
1522
1923
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
1924
|
+
},
|
|
1925
|
+
"examples": {
|
|
1926
|
+
"ExportInProgress": {
|
|
1927
|
+
"$ref": "#/components/examples/ExportInProgress"
|
|
1928
|
+
}
|
|
1523
1929
|
}
|
|
1524
1930
|
}
|
|
1525
1931
|
}
|
|
@@ -1538,18 +1944,31 @@
|
|
|
1538
1944
|
"content": {
|
|
1539
1945
|
"application/problem+json": {
|
|
1540
1946
|
"schema": {
|
|
1947
|
+
"example": {
|
|
1948
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
1949
|
+
"title": "Too Many Requests",
|
|
1950
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
1951
|
+
},
|
|
1541
1952
|
"properties": {
|
|
1542
1953
|
"title": {
|
|
1543
|
-
"type": "string"
|
|
1954
|
+
"type": "string",
|
|
1955
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
1956
|
+
"example": "You do not have enough credit."
|
|
1544
1957
|
},
|
|
1545
1958
|
"type": {
|
|
1546
|
-
"type": "string"
|
|
1959
|
+
"type": "string",
|
|
1960
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1961
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
1547
1962
|
},
|
|
1548
1963
|
"detail": {
|
|
1549
|
-
"type": "string"
|
|
1964
|
+
"type": "string",
|
|
1965
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
1966
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
1550
1967
|
},
|
|
1551
1968
|
"instance": {
|
|
1552
|
-
"type": "string"
|
|
1969
|
+
"type": "string",
|
|
1970
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
1971
|
+
"example": "/account/12345/msgs/abc"
|
|
1553
1972
|
}
|
|
1554
1973
|
},
|
|
1555
1974
|
"required": [
|
|
@@ -1570,11 +1989,13 @@
|
|
|
1570
1989
|
]
|
|
1571
1990
|
},
|
|
1572
1991
|
"patch": {
|
|
1992
|
+
"summary": "Update or patch the data or quantity information for an item. On a PATCH call, most fields are optional, and only fields that are included are updated with the provided values.",
|
|
1573
1993
|
"operationId": "updateSkuLocation",
|
|
1574
1994
|
"parameters": [
|
|
1575
1995
|
{
|
|
1576
1996
|
"name": "locationId",
|
|
1577
1997
|
"in": "path",
|
|
1998
|
+
"description": "The location for the SKU being updated.",
|
|
1578
1999
|
"required": true,
|
|
1579
2000
|
"style": "simple",
|
|
1580
2001
|
"explode": false,
|
|
@@ -1585,6 +2006,7 @@
|
|
|
1585
2006
|
{
|
|
1586
2007
|
"name": "sku",
|
|
1587
2008
|
"in": "path",
|
|
2009
|
+
"description": "The SKU associated with the inventory record you want to update.",
|
|
1588
2010
|
"required": true,
|
|
1589
2011
|
"style": "simple",
|
|
1590
2012
|
"explode": false,
|
|
@@ -1595,23 +2017,27 @@
|
|
|
1595
2017
|
{
|
|
1596
2018
|
"name": "requestId",
|
|
1597
2019
|
"in": "path",
|
|
2020
|
+
"description": "The unique request ID associated with the attempt to update an item in inventory.",
|
|
1598
2021
|
"required": true,
|
|
1599
2022
|
"style": "simple",
|
|
1600
2023
|
"explode": false,
|
|
1601
2024
|
"schema": {
|
|
1602
2025
|
"type": "string",
|
|
2026
|
+
"example": "3678-23456-3456-4567-9999-1232",
|
|
1603
2027
|
"maxLength": 128
|
|
1604
2028
|
}
|
|
1605
2029
|
},
|
|
1606
2030
|
{
|
|
1607
2031
|
"name": "organizationId",
|
|
1608
2032
|
"in": "path",
|
|
2033
|
+
"description": "An identifier for the organization the request is being made by",
|
|
1609
2034
|
"required": true,
|
|
1610
2035
|
"style": "simple",
|
|
1611
2036
|
"explode": false,
|
|
1612
2037
|
"schema": {
|
|
1613
2038
|
"$ref": "#/components/schemas/OrganizationId"
|
|
1614
|
-
}
|
|
2039
|
+
},
|
|
2040
|
+
"example": "f_ecom_zzxy_prd"
|
|
1615
2041
|
}
|
|
1616
2042
|
],
|
|
1617
2043
|
"requestBody": {
|
|
@@ -1619,6 +2045,11 @@
|
|
|
1619
2045
|
"application/json": {
|
|
1620
2046
|
"schema": {
|
|
1621
2047
|
"$ref": "#/components/schemas/InventoryUpdateRequestBodyPatch"
|
|
2048
|
+
},
|
|
2049
|
+
"examples": {
|
|
2050
|
+
"InventoryUpdatePatchRequest": {
|
|
2051
|
+
"$ref": "#/components/examples/InventoryUpdatePatchRequest"
|
|
2052
|
+
}
|
|
1622
2053
|
}
|
|
1623
2054
|
}
|
|
1624
2055
|
},
|
|
@@ -1629,6 +2060,7 @@
|
|
|
1629
2060
|
"description": "Data updated successfully.",
|
|
1630
2061
|
"headers": {
|
|
1631
2062
|
"X-RateLimit-Limit": {
|
|
2063
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1632
2064
|
"style": "simple",
|
|
1633
2065
|
"explode": false,
|
|
1634
2066
|
"schema": {
|
|
@@ -1636,6 +2068,7 @@
|
|
|
1636
2068
|
}
|
|
1637
2069
|
},
|
|
1638
2070
|
"X-RateLimit-Remaining": {
|
|
2071
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1639
2072
|
"style": "simple",
|
|
1640
2073
|
"explode": false,
|
|
1641
2074
|
"schema": {
|
|
@@ -1643,6 +2076,7 @@
|
|
|
1643
2076
|
}
|
|
1644
2077
|
},
|
|
1645
2078
|
"X-RateLimit-Reset": {
|
|
2079
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1646
2080
|
"style": "simple",
|
|
1647
2081
|
"explode": false,
|
|
1648
2082
|
"schema": {
|
|
@@ -1655,6 +2089,7 @@
|
|
|
1655
2089
|
"description": "Invalid request.",
|
|
1656
2090
|
"headers": {
|
|
1657
2091
|
"X-RateLimit-Limit": {
|
|
2092
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1658
2093
|
"style": "simple",
|
|
1659
2094
|
"explode": false,
|
|
1660
2095
|
"schema": {
|
|
@@ -1662,6 +2097,7 @@
|
|
|
1662
2097
|
}
|
|
1663
2098
|
},
|
|
1664
2099
|
"X-RateLimit-Remaining": {
|
|
2100
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1665
2101
|
"style": "simple",
|
|
1666
2102
|
"explode": false,
|
|
1667
2103
|
"schema": {
|
|
@@ -1669,6 +2105,7 @@
|
|
|
1669
2105
|
}
|
|
1670
2106
|
},
|
|
1671
2107
|
"X-RateLimit-Reset": {
|
|
2108
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1672
2109
|
"style": "simple",
|
|
1673
2110
|
"explode": false,
|
|
1674
2111
|
"schema": {
|
|
@@ -1680,6 +2117,11 @@
|
|
|
1680
2117
|
"application/problem+json": {
|
|
1681
2118
|
"schema": {
|
|
1682
2119
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
2120
|
+
},
|
|
2121
|
+
"examples": {
|
|
2122
|
+
"ErrorEntityNotFound": {
|
|
2123
|
+
"$ref": "#/components/examples/ErrorEntityNotFound"
|
|
2124
|
+
}
|
|
1683
2125
|
}
|
|
1684
2126
|
}
|
|
1685
2127
|
}
|
|
@@ -1690,6 +2132,11 @@
|
|
|
1690
2132
|
"application/problem+json": {
|
|
1691
2133
|
"schema": {
|
|
1692
2134
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
2135
|
+
},
|
|
2136
|
+
"examples": {
|
|
2137
|
+
"tenantNotProvisioned403": {
|
|
2138
|
+
"$ref": "#/components/examples/TenantNotProvisioned403"
|
|
2139
|
+
}
|
|
1693
2140
|
}
|
|
1694
2141
|
}
|
|
1695
2142
|
}
|
|
@@ -1698,6 +2145,7 @@
|
|
|
1698
2145
|
"description": "Entity not found.",
|
|
1699
2146
|
"headers": {
|
|
1700
2147
|
"X-RateLimit-Limit": {
|
|
2148
|
+
"description": "The maximum number of requests permitted per minute.",
|
|
1701
2149
|
"style": "simple",
|
|
1702
2150
|
"explode": false,
|
|
1703
2151
|
"schema": {
|
|
@@ -1705,6 +2153,7 @@
|
|
|
1705
2153
|
}
|
|
1706
2154
|
},
|
|
1707
2155
|
"X-RateLimit-Remaining": {
|
|
2156
|
+
"description": "The number of requests remaining in the current rate limit window.",
|
|
1708
2157
|
"style": "simple",
|
|
1709
2158
|
"explode": false,
|
|
1710
2159
|
"schema": {
|
|
@@ -1712,6 +2161,7 @@
|
|
|
1712
2161
|
}
|
|
1713
2162
|
},
|
|
1714
2163
|
"X-RateLimit-Reset": {
|
|
2164
|
+
"description": "The time at which the current rate limit window resets in UTC epoch seconds.",
|
|
1715
2165
|
"style": "simple",
|
|
1716
2166
|
"explode": false,
|
|
1717
2167
|
"schema": {
|
|
@@ -1723,6 +2173,11 @@
|
|
|
1723
2173
|
"application/problem+json": {
|
|
1724
2174
|
"schema": {
|
|
1725
2175
|
"$ref": "#/components/schemas/InventoryResponseErrorSchema"
|
|
2176
|
+
},
|
|
2177
|
+
"examples": {
|
|
2178
|
+
"EntityNotFound": {
|
|
2179
|
+
"$ref": "#/components/examples/EntityNotFound"
|
|
2180
|
+
}
|
|
1726
2181
|
}
|
|
1727
2182
|
}
|
|
1728
2183
|
}
|
|
@@ -1741,18 +2196,31 @@
|
|
|
1741
2196
|
"content": {
|
|
1742
2197
|
"application/problem+json": {
|
|
1743
2198
|
"schema": {
|
|
2199
|
+
"example": {
|
|
2200
|
+
"type": "https://api.commercecloud.salesforce.com/documentation/error/v1/errors/too-many-requests",
|
|
2201
|
+
"title": "Too Many Requests",
|
|
2202
|
+
"detail": "You have performed too many requests in a short period of time."
|
|
2203
|
+
},
|
|
1744
2204
|
"properties": {
|
|
1745
2205
|
"title": {
|
|
1746
|
-
"type": "string"
|
|
2206
|
+
"type": "string",
|
|
2207
|
+
"description": "A short, human-readable summary of the problem\ntype. It will not change from occurrence to occurrence of the\nproblem, except for purposes of localization.\n",
|
|
2208
|
+
"example": "You do not have enough credit."
|
|
1747
2209
|
},
|
|
1748
2210
|
"type": {
|
|
1749
|
-
"type": "string"
|
|
2211
|
+
"type": "string",
|
|
2212
|
+
"description": "A URI reference [RFC3986] that identifies the\nproblem type. This specification encourages that, when\ndereferenced, it provide human-readable documentation for the\nproblem type (e.g., using HTML [W3C.REC-html5-20141028]). When\nthis member is not present, its value is assumed to be\n\"about:blank\". It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
2213
|
+
"example": "https://example.com/probs/out-of-credit"
|
|
1750
2214
|
},
|
|
1751
2215
|
"detail": {
|
|
1752
|
-
"type": "string"
|
|
2216
|
+
"type": "string",
|
|
2217
|
+
"description": "A human-readable explanation specific to this\noccurrence of the problem.\n",
|
|
2218
|
+
"example": "Your current balance is 30, but that costs 50."
|
|
1753
2219
|
},
|
|
1754
2220
|
"instance": {
|
|
1755
|
-
"type": "string"
|
|
2221
|
+
"type": "string",
|
|
2222
|
+
"description": "A URI reference that identifies the specific\noccurrence of the problem. It may or may not yield further\ninformation if dereferenced. It accepts relative URIs; this means\nthat they must be resolved relative to the document's base URI, as\nper [RFC3986], Section 5.\n",
|
|
2223
|
+
"example": "/account/12345/msgs/abc"
|
|
1756
2224
|
}
|
|
1757
2225
|
},
|
|
1758
2226
|
"required": [
|
|
@@ -1778,27 +2246,36 @@
|
|
|
1778
2246
|
"schemas": {
|
|
1779
2247
|
"OrganizationId": {
|
|
1780
2248
|
"type": "string",
|
|
2249
|
+
"description": "An identifier for the organization the request is being made by",
|
|
2250
|
+
"example": "f_ecom_zzxy_prd",
|
|
1781
2251
|
"maxLength": 32,
|
|
1782
2252
|
"minLength": 1
|
|
1783
2253
|
},
|
|
1784
2254
|
"PlaceType": {
|
|
1785
2255
|
"type": "string",
|
|
2256
|
+
"description": "The type of place associated to the id",
|
|
2257
|
+
"example": "{type: location | group}",
|
|
1786
2258
|
"maxLength": 256
|
|
1787
2259
|
},
|
|
1788
2260
|
"GroupId": {
|
|
1789
2261
|
"type": "string",
|
|
2262
|
+
"description": "An identifier for a collection of locations.",
|
|
2263
|
+
"example": "UnitedStates",
|
|
1790
2264
|
"maxLength": 128,
|
|
1791
2265
|
"minLength": 1,
|
|
1792
2266
|
"pattern": "^[a-zA-Z0-9-_]*$"
|
|
1793
2267
|
},
|
|
1794
2268
|
"LocationId": {
|
|
1795
2269
|
"type": "string",
|
|
2270
|
+
"description": "The id of the location of the inventory.",
|
|
2271
|
+
"example": "warehouse5",
|
|
1796
2272
|
"maxLength": 128,
|
|
1797
2273
|
"minLength": 2,
|
|
1798
2274
|
"pattern": "^[a-zA-Z0-9-_]*$"
|
|
1799
2275
|
},
|
|
1800
2276
|
"Places": {
|
|
1801
2277
|
"type": "array",
|
|
2278
|
+
"description": "The list of places",
|
|
1802
2279
|
"items": {
|
|
1803
2280
|
"allOf": [
|
|
1804
2281
|
{
|
|
@@ -1807,12 +2284,23 @@
|
|
|
1807
2284
|
{
|
|
1808
2285
|
"$ref": "#/components/schemas/LocationId"
|
|
1809
2286
|
}
|
|
1810
|
-
]
|
|
2287
|
+
],
|
|
2288
|
+
"example": {
|
|
2289
|
+
"locationExample": [
|
|
2290
|
+
"warehouseOne",
|
|
2291
|
+
"warehouseTwo"
|
|
2292
|
+
],
|
|
2293
|
+
"groupExample": [
|
|
2294
|
+
"UnitedStates",
|
|
2295
|
+
"Canada"
|
|
2296
|
+
]
|
|
2297
|
+
}
|
|
1811
2298
|
},
|
|
1812
2299
|
"maxItems": 100
|
|
1813
2300
|
},
|
|
1814
2301
|
"CreateNewDeltaTokenBody": {
|
|
1815
2302
|
"type": "object",
|
|
2303
|
+
"description": "Whether this is a location or a group",
|
|
1816
2304
|
"properties": {
|
|
1817
2305
|
"placeType": {
|
|
1818
2306
|
"$ref": "#/components/schemas/PlaceType"
|
|
@@ -1828,10 +2316,13 @@
|
|
|
1828
2316
|
},
|
|
1829
2317
|
"DeltaToken": {
|
|
1830
2318
|
"type": "string",
|
|
2319
|
+
"description": "The delta token obtained from a full export or a previous request to this API",
|
|
2320
|
+
"example": "e3NoYXJkSWQtMDAwMDAwMDE1NzczOTkxNTc2MDItYmE5MGYxNGE6MDAwMDAwMDAwMDAwMDAwMDAwNDQ0fQ==",
|
|
1831
2321
|
"maxLength": 256
|
|
1832
2322
|
},
|
|
1833
2323
|
"CreateNewDeltaTokenResponse": {
|
|
1834
2324
|
"type": "object",
|
|
2325
|
+
"description": "The new Delta Token",
|
|
1835
2326
|
"properties": {
|
|
1836
2327
|
"deltaToken": {
|
|
1837
2328
|
"$ref": "#/components/schemas/DeltaToken"
|
|
@@ -1846,18 +2337,23 @@
|
|
|
1846
2337
|
"properties": {
|
|
1847
2338
|
"errorCode": {
|
|
1848
2339
|
"type": "string",
|
|
2340
|
+
"example": "InvalidRequestParameter",
|
|
1849
2341
|
"maxLength": 256
|
|
1850
2342
|
},
|
|
1851
2343
|
"message": {
|
|
1852
2344
|
"type": "string",
|
|
2345
|
+
"example": "An invalid request parameter was provided.",
|
|
1853
2346
|
"maxLength": 256
|
|
1854
2347
|
},
|
|
1855
2348
|
"type": {
|
|
1856
2349
|
"type": "string",
|
|
2350
|
+
"example": "about:blank",
|
|
1857
2351
|
"maxLength": 256
|
|
1858
2352
|
},
|
|
1859
2353
|
"parameterName": {
|
|
1860
2354
|
"type": "string",
|
|
2355
|
+
"description": "When invalid json is passed to the service, this field will indicate which piece of the supplied json was invalid.",
|
|
2356
|
+
"example": "location",
|
|
1861
2357
|
"maxLength": 256
|
|
1862
2358
|
}
|
|
1863
2359
|
},
|
|
@@ -1884,6 +2380,7 @@
|
|
|
1884
2380
|
},
|
|
1885
2381
|
"UpdateDeltaTokenResponse": {
|
|
1886
2382
|
"type": "object",
|
|
2383
|
+
"description": "The updated Delta Token",
|
|
1887
2384
|
"properties": {
|
|
1888
2385
|
"deltaToken": {
|
|
1889
2386
|
"$ref": "#/components/schemas/DeltaToken"
|
|
@@ -1898,19 +2395,26 @@
|
|
|
1898
2395
|
},
|
|
1899
2396
|
"ExternalRefId": {
|
|
1900
2397
|
"type": "string",
|
|
2398
|
+
"description": "A convenience identifier for the consumer, used for auditing events. This field is NOT used by the service itself, but is intended for the consumer to be able to identify records submitted from their systems that are external to OCI.",
|
|
2399
|
+
"example": "7282822-9823-aaa",
|
|
1901
2400
|
"maxLength": 250
|
|
1902
2401
|
},
|
|
1903
2402
|
"Date": {
|
|
1904
2403
|
"type": "string",
|
|
1905
|
-
"format": "date-time"
|
|
2404
|
+
"format": "date-time",
|
|
2405
|
+
"description": "The date the future quantity is expected to arrive at the location.",
|
|
2406
|
+
"example": "2019-07-24T21:13:00Z"
|
|
1906
2407
|
},
|
|
1907
2408
|
"Quantity": {
|
|
1908
2409
|
"type": "number",
|
|
2410
|
+
"description": "The amount that is expected to arrive at a future date",
|
|
2411
|
+
"example": 10.25,
|
|
1909
2412
|
"minimum": 0.001,
|
|
1910
2413
|
"multipleOf": 0.001
|
|
1911
2414
|
},
|
|
1912
2415
|
"Future": {
|
|
1913
2416
|
"type": "object",
|
|
2417
|
+
"description": "The 'future' object contains data that tells us what is expected to arrive for this item in the future, as well as when those amounts of inventory should arrive.",
|
|
1914
2418
|
"properties": {
|
|
1915
2419
|
"expectedDate": {
|
|
1916
2420
|
"$ref": "#/components/schemas/Date"
|
|
@@ -1926,11 +2430,13 @@
|
|
|
1926
2430
|
},
|
|
1927
2431
|
"GroupEligibilityExclusion": {
|
|
1928
2432
|
"type": "string",
|
|
2433
|
+
"description": "The group eligibility exclusion that can be applied in an Attribute Set as part of an item update.",
|
|
1929
2434
|
"maxLength": 128,
|
|
1930
2435
|
"minLength": 2
|
|
1931
2436
|
},
|
|
1932
2437
|
"AttributeSet": {
|
|
1933
2438
|
"type": "object",
|
|
2439
|
+
"description": "A set of attributes that can be applied as attributes in a request.",
|
|
1934
2440
|
"properties": {
|
|
1935
2441
|
"groupEligibilityExclusion": {
|
|
1936
2442
|
"type": "array",
|
|
@@ -1946,26 +2452,35 @@
|
|
|
1946
2452
|
"QOH": {
|
|
1947
2453
|
"type": "number",
|
|
1948
2454
|
"format": "double",
|
|
2455
|
+
"description": "Quantity on hand.",
|
|
2456
|
+
"example": 1200.35,
|
|
1949
2457
|
"minimum": 0,
|
|
1950
2458
|
"multipleOf": 0.001
|
|
1951
2459
|
},
|
|
1952
2460
|
"SafetyStock": {
|
|
1953
2461
|
"type": "number",
|
|
1954
2462
|
"format": "double",
|
|
2463
|
+
"description": "Inventory quantity that a merchant wants to intentionally hold back from availability counts. \nPrecision of the safety stock is four decimal places: 0.001.",
|
|
2464
|
+
"example": 12.45,
|
|
1955
2465
|
"minimum": 0
|
|
1956
2466
|
},
|
|
1957
2467
|
"SkuId": {
|
|
1958
2468
|
"type": "string",
|
|
2469
|
+
"description": "The inventory identifier",
|
|
2470
|
+
"example": "sku123",
|
|
1959
2471
|
"maxLength": 250,
|
|
1960
2472
|
"minLength": 2,
|
|
1961
2473
|
"pattern": "^[^\\\\<>;%/\\s]*$"
|
|
1962
2474
|
},
|
|
1963
2475
|
"IdempotenceId": {
|
|
1964
2476
|
"type": "string",
|
|
2477
|
+
"description": "A unique identifier, used in combination with the SKU, so that future requests with the same combination have the same result.",
|
|
2478
|
+
"example": "82251928-8863-488e-840b-2aebd10b57ba",
|
|
1965
2479
|
"maxLength": 250
|
|
1966
2480
|
},
|
|
1967
2481
|
"BatchInventoryUpdateRequestRecord": {
|
|
1968
2482
|
"type": "object",
|
|
2483
|
+
"description": "Record definition used in a batch inventory update request",
|
|
1969
2484
|
"properties": {
|
|
1970
2485
|
"externalRefId": {
|
|
1971
2486
|
"$ref": "#/components/schemas/ExternalRefId"
|
|
@@ -2009,6 +2524,7 @@
|
|
|
2009
2524
|
"properties": {
|
|
2010
2525
|
"records": {
|
|
2011
2526
|
"type": "array",
|
|
2527
|
+
"description": "List of records to process in a batch update. The maximum number of entries in the array is 100.",
|
|
2012
2528
|
"items": {
|
|
2013
2529
|
"$ref": "#/components/schemas/BatchInventoryUpdateRequestRecord"
|
|
2014
2530
|
},
|
|
@@ -2021,6 +2537,7 @@
|
|
|
2021
2537
|
},
|
|
2022
2538
|
"BatchInventoryUpdateErrorDetail": {
|
|
2023
2539
|
"type": "object",
|
|
2540
|
+
"description": "Detail information for errors generated during a batch inventory update.",
|
|
2024
2541
|
"properties": {
|
|
2025
2542
|
"externalRefId": {
|
|
2026
2543
|
"$ref": "#/components/schemas/ExternalRefId"
|
|
@@ -2043,16 +2560,19 @@
|
|
|
2043
2560
|
},
|
|
2044
2561
|
"BatchInventoryUpdateSingleError": {
|
|
2045
2562
|
"type": "object",
|
|
2563
|
+
"description": "Error record information generated during a batch inventory update.",
|
|
2046
2564
|
"properties": {
|
|
2047
2565
|
"details": {
|
|
2048
2566
|
"$ref": "#/components/schemas/BatchInventoryUpdateErrorDetail"
|
|
2049
2567
|
},
|
|
2050
2568
|
"message": {
|
|
2051
2569
|
"type": "string",
|
|
2570
|
+
"example": "Inventory record update failed",
|
|
2052
2571
|
"maxLength": 255
|
|
2053
2572
|
},
|
|
2054
2573
|
"errorCode": {
|
|
2055
2574
|
"type": "string",
|
|
2575
|
+
"example": "InventoryReset",
|
|
2056
2576
|
"maxLength": 255
|
|
2057
2577
|
}
|
|
2058
2578
|
},
|
|
@@ -2064,6 +2584,7 @@
|
|
|
2064
2584
|
},
|
|
2065
2585
|
"BatchInventoryUpdateErrors": {
|
|
2066
2586
|
"type": "object",
|
|
2587
|
+
"description": "Errors produced during a batch inventory update",
|
|
2067
2588
|
"properties": {
|
|
2068
2589
|
"errors": {
|
|
2069
2590
|
"type": "array",
|
|
@@ -2088,32 +2609,43 @@
|
|
|
2088
2609
|
]
|
|
2089
2610
|
},
|
|
2090
2611
|
"ShouldQueryAgain": {
|
|
2091
|
-
"type": "boolean"
|
|
2612
|
+
"type": "boolean",
|
|
2613
|
+
"description": "Indicates to the consumer if they should immediately call again to retrieve deltas that are potentially waiting in the stream.",
|
|
2614
|
+
"example": true
|
|
2092
2615
|
},
|
|
2093
2616
|
"PlaceId": {
|
|
2094
2617
|
"type": "string",
|
|
2618
|
+
"description": "The id of a group or location where inventory is located.",
|
|
2619
|
+
"example": "{\"location\":\"warehouse5\",\"group\":\"UnitedStates\"}",
|
|
2095
2620
|
"maxLength": 128
|
|
2096
2621
|
},
|
|
2097
2622
|
"ATF": {
|
|
2098
2623
|
"type": "number",
|
|
2099
2624
|
"format": "double",
|
|
2625
|
+
"description": "The amount available to fulfill at the location",
|
|
2626
|
+
"example": 1137.65,
|
|
2100
2627
|
"minimum": 0,
|
|
2101
2628
|
"multipleOf": 0.001
|
|
2102
2629
|
},
|
|
2103
2630
|
"ATO": {
|
|
2104
2631
|
"type": "number",
|
|
2105
2632
|
"format": "double",
|
|
2633
|
+
"description": "The amount available to order at the location",
|
|
2634
|
+
"example": 1147.9,
|
|
2106
2635
|
"minimum": 0,
|
|
2107
2636
|
"multipleOf": 0.001
|
|
2108
2637
|
},
|
|
2109
2638
|
"QuantityReserved": {
|
|
2110
2639
|
"type": "number",
|
|
2111
2640
|
"format": "double",
|
|
2641
|
+
"description": "Actual quantity reserved. This value can be less than the quantity requested.",
|
|
2642
|
+
"example": 50.25,
|
|
2112
2643
|
"minimum": 0,
|
|
2113
2644
|
"multipleOf": 0.001
|
|
2114
2645
|
},
|
|
2115
2646
|
"DeltaRecordType": {
|
|
2116
2647
|
"type": "object",
|
|
2648
|
+
"description": "An availability delta record that is returned from the availability delta calls. All fields that are Required will be reported, however if there is not a value for any particular field, it will be 0, empty or null.",
|
|
2117
2649
|
"properties": {
|
|
2118
2650
|
"sku": {
|
|
2119
2651
|
"$ref": "#/components/schemas/SkuId"
|
|
@@ -2123,7 +2655,8 @@
|
|
|
2123
2655
|
"enum": [
|
|
2124
2656
|
"Change",
|
|
2125
2657
|
"Delete"
|
|
2126
|
-
]
|
|
2658
|
+
],
|
|
2659
|
+
"example": "Change"
|
|
2127
2660
|
},
|
|
2128
2661
|
"id": {
|
|
2129
2662
|
"$ref": "#/components/schemas/PlaceId"
|
|
@@ -2133,10 +2666,13 @@
|
|
|
2133
2666
|
{
|
|
2134
2667
|
"$ref": "#/components/schemas/Date"
|
|
2135
2668
|
}
|
|
2136
|
-
]
|
|
2669
|
+
],
|
|
2670
|
+
"description": "The effective date for the info is provided, but the field is NOT required. The date represents when the onHand value was accurate at the location."
|
|
2137
2671
|
},
|
|
2138
2672
|
"sequenceNumber": {
|
|
2139
|
-
"type": "number"
|
|
2673
|
+
"type": "number",
|
|
2674
|
+
"description": "A sequence number to allow the caller to determine if records have been returned out of order.",
|
|
2675
|
+
"example": 123
|
|
2140
2676
|
},
|
|
2141
2677
|
"onHand": {
|
|
2142
2678
|
"$ref": "#/components/schemas/QOH"
|
|
@@ -2197,35 +2733,41 @@
|
|
|
2197
2733
|
},
|
|
2198
2734
|
"InventoryAvailabilityRequestBody": {
|
|
2199
2735
|
"type": "object",
|
|
2736
|
+
"description": "The body that is sent requesting the item availability by location and/or group",
|
|
2200
2737
|
"properties": {
|
|
2201
2738
|
"sku": {
|
|
2202
2739
|
"allOf": [
|
|
2203
2740
|
{
|
|
2204
2741
|
"$ref": "#/components/schemas/SkuId"
|
|
2205
2742
|
}
|
|
2206
|
-
]
|
|
2743
|
+
],
|
|
2744
|
+
"description": "Used for retrieving the data for a single item for all locations that have not been assigned to any specific group(s). If a group Id is specified in the request, then the locations to be returned will be the ones assigned to the specified group."
|
|
2207
2745
|
},
|
|
2208
2746
|
"group": {
|
|
2209
2747
|
"allOf": [
|
|
2210
2748
|
{
|
|
2211
2749
|
"$ref": "#/components/schemas/GroupId"
|
|
2212
2750
|
}
|
|
2213
|
-
]
|
|
2751
|
+
],
|
|
2752
|
+
"description": "The group ID that should be used in conjunction with the single sku provided in the request. This will retrieve the information for all locations in this group."
|
|
2214
2753
|
},
|
|
2215
2754
|
"skus": {
|
|
2216
2755
|
"type": "array",
|
|
2756
|
+
"description": "It specifies the skus for which the availability requires to be checked. The array of SKUs is limited by the total combinations of SKU per location plus SKU per group to check, the total cannot be more than 100.",
|
|
2217
2757
|
"items": {
|
|
2218
2758
|
"$ref": "#/components/schemas/SkuId"
|
|
2219
2759
|
}
|
|
2220
2760
|
},
|
|
2221
2761
|
"locations": {
|
|
2222
2762
|
"type": "array",
|
|
2763
|
+
"description": "Query the system for availability at this location. This field does not union with the groups field. The array of locations is limited by the total combinations of SKU per location plus SKU per group to check, the total cannot be more than 100.",
|
|
2223
2764
|
"items": {
|
|
2224
2765
|
"$ref": "#/components/schemas/LocationId"
|
|
2225
2766
|
}
|
|
2226
2767
|
},
|
|
2227
2768
|
"groups": {
|
|
2228
2769
|
"type": "array",
|
|
2770
|
+
"description": "Query the system for availability for this group. This field does not union with the locations field. Array is limited to 0-100 items. This field does not union with the groups field. The array of groups is limited by the total combinations of SKU per location plus SKU per group to check, the total cannot be more than 100.",
|
|
2229
2771
|
"items": {
|
|
2230
2772
|
"$ref": "#/components/schemas/GroupId"
|
|
2231
2773
|
}
|
|
@@ -2235,22 +2777,29 @@
|
|
|
2235
2777
|
"Reserved": {
|
|
2236
2778
|
"type": "number",
|
|
2237
2779
|
"format": "double",
|
|
2780
|
+
"description": "The amount reserved at the location",
|
|
2781
|
+
"example": 12.5,
|
|
2238
2782
|
"minimum": 0,
|
|
2239
2783
|
"multipleOf": 0.001
|
|
2240
2784
|
},
|
|
2241
2785
|
"Exists": {
|
|
2242
|
-
"type": "boolean"
|
|
2786
|
+
"type": "boolean",
|
|
2787
|
+
"description": "Indicates whether a record exists for a SKU. This could be helpful since, the Get Availability API returns records with all zero values when the sku does not exist.",
|
|
2788
|
+
"example": true
|
|
2243
2789
|
},
|
|
2244
2790
|
"ItemLocationInfo": {
|
|
2245
2791
|
"type": "object",
|
|
2792
|
+
"description": "Location information used for availability by location responses",
|
|
2246
2793
|
"properties": {
|
|
2247
2794
|
"id": {
|
|
2248
2795
|
"$ref": "#/components/schemas/LocationId"
|
|
2249
2796
|
},
|
|
2250
2797
|
"records": {
|
|
2251
2798
|
"type": "array",
|
|
2799
|
+
"description": "Records returned for the sku/location combination",
|
|
2252
2800
|
"items": {
|
|
2253
2801
|
"type": "object",
|
|
2802
|
+
"description": "A record contained within the lookup results containing details about the item. Those details include the sku, available to fulfill amount, available to order amount, quantity on hand amount, and the safety stock count value.",
|
|
2254
2803
|
"properties": {
|
|
2255
2804
|
"sku": {
|
|
2256
2805
|
"$ref": "#/components/schemas/SkuId"
|
|
@@ -2307,10 +2856,13 @@
|
|
|
2307
2856
|
{
|
|
2308
2857
|
"$ref": "#/components/schemas/Date"
|
|
2309
2858
|
}
|
|
2310
|
-
]
|
|
2859
|
+
],
|
|
2860
|
+
"description": "The date the future quantity is expected to arrive within the group",
|
|
2861
|
+
"example": "2019-07-24T21:13:00Z"
|
|
2311
2862
|
},
|
|
2312
2863
|
"FutureGroup": {
|
|
2313
2864
|
"type": "object",
|
|
2865
|
+
"description": "The 'future' object contains data that tells us what is expected to arrive for this item in the future, as well as when those amounts of inventory should arrive.",
|
|
2314
2866
|
"properties": {
|
|
2315
2867
|
"expectedDate": {
|
|
2316
2868
|
"$ref": "#/components/schemas/DateGroup"
|
|
@@ -2326,14 +2878,17 @@
|
|
|
2326
2878
|
},
|
|
2327
2879
|
"ItemGroupInfo": {
|
|
2328
2880
|
"type": "object",
|
|
2881
|
+
"description": "The group info, associated with an item and used in the availability responses.",
|
|
2329
2882
|
"properties": {
|
|
2330
2883
|
"id": {
|
|
2331
2884
|
"$ref": "#/components/schemas/GroupId"
|
|
2332
2885
|
},
|
|
2333
2886
|
"records": {
|
|
2334
2887
|
"type": "array",
|
|
2888
|
+
"description": "Records returned for a sku/group combination",
|
|
2335
2889
|
"items": {
|
|
2336
2890
|
"type": "object",
|
|
2891
|
+
"description": "A record contained within the lookup results containing details about the item. Those details include the sku, available to fulfill amount, available to order amount, quantity on hand amount, and the safety stock count value.",
|
|
2337
2892
|
"properties": {
|
|
2338
2893
|
"sku": {
|
|
2339
2894
|
"$ref": "#/components/schemas/SkuId"
|
|
@@ -2343,28 +2898,32 @@
|
|
|
2343
2898
|
{
|
|
2344
2899
|
"$ref": "#/components/schemas/ATF"
|
|
2345
2900
|
}
|
|
2346
|
-
]
|
|
2901
|
+
],
|
|
2902
|
+
"description": "The amount available to fulfill at for the group"
|
|
2347
2903
|
},
|
|
2348
2904
|
"ato": {
|
|
2349
2905
|
"allOf": [
|
|
2350
2906
|
{
|
|
2351
2907
|
"$ref": "#/components/schemas/ATO"
|
|
2352
2908
|
}
|
|
2353
|
-
]
|
|
2909
|
+
],
|
|
2910
|
+
"description": "The amount available to order at within the group"
|
|
2354
2911
|
},
|
|
2355
2912
|
"onHand": {
|
|
2356
2913
|
"allOf": [
|
|
2357
2914
|
{
|
|
2358
2915
|
"$ref": "#/components/schemas/QOH"
|
|
2359
2916
|
}
|
|
2360
|
-
]
|
|
2917
|
+
],
|
|
2918
|
+
"description": "Quantity on hand within the group."
|
|
2361
2919
|
},
|
|
2362
2920
|
"reserved": {
|
|
2363
2921
|
"allOf": [
|
|
2364
2922
|
{
|
|
2365
2923
|
"$ref": "#/components/schemas/Reserved"
|
|
2366
2924
|
}
|
|
2367
|
-
]
|
|
2925
|
+
],
|
|
2926
|
+
"description": "The amount reserved within the group"
|
|
2368
2927
|
},
|
|
2369
2928
|
"safetyStockCount": {
|
|
2370
2929
|
"$ref": "#/components/schemas/SafetyStock"
|
|
@@ -2374,14 +2933,16 @@
|
|
|
2374
2933
|
{
|
|
2375
2934
|
"$ref": "#/components/schemas/Reserved"
|
|
2376
2935
|
}
|
|
2377
|
-
]
|
|
2936
|
+
],
|
|
2937
|
+
"description": "The total group reservations for the group NOT including shared"
|
|
2378
2938
|
},
|
|
2379
2939
|
"sharedGroupReserved": {
|
|
2380
2940
|
"allOf": [
|
|
2381
2941
|
{
|
|
2382
2942
|
"$ref": "#/components/schemas/Reserved"
|
|
2383
2943
|
}
|
|
2384
|
-
]
|
|
2944
|
+
],
|
|
2945
|
+
"description": "The amount of the soft_reserved count that comes from other groups"
|
|
2385
2946
|
},
|
|
2386
2947
|
"effectiveDate": {
|
|
2387
2948
|
"$ref": "#/components/schemas/Date"
|
|
@@ -2414,6 +2975,7 @@
|
|
|
2414
2975
|
},
|
|
2415
2976
|
"Response200": {
|
|
2416
2977
|
"type": "object",
|
|
2978
|
+
"description": "Successful request for item information",
|
|
2417
2979
|
"properties": {
|
|
2418
2980
|
"locations": {
|
|
2419
2981
|
"type": "array",
|
|
@@ -2447,10 +3009,15 @@
|
|
|
2447
3009
|
"type": "string",
|
|
2448
3010
|
"enum": [
|
|
2449
3011
|
"APPEND"
|
|
2450
|
-
]
|
|
3012
|
+
],
|
|
3013
|
+
"example": "APPEND"
|
|
2451
3014
|
},
|
|
2452
3015
|
"skus": {
|
|
2453
3016
|
"type": "array",
|
|
3017
|
+
"example": [
|
|
3018
|
+
"AppendNewSku1",
|
|
3019
|
+
"AppendNewSku2"
|
|
3020
|
+
],
|
|
2454
3021
|
"items": {
|
|
2455
3022
|
"$ref": "#/components/schemas/SkuId"
|
|
2456
3023
|
}
|
|
@@ -2483,10 +3050,15 @@
|
|
|
2483
3050
|
"type": "string",
|
|
2484
3051
|
"enum": [
|
|
2485
3052
|
"DELETE"
|
|
2486
|
-
]
|
|
3053
|
+
],
|
|
3054
|
+
"example": "DELETE"
|
|
2487
3055
|
},
|
|
2488
3056
|
"skus": {
|
|
2489
3057
|
"type": "array",
|
|
3058
|
+
"example": [
|
|
3059
|
+
"DeleteSku1",
|
|
3060
|
+
"DeleteSku2"
|
|
3061
|
+
],
|
|
2490
3062
|
"items": {
|
|
2491
3063
|
"$ref": "#/components/schemas/SkuId"
|
|
2492
3064
|
}
|
|
@@ -2511,6 +3083,7 @@
|
|
|
2511
3083
|
"properties": {
|
|
2512
3084
|
"error": {
|
|
2513
3085
|
"type": "string",
|
|
3086
|
+
"example": "Failed to delete product segmentation for group id WarehouseOne and sku 13",
|
|
2514
3087
|
"maxLength": 256
|
|
2515
3088
|
}
|
|
2516
3089
|
},
|
|
@@ -2521,6 +3094,7 @@
|
|
|
2521
3094
|
},
|
|
2522
3095
|
"InventoryUpdateRequestBodyPut": {
|
|
2523
3096
|
"type": "object",
|
|
3097
|
+
"description": "The body of the put request for updating sku/location inventory.\nAll fields are required. If a field is missing or contains a null value then a 400 error will be thrown.",
|
|
2524
3098
|
"properties": {
|
|
2525
3099
|
"externalRefId": {
|
|
2526
3100
|
"$ref": "#/components/schemas/ExternalRefId"
|
|
@@ -2547,6 +3121,7 @@
|
|
|
2547
3121
|
},
|
|
2548
3122
|
"InventoryUpdateRequestBodyPatch": {
|
|
2549
3123
|
"type": "object",
|
|
3124
|
+
"description": "The body of the patch request for updating sku/location inventory.\nAll fields are OPTIONAL. If a field is missing or contains a null value then the system doesn't update that field when patching.",
|
|
2550
3125
|
"properties": {
|
|
2551
3126
|
"externalRefId": {
|
|
2552
3127
|
"$ref": "#/components/schemas/ExternalRefId"
|
|
@@ -2576,16 +3151,19 @@
|
|
|
2576
3151
|
"organizationId": {
|
|
2577
3152
|
"name": "organizationId",
|
|
2578
3153
|
"in": "path",
|
|
3154
|
+
"description": "An identifier for the organization the request is being made by",
|
|
2579
3155
|
"required": true,
|
|
2580
3156
|
"style": "simple",
|
|
2581
3157
|
"explode": false,
|
|
2582
3158
|
"schema": {
|
|
2583
3159
|
"$ref": "#/components/schemas/OrganizationId"
|
|
2584
|
-
}
|
|
3160
|
+
},
|
|
3161
|
+
"example": "f_ecom_zzxy_prd"
|
|
2585
3162
|
},
|
|
2586
3163
|
"locationId": {
|
|
2587
3164
|
"name": "locationId",
|
|
2588
3165
|
"in": "path",
|
|
3166
|
+
"description": "The location for the SKU being updated.",
|
|
2589
3167
|
"required": true,
|
|
2590
3168
|
"style": "simple",
|
|
2591
3169
|
"explode": false,
|
|
@@ -2596,6 +3174,7 @@
|
|
|
2596
3174
|
"sku": {
|
|
2597
3175
|
"name": "sku",
|
|
2598
3176
|
"in": "path",
|
|
3177
|
+
"description": "The SKU associated with the inventory record you want to update.",
|
|
2599
3178
|
"required": true,
|
|
2600
3179
|
"style": "simple",
|
|
2601
3180
|
"explode": false,
|
|
@@ -2606,18 +3185,612 @@
|
|
|
2606
3185
|
"requestId": {
|
|
2607
3186
|
"name": "requestId",
|
|
2608
3187
|
"in": "path",
|
|
3188
|
+
"description": "The unique request ID associated with the attempt to update an item in inventory.",
|
|
2609
3189
|
"required": true,
|
|
2610
3190
|
"style": "simple",
|
|
2611
3191
|
"explode": false,
|
|
2612
3192
|
"schema": {
|
|
2613
3193
|
"type": "string",
|
|
3194
|
+
"example": "3678-23456-3456-4567-9999-1232",
|
|
2614
3195
|
"maxLength": 128
|
|
2615
3196
|
}
|
|
2616
3197
|
}
|
|
2617
3198
|
},
|
|
3199
|
+
"examples": {
|
|
3200
|
+
"CreateDeltaTokenGroups": {
|
|
3201
|
+
"value": {
|
|
3202
|
+
"placeType": "GROUP",
|
|
3203
|
+
"places": [
|
|
3204
|
+
"UnitedStates"
|
|
3205
|
+
]
|
|
3206
|
+
}
|
|
3207
|
+
},
|
|
3208
|
+
"CreateDeltaTokenLocations": {
|
|
3209
|
+
"value": {
|
|
3210
|
+
"placeType": "LOCATION",
|
|
3211
|
+
"places": [
|
|
3212
|
+
"warehouse5"
|
|
3213
|
+
]
|
|
3214
|
+
}
|
|
3215
|
+
},
|
|
3216
|
+
"createNewDeltaToken200": {
|
|
3217
|
+
"value": {
|
|
3218
|
+
"deltaToken": "e3NoYXJkSWQtMDAwMDAwMDE1NzczOTkxNTc2MDItYmE5MGYxNGE6MDAwMDAwMDAwMDAwMDAwMDAwNDQ0fQ=="
|
|
3219
|
+
}
|
|
3220
|
+
},
|
|
3221
|
+
"DeltaTokenInvalidPlaces": {
|
|
3222
|
+
"value": {
|
|
3223
|
+
"type": "about:blank",
|
|
3224
|
+
"errorCode": "InvalidRequestParameter",
|
|
3225
|
+
"message": "places must be of type location or group",
|
|
3226
|
+
"parameterName": "places"
|
|
3227
|
+
}
|
|
3228
|
+
},
|
|
3229
|
+
"UpdateDeltaTokenGroups": {
|
|
3230
|
+
"value": {
|
|
3231
|
+
"deltaToken": "e3NoYXJkSWQtMDAwMDAwMDE1NzczOTkxNTc2MDItYmE5MGYxNGE6MDAwMDAwMDAwMDAwMDAwMDAwNDQ0fQ==",
|
|
3232
|
+
"places": [
|
|
3233
|
+
"UnitedStates",
|
|
3234
|
+
"Canada"
|
|
3235
|
+
]
|
|
3236
|
+
}
|
|
3237
|
+
},
|
|
3238
|
+
"updateDeltaTokenSuccess": {
|
|
3239
|
+
"value": {
|
|
3240
|
+
"deltaToken": "e3NoYXJkSWQtMDAwMDAwMDE1NzczOTkxNTc2MDItYmE5MGYxNGE6MDAwMDAwMDAwMDAwMDAwMDAwNDQ0fQ==",
|
|
3241
|
+
"places": [
|
|
3242
|
+
"UnitedStates",
|
|
3243
|
+
"Canada"
|
|
3244
|
+
]
|
|
3245
|
+
}
|
|
3246
|
+
},
|
|
3247
|
+
"DeltaToken400": {
|
|
3248
|
+
"value": {
|
|
3249
|
+
"type": "about:blank",
|
|
3250
|
+
"errorCode": "InvalidRequestParameter",
|
|
3251
|
+
"message": "The delta token provided is invalid."
|
|
3252
|
+
}
|
|
3253
|
+
},
|
|
3254
|
+
"TenantNotProvisioned403": {
|
|
3255
|
+
"value": {
|
|
3256
|
+
"type": "about:blank",
|
|
3257
|
+
"errorCode": "TenantNotProvisioned",
|
|
3258
|
+
"message": "The client is not correctly configured to access the system."
|
|
3259
|
+
}
|
|
3260
|
+
},
|
|
3261
|
+
"DeltaToken410": {
|
|
3262
|
+
"value": {
|
|
3263
|
+
"type": "about:blank",
|
|
3264
|
+
"errorCode": "ExpiredDeltaLink",
|
|
3265
|
+
"message": "The delta token provided has expired."
|
|
3266
|
+
}
|
|
3267
|
+
},
|
|
3268
|
+
"BatchUpdateOneRecord": {
|
|
3269
|
+
"value": {
|
|
3270
|
+
"records": [
|
|
3271
|
+
{
|
|
3272
|
+
"location": "warehouse5",
|
|
3273
|
+
"sku": "sku123",
|
|
3274
|
+
"id": "82251928-8863-488e-840b-2aebd10b57ba",
|
|
3275
|
+
"onHand": 1200.35,
|
|
3276
|
+
"safetyStockCount": 12.45,
|
|
3277
|
+
"effectiveDate": "2025-05-19T21:13:00Z",
|
|
3278
|
+
"futureStock": [
|
|
3279
|
+
{
|
|
3280
|
+
"expectedDate": "2025-05-31T21:13:00Z",
|
|
3281
|
+
"quantity": 10.25
|
|
3282
|
+
}
|
|
3283
|
+
],
|
|
3284
|
+
"attributeSet": {
|
|
3285
|
+
"groupEligibilityExclusion": [
|
|
3286
|
+
"GroupA"
|
|
3287
|
+
]
|
|
3288
|
+
},
|
|
3289
|
+
"externalRefId": "7282822-9823-aaa"
|
|
3290
|
+
}
|
|
3291
|
+
]
|
|
3292
|
+
}
|
|
3293
|
+
},
|
|
3294
|
+
"BatchInventoryUpdate200": {
|
|
3295
|
+
"value": {
|
|
3296
|
+
"errors": [
|
|
3297
|
+
{
|
|
3298
|
+
"details": {
|
|
3299
|
+
"locationId": "warehouse5",
|
|
3300
|
+
"sku": "sku123",
|
|
3301
|
+
"id": "82251928-8863-488e-840b-2aebd10b57ba",
|
|
3302
|
+
"externalRefId": "7282822-9823-aaa"
|
|
3303
|
+
},
|
|
3304
|
+
"message": "Inventory record update failed",
|
|
3305
|
+
"errorCode": "InvalidRequest"
|
|
3306
|
+
}
|
|
3307
|
+
]
|
|
3308
|
+
}
|
|
3309
|
+
},
|
|
3310
|
+
"InvalidCharacterSku": {
|
|
3311
|
+
"value": {
|
|
3312
|
+
"type": "about:blank",
|
|
3313
|
+
"errorCode": "InvalidRequestParameter",
|
|
3314
|
+
"message": "Invalid characters in sku: bad$sku",
|
|
3315
|
+
"parameterName": "sku"
|
|
3316
|
+
}
|
|
3317
|
+
},
|
|
3318
|
+
"BatchInventoryPatchRequest": {
|
|
3319
|
+
"value": {
|
|
3320
|
+
"records": [
|
|
3321
|
+
{
|
|
3322
|
+
"id": "82251928-8863-488e-840b-2aebd10b57ba",
|
|
3323
|
+
"externalRefId": "7282822-9823-aaa",
|
|
3324
|
+
"location": "warehouse5",
|
|
3325
|
+
"sku": "sku123",
|
|
3326
|
+
"onHand": 1200.35,
|
|
3327
|
+
"safetyStockCount": 12.45,
|
|
3328
|
+
"effectiveDate": "2025-05-19T21:13:00Z",
|
|
3329
|
+
"futureStock": [
|
|
3330
|
+
{
|
|
3331
|
+
"expectedDate": "2025-05-31T21:13:00Z",
|
|
3332
|
+
"quantity": 10.25
|
|
3333
|
+
}
|
|
3334
|
+
],
|
|
3335
|
+
"attributeSet": {
|
|
3336
|
+
"groupEligibilityExclusion": [
|
|
3337
|
+
"arizona",
|
|
3338
|
+
"utah"
|
|
3339
|
+
]
|
|
3340
|
+
}
|
|
3341
|
+
},
|
|
3342
|
+
{
|
|
3343
|
+
"id": "82251928-8863-488e-840b-2aebd10b6666",
|
|
3344
|
+
"externalRefId": "7282822-9823-bbb",
|
|
3345
|
+
"location": "warehouse6",
|
|
3346
|
+
"sku": "sku456",
|
|
3347
|
+
"onHand": 500.75,
|
|
3348
|
+
"safetyStockCount": 25,
|
|
3349
|
+
"effectiveDate": "2025-05-19T21:13:00Z",
|
|
3350
|
+
"futureStock": [
|
|
3351
|
+
{
|
|
3352
|
+
"expectedDate": "2025-06-15T21:13:00Z",
|
|
3353
|
+
"quantity": 50
|
|
3354
|
+
}
|
|
3355
|
+
],
|
|
3356
|
+
"attributeSet": {
|
|
3357
|
+
"groupEligibilityExclusion": [
|
|
3358
|
+
"california"
|
|
3359
|
+
]
|
|
3360
|
+
}
|
|
3361
|
+
}
|
|
3362
|
+
]
|
|
3363
|
+
}
|
|
3364
|
+
},
|
|
3365
|
+
"BatchInventoryPatch200": {
|
|
3366
|
+
"value": {
|
|
3367
|
+
"errors": [
|
|
3368
|
+
{
|
|
3369
|
+
"details": {
|
|
3370
|
+
"locationId": "warehouse5",
|
|
3371
|
+
"sku": "sku123",
|
|
3372
|
+
"id": "82251928-8863-488e-840b-2aebd10b57ba",
|
|
3373
|
+
"externalRefId": "7282822-9823-aaa"
|
|
3374
|
+
},
|
|
3375
|
+
"message": "Inventory record update failed",
|
|
3376
|
+
"errorCode": "InventoryReset"
|
|
3377
|
+
},
|
|
3378
|
+
{
|
|
3379
|
+
"details": {
|
|
3380
|
+
"locationId": "warehouse6",
|
|
3381
|
+
"sku": "sku456",
|
|
3382
|
+
"id": "82251928-8863-488e-840b-2aebd10b6666",
|
|
3383
|
+
"externalRefId": "7282822-9823-bbb"
|
|
3384
|
+
},
|
|
3385
|
+
"message": "Location not found",
|
|
3386
|
+
"errorCode": "EntityNotFound"
|
|
3387
|
+
}
|
|
3388
|
+
]
|
|
3389
|
+
}
|
|
3390
|
+
},
|
|
3391
|
+
"BatchInventoryPatch400": {
|
|
3392
|
+
"value": {
|
|
3393
|
+
"type": "about:blank",
|
|
3394
|
+
"errorCode": "InvalidRequestParameter",
|
|
3395
|
+
"message": "An invalid request parameter was provided.",
|
|
3396
|
+
"parameterName": "location"
|
|
3397
|
+
}
|
|
3398
|
+
},
|
|
3399
|
+
"getAvailabilityDeltaRequest": {
|
|
3400
|
+
"value": {
|
|
3401
|
+
"deltaToken": "e3NoYXJkSWQtMDAwMDAwMDE1NzczOTkxNTc2MDItYmE5MGYxNGE6MDAwMDAwMDAwMDAwMDAwMDAwNDQ0fQ=="
|
|
3402
|
+
}
|
|
3403
|
+
},
|
|
3404
|
+
"getAvailabilityDeltas200": {
|
|
3405
|
+
"value": {
|
|
3406
|
+
"nextDeltaToken": "e3NoYXJkSWQtMDAwMDAwMDE1NzczOTkxNTc2MDItYmE5MGYxNGE6MDAwMDAwMDAwMDAwMDAwMDAwNDQ0fQ==",
|
|
3407
|
+
"shouldQueryAgain": true,
|
|
3408
|
+
"records": [
|
|
3409
|
+
{
|
|
3410
|
+
"sku": "sku123",
|
|
3411
|
+
"deltaType": "Change",
|
|
3412
|
+
"id": "UnitedStates",
|
|
3413
|
+
"effectiveDate": "2019-07-24T21:13:00Z",
|
|
3414
|
+
"sequenceNumber": 123,
|
|
3415
|
+
"onHand": 1200.35,
|
|
3416
|
+
"atf": 1137.65,
|
|
3417
|
+
"ato": 1147.9,
|
|
3418
|
+
"reserved": 50.25,
|
|
3419
|
+
"safetyStockCount": 12.45,
|
|
3420
|
+
"futures": [
|
|
3421
|
+
{
|
|
3422
|
+
"expectedDate": "2019-07-24T21:13:00Z",
|
|
3423
|
+
"quantity": 10.25
|
|
3424
|
+
}
|
|
3425
|
+
]
|
|
3426
|
+
}
|
|
3427
|
+
]
|
|
3428
|
+
}
|
|
3429
|
+
},
|
|
3430
|
+
"GetAvailabilityDeltas400": {
|
|
3431
|
+
"value": {
|
|
3432
|
+
"type": "about:blank",
|
|
3433
|
+
"errorCode": "ExpiredDeltaLink",
|
|
3434
|
+
"message": "'id' The Delta Link is expired",
|
|
3435
|
+
"parameterName": "Delta Link"
|
|
3436
|
+
}
|
|
3437
|
+
},
|
|
3438
|
+
"GetAvailabilityDeltas410": {
|
|
3439
|
+
"value": {
|
|
3440
|
+
"type": "about:blank",
|
|
3441
|
+
"errorCode": "ExpiredDeltaLink",
|
|
3442
|
+
"message": "The delta token provided has expired."
|
|
3443
|
+
}
|
|
3444
|
+
},
|
|
3445
|
+
"GetATSAllLocations": {
|
|
3446
|
+
"value": {
|
|
3447
|
+
"sku": "sku123",
|
|
3448
|
+
"group": "Canada"
|
|
3449
|
+
}
|
|
3450
|
+
},
|
|
3451
|
+
"GetATSAllUnassignedLocations": {
|
|
3452
|
+
"value": {
|
|
3453
|
+
"sku": "sku123"
|
|
3454
|
+
}
|
|
3455
|
+
},
|
|
3456
|
+
"GetATSLocationsAndGroups": {
|
|
3457
|
+
"value": {
|
|
3458
|
+
"skus": [
|
|
3459
|
+
"sku123"
|
|
3460
|
+
],
|
|
3461
|
+
"locations": [
|
|
3462
|
+
"warehouse5"
|
|
3463
|
+
],
|
|
3464
|
+
"groups": [
|
|
3465
|
+
"UnitedStates"
|
|
3466
|
+
]
|
|
3467
|
+
}
|
|
3468
|
+
},
|
|
3469
|
+
"GetAllLocationsAndGroupsResponse": {
|
|
3470
|
+
"value": {
|
|
3471
|
+
"locations": [
|
|
3472
|
+
{
|
|
3473
|
+
"id": "warehouse5",
|
|
3474
|
+
"records": [
|
|
3475
|
+
{
|
|
3476
|
+
"sku": "sku123",
|
|
3477
|
+
"atf": 1137.65,
|
|
3478
|
+
"ato": 1147.9,
|
|
3479
|
+
"onHand": 0,
|
|
3480
|
+
"reserved": 12.5,
|
|
3481
|
+
"safetyStockCount": 0,
|
|
3482
|
+
"effectiveDate": "2019-07-24T21:13:00Z",
|
|
3483
|
+
"futures": [
|
|
3484
|
+
{
|
|
3485
|
+
"expectedDate": "2019-08-24T21:13:00Z",
|
|
3486
|
+
"quantity": 10.25
|
|
3487
|
+
}
|
|
3488
|
+
],
|
|
3489
|
+
"attributeSet": {
|
|
3490
|
+
"groupEligibilityExclusion": [
|
|
3491
|
+
"arizona",
|
|
3492
|
+
"utah"
|
|
3493
|
+
]
|
|
3494
|
+
},
|
|
3495
|
+
"exists": true
|
|
3496
|
+
}
|
|
3497
|
+
]
|
|
3498
|
+
}
|
|
3499
|
+
],
|
|
3500
|
+
"groups": [
|
|
3501
|
+
{
|
|
3502
|
+
"id": "UnitedStates",
|
|
3503
|
+
"records": [
|
|
3504
|
+
{
|
|
3505
|
+
"sku": "sku123",
|
|
3506
|
+
"atf": 1137.65,
|
|
3507
|
+
"ato": 1147.9,
|
|
3508
|
+
"onHand": 0,
|
|
3509
|
+
"reserved": 12.5,
|
|
3510
|
+
"safetyStockCount": 0,
|
|
3511
|
+
"effectiveDate": "2019-07-24T21:13:00Z",
|
|
3512
|
+
"groupReserved": 10,
|
|
3513
|
+
"sharedGroupReserved": 2.5,
|
|
3514
|
+
"futures": [
|
|
3515
|
+
{
|
|
3516
|
+
"expectedDate": "2019-08-24T21:13:00Z",
|
|
3517
|
+
"quantity": 10.25
|
|
3518
|
+
}
|
|
3519
|
+
],
|
|
3520
|
+
"exists": true
|
|
3521
|
+
}
|
|
3522
|
+
]
|
|
3523
|
+
}
|
|
3524
|
+
]
|
|
3525
|
+
}
|
|
3526
|
+
},
|
|
3527
|
+
"GetAllLocationsResponse": {
|
|
3528
|
+
"value": {
|
|
3529
|
+
"locations": [
|
|
3530
|
+
{
|
|
3531
|
+
"id": "surprise",
|
|
3532
|
+
"records": [
|
|
3533
|
+
{
|
|
3534
|
+
"sku": "sku123",
|
|
3535
|
+
"atf": 17,
|
|
3536
|
+
"ato": 27.25,
|
|
3537
|
+
"reserved": 0,
|
|
3538
|
+
"safetyStockCount": 10,
|
|
3539
|
+
"effectiveDate": "2020-04-08T14:05:22.790896-07:00",
|
|
3540
|
+
"futures": [
|
|
3541
|
+
{
|
|
3542
|
+
"quantity": 10.25,
|
|
3543
|
+
"expectedDate": "2019-08-24T21:13:00Z"
|
|
3544
|
+
}
|
|
3545
|
+
],
|
|
3546
|
+
"attributeSet": {
|
|
3547
|
+
"groupEligibilityExclusion": [
|
|
3548
|
+
"arizona",
|
|
3549
|
+
"utah"
|
|
3550
|
+
]
|
|
3551
|
+
},
|
|
3552
|
+
"onHand": 27,
|
|
3553
|
+
"exists": true
|
|
3554
|
+
}
|
|
3555
|
+
]
|
|
3556
|
+
},
|
|
3557
|
+
{
|
|
3558
|
+
"id": "wickenburg",
|
|
3559
|
+
"records": [
|
|
3560
|
+
{
|
|
3561
|
+
"sku": "sku123",
|
|
3562
|
+
"atf": 30,
|
|
3563
|
+
"ato": 40.25,
|
|
3564
|
+
"reserved": 0,
|
|
3565
|
+
"safetyStockCount": 20,
|
|
3566
|
+
"effectiveDate": "2020-04-08T14:05:22.790896-07:00",
|
|
3567
|
+
"futures": [
|
|
3568
|
+
{
|
|
3569
|
+
"quantity": 10.25,
|
|
3570
|
+
"expectedDate": "2019-08-24T21:13:00Z"
|
|
3571
|
+
}
|
|
3572
|
+
],
|
|
3573
|
+
"attributeSet": {
|
|
3574
|
+
"groupEligibilityExclusion": [
|
|
3575
|
+
"arizona",
|
|
3576
|
+
"utah"
|
|
3577
|
+
]
|
|
3578
|
+
},
|
|
3579
|
+
"onHand": 50,
|
|
3580
|
+
"exists": true
|
|
3581
|
+
}
|
|
3582
|
+
]
|
|
3583
|
+
}
|
|
3584
|
+
],
|
|
3585
|
+
"groups": [
|
|
3586
|
+
{
|
|
3587
|
+
"id": "arizona",
|
|
3588
|
+
"records": [
|
|
3589
|
+
{
|
|
3590
|
+
"sku": "sku123",
|
|
3591
|
+
"atf": 47,
|
|
3592
|
+
"ato": 67.5,
|
|
3593
|
+
"reserved": 0,
|
|
3594
|
+
"safetyStockCount": 30,
|
|
3595
|
+
"groupReserved": 0,
|
|
3596
|
+
"sharedGroupReserved": 0,
|
|
3597
|
+
"effectiveDate": "2020-04-08T14:05:22.790896-07:00",
|
|
3598
|
+
"futures": [
|
|
3599
|
+
{
|
|
3600
|
+
"quantity": 20.5,
|
|
3601
|
+
"expectedDate": "2019-08-24T21:13:00Z"
|
|
3602
|
+
}
|
|
3603
|
+
],
|
|
3604
|
+
"onHand": 77,
|
|
3605
|
+
"exists": true
|
|
3606
|
+
}
|
|
3607
|
+
]
|
|
3608
|
+
}
|
|
3609
|
+
]
|
|
3610
|
+
}
|
|
3611
|
+
},
|
|
3612
|
+
"GetAllUnassignedLocationsResponse": {
|
|
3613
|
+
"value": {
|
|
3614
|
+
"locations": [
|
|
3615
|
+
{
|
|
3616
|
+
"id": "surprise",
|
|
3617
|
+
"records": [
|
|
3618
|
+
{
|
|
3619
|
+
"sku": "sku123",
|
|
3620
|
+
"atf": 17,
|
|
3621
|
+
"ato": 27.25,
|
|
3622
|
+
"reserved": 0,
|
|
3623
|
+
"safetyStockCount": 10,
|
|
3624
|
+
"effectiveDate": "2020-04-08T14:05:22.790896-07:00",
|
|
3625
|
+
"futures": [
|
|
3626
|
+
{
|
|
3627
|
+
"quantity": 10.25,
|
|
3628
|
+
"expectedDate": "2019-08-24T21:13:00Z"
|
|
3629
|
+
}
|
|
3630
|
+
],
|
|
3631
|
+
"attributeSet": {
|
|
3632
|
+
"groupEligibilityExclusion": [
|
|
3633
|
+
"GroupA",
|
|
3634
|
+
"GroupB"
|
|
3635
|
+
]
|
|
3636
|
+
},
|
|
3637
|
+
"onHand": 27,
|
|
3638
|
+
"exists": true
|
|
3639
|
+
}
|
|
3640
|
+
]
|
|
3641
|
+
},
|
|
3642
|
+
{
|
|
3643
|
+
"id": "wickenburg",
|
|
3644
|
+
"records": [
|
|
3645
|
+
{
|
|
3646
|
+
"sku": "sku123",
|
|
3647
|
+
"atf": 30,
|
|
3648
|
+
"ato": 40.25,
|
|
3649
|
+
"reserved": 0,
|
|
3650
|
+
"safetyStockCount": 20,
|
|
3651
|
+
"effectiveDate": "2020-04-08T14:05:22.790896-07:00",
|
|
3652
|
+
"futures": [
|
|
3653
|
+
{
|
|
3654
|
+
"quantity": 10.25,
|
|
3655
|
+
"expectedDate": "2019-08-24T21:13:00Z"
|
|
3656
|
+
}
|
|
3657
|
+
],
|
|
3658
|
+
"attributeSet": {
|
|
3659
|
+
"groupEligibilityExclusion": [
|
|
3660
|
+
"arizona",
|
|
3661
|
+
"utah"
|
|
3662
|
+
]
|
|
3663
|
+
},
|
|
3664
|
+
"onHand": 50,
|
|
3665
|
+
"exists": true
|
|
3666
|
+
}
|
|
3667
|
+
]
|
|
3668
|
+
}
|
|
3669
|
+
]
|
|
3670
|
+
}
|
|
3671
|
+
},
|
|
3672
|
+
"SkuAvailabilityByLocationAndOrGroup400": {
|
|
3673
|
+
"value": {
|
|
3674
|
+
"type": "about:blank",
|
|
3675
|
+
"errorCode": "LocationDoesNotExist",
|
|
3676
|
+
"message": "A location provided in the request does not exist."
|
|
3677
|
+
}
|
|
3678
|
+
},
|
|
3679
|
+
"ProductSegmentationAppendRequest": {
|
|
3680
|
+
"value": {
|
|
3681
|
+
"groups": [
|
|
3682
|
+
{
|
|
3683
|
+
"groupId": "GroupA",
|
|
3684
|
+
"mode": "APPEND",
|
|
3685
|
+
"skus": [
|
|
3686
|
+
"sku123",
|
|
3687
|
+
"sku456"
|
|
3688
|
+
]
|
|
3689
|
+
}
|
|
3690
|
+
]
|
|
3691
|
+
}
|
|
3692
|
+
},
|
|
3693
|
+
"ProductSegmentationDeleteRequest": {
|
|
3694
|
+
"value": {
|
|
3695
|
+
"groups": [
|
|
3696
|
+
{
|
|
3697
|
+
"groupId": "GroupA",
|
|
3698
|
+
"mode": "DELETE",
|
|
3699
|
+
"skus": [
|
|
3700
|
+
"sku123",
|
|
3701
|
+
"sku456"
|
|
3702
|
+
]
|
|
3703
|
+
}
|
|
3704
|
+
]
|
|
3705
|
+
}
|
|
3706
|
+
},
|
|
3707
|
+
"DeleteError": {
|
|
3708
|
+
"value": [
|
|
3709
|
+
{
|
|
3710
|
+
"error": "Failed to delete product segmentation for group id WarehouseOne and sku DeleteSku1"
|
|
3711
|
+
},
|
|
3712
|
+
{
|
|
3713
|
+
"error": "Failed to delete product segmentation for group id WarehouseOne and sku DeleteSku1"
|
|
3714
|
+
}
|
|
3715
|
+
]
|
|
3716
|
+
},
|
|
3717
|
+
"AppendError": {
|
|
3718
|
+
"value": [
|
|
3719
|
+
{
|
|
3720
|
+
"error": "Failed to create product segmentation for group id WarehouseOne and sku AppendNewSku1"
|
|
3721
|
+
},
|
|
3722
|
+
{
|
|
3723
|
+
"error": "to create product segmentation for group id WarehouseOne and sku AppendNewSku2"
|
|
3724
|
+
}
|
|
3725
|
+
]
|
|
3726
|
+
},
|
|
3727
|
+
"ErrorInvalidRequestParameterMode": {
|
|
3728
|
+
"value": {
|
|
3729
|
+
"type": "about:blank",
|
|
3730
|
+
"errorCode": "InvalidRequestParameter",
|
|
3731
|
+
"message": "An invalid request parameter was provided",
|
|
3732
|
+
"parameterName": "mode"
|
|
3733
|
+
}
|
|
3734
|
+
},
|
|
3735
|
+
"InventoryUpdatePutRequest": {
|
|
3736
|
+
"value": {
|
|
3737
|
+
"externalRefId": "7282822-9823-aaa",
|
|
3738
|
+
"onHand": 25,
|
|
3739
|
+
"safetyStockCount": 20,
|
|
3740
|
+
"effectiveDate": "2019-07-24T21:13:00Z",
|
|
3741
|
+
"futureStock": [
|
|
3742
|
+
{
|
|
3743
|
+
"expectedDate": "2019-07-24T21:13:00Z",
|
|
3744
|
+
"quantity": 10.25
|
|
3745
|
+
}
|
|
3746
|
+
],
|
|
3747
|
+
"attributeSet": {
|
|
3748
|
+
"groupEligibilityExclusion": [
|
|
3749
|
+
"GroupA"
|
|
3750
|
+
]
|
|
3751
|
+
}
|
|
3752
|
+
}
|
|
3753
|
+
},
|
|
3754
|
+
"ErrorEntityNotFound": {
|
|
3755
|
+
"value": {
|
|
3756
|
+
"type": "about:blank",
|
|
3757
|
+
"errorCode": "EntityNotFound",
|
|
3758
|
+
"message": "'EntityId' The provided entity is not found",
|
|
3759
|
+
"parameterName": "EntityId"
|
|
3760
|
+
}
|
|
3761
|
+
},
|
|
3762
|
+
"EntityNotFound": {
|
|
3763
|
+
"value": {
|
|
3764
|
+
"type": "about:blank",
|
|
3765
|
+
"errorCode": "EntityNotFound",
|
|
3766
|
+
"message": "An invalid entity was provided."
|
|
3767
|
+
}
|
|
3768
|
+
},
|
|
3769
|
+
"SKUNotFound": {
|
|
3770
|
+
"value": {
|
|
3771
|
+
"type": "about:blank",
|
|
3772
|
+
"errorCode": "EntityNotFound",
|
|
3773
|
+
"message": "The Location SKU provided was not found in the system."
|
|
3774
|
+
}
|
|
3775
|
+
},
|
|
3776
|
+
"ExportInProgress": {
|
|
3777
|
+
"value": {
|
|
3778
|
+
"type": "about:blank",
|
|
3779
|
+
"errorCode": "ExportInProcess",
|
|
3780
|
+
"message": "Export 1234-3456-45678-1234 is in progress."
|
|
3781
|
+
}
|
|
3782
|
+
},
|
|
3783
|
+
"InventoryUpdatePatchRequest": {
|
|
3784
|
+
"value": {
|
|
3785
|
+
"externalRefId": "7282822-9823-aaa",
|
|
3786
|
+
"onHand": 25
|
|
3787
|
+
}
|
|
3788
|
+
}
|
|
3789
|
+
},
|
|
2618
3790
|
"securitySchemes": {
|
|
2619
3791
|
"AmOAuth2": {
|
|
2620
3792
|
"type": "oauth2",
|
|
3793
|
+
"description": "AccountManager OAuth 2.0 bearer token Authentication.",
|
|
2621
3794
|
"flows": {
|
|
2622
3795
|
"clientCredentials": {
|
|
2623
3796
|
"tokenUrl": "https://account.demandware.com/dwsso/oauth2/access_token",
|