NewStore Integration APIs

https://docs.newstore.net/api/integration/
Admin
NewStore Integration APIs enable developers to integrate the NewStore omnichannel commerce platform...
Tokens:309,575
Snippets:1,511
Trust Score:6.2
Update:4 months ago
Show doc for...
Tokens:
Raw
### Get Configuration Response Sample

Source: https://docs.newstore.net/api/integration/discounts-promos/promotions_integration_configurations_api

Example of a successful response when retrieving integration configurations.

```json
{
  "session_update_url": "http://abc.cloudhub.io/promotion/cart-session/{customerSessionId}"
}
```

--------------------------------

### Get Configuration Response Sample

Source: https://docs.newstore.net/api/integration/inventory-management/inventory_manager_api

Example of a successful response when retrieving the complete inventory configuration for a retailer.

```json
{
  "allow_asn_overreceiving": false,
  "create_cycle_count_after_mispack": false,
  "create_cycle_count_after_mispick": false,
  "full_count_products_counted_before_trading": false

}
```

--------------------------------

### Get In-Store Pickup Config Response Sample

Source: https://docs.newstore.net/api/integration/store-fulfillment/in_store_pickup_api

Example response when retrieving the in-store pickup configuration for a specific store.

```json
{
  "delivery_time": "Available now",
  "delivery_time_if_not_available": "Pick up in 3-4 days",
  "cost": {
    "price": 10,
    "tax_code": "FR",
    "currency_code": "USD"
  }

}
```

--------------------------------

### Start Integration Response Sample

Source: https://docs.newstore.net/api/integration/eventstream-graphql/stream_webhook_sink_api

Sample JSON response when an integration is successfully started. Includes integration ID, status, and callback details.

```json
{
  "id": "webhook-integration-1",
  "status": "running",
  "callback_parameters": {
    "callback_url": "http://0.0.0.0:12345/eventSuccessful"
  },
  "integration_type": "permanent",
  "starts_at": "2019-07-07T00:00:00Z"
}
```

--------------------------------

### Start the integration

Source: https://docs.newstore.net/api/integration/eventstream-graphql/stream_webhook_sink_api

Starts the specified integration, enabling NewStore Omnichannel Cloud to emit events to the receiving URL. The integration status can be checked using the Get integration method.

```APIDOC
## POST /api/v1/org/integrations/eventstream/{integration_id}/_start

### Description
Starts the specified integration. NewStore Omnichannel Cloud starts emitting events to the receiving URL. You can check the status of the integration with the Get integration method.

**Note:** When an integration was stopped, it must be restarted within 30 days in order to receive all events which occurred while it was stopped. If the integration gets restarted more than 30 days after being stopped, it will only receive events which occurred after the point in time when it was restarted.

### Method
POST

### Endpoint
/api/v1/org/integrations/eventstream/{integration_id}/_start

### Parameters
#### Path Parameters
- **integration_id** (string) - Required - Unique identifier of the integration.

### Responses
#### Success Response (200)
The integration was started.

#### Error Response (404)
Integration with given ID was not found.

#### Error Response (500)
Internal server error.
```

--------------------------------

### Response Sample for GET /prices

Source: https://docs.newstore.net/api/integration/catalog-sfcc/consumer-api_api

This is a sample JSON response for the GET /prices endpoint, detailing product pricing information.

```json
{
  "items": [
    {
      "product_id": "string",
      "value": 0,
      "currency_code": "string",
      "traits": [
        "string"
]
}
]

}
```

--------------------------------

### Get Reason Codes Response Sample

Source: https://docs.newstore.net/api/integration/nom/nom_platform_reason_codes_api

Example of a successful response when retrieving reason codes by type and tenant.

```json
{
  "metadata": { },
  "reason_codes": [
    {
      "code": 0,
      "created_at": "string",
      "created_by": "string",
      "reason": {
        "en": "Too small",
        "de": "Zu klein"
},
      "updated_at": "string",
      "updated_by": "string"
}
]

}
```

--------------------------------

### Response Sample for GET /shops/{shop}

Source: https://docs.newstore.net/api/integration/catalog-sfcc/consumer-api_api

This is a sample JSON response for the GET /shops/{shop} endpoint, detailing a specific shop's information, including its locales and pricebooks.

```json
{
  "id": "string",
  "locales": [
    {
      "locale": "string",
      "display_name": "string",
      "is_master": true
}
],
  "pricebooks": [
    {
      "id": "string",
      "currency_code": "string"
}
]

}
```

--------------------------------

### Get Store Capacity Response Sample

Source: https://docs.newstore.net/api/integration/delivery/logistic_order-store_capacity-public_api

Example of a successful response (200 OK) when retrieving store capacity configuration. It returns the raw configuration object for store capacity.

```json
{
  "error": null,
  "config": {
    "DC01": {
      "limit": 25,
      "hours": {
        "monday": [
          8,
          20
        ],
        "tuesday": [
          8,
          20
        ],
        "wednesday": [
          8,
          20
        ],
        "thursday": [
          8,
          20
        ],
        "friday": [
          8,
          20
        ],
        "saturday": null,
        "sunday": null
      }
    }
  }
}

```

--------------------------------

### Response Sample for GET /shops

Source: https://docs.newstore.net/api/integration/catalog-sfcc/consumer-api_api

This is a sample JSON response for the GET /shops endpoint, detailing all configured shops and their associated locales and pricebooks.

```json
[
  {
    "id": "string",
    "locales": [
      {
        "locale": "string",
        "display_name": "string",
        "is_master": true
}
],
    "pricebooks": [
      {
        "id": "string",
        "currency_code": "string"
}
]
}

]
```

--------------------------------

### Get Template Documentation Response Sample

Source: https://docs.newstore.net/api/integration/nom/nom_platform_templates_api

This is a sample response for a validation error when attempting to get template documentation.

```json
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]

}
```

--------------------------------

### Response Sample for Starting an Import Job

Source: https://docs.newstore.net/api/integration/catalog-sfcc/import-api_api

This JSON structure represents a successful response after submitting a request to start an import job. It includes detailed information about the job, such as its ID, state, and source.

```json
{
  "import_id": "string",
  "source": "string",
  "provider": "string",
  "entities": [
    "products"
],
  "source_uri": "string",
  "transformed_uri": "string",
  "revision": 0,
  "name": "string",
  "received_at": "2019-08-24T14:15:22Z",
  "completed_at": "2019-08-24T14:15:22Z",
  "state": "received",
  "reason": "string",
  "full": false,
  "shop": "string",
  "locale": "string",
  "availabilities_store_ids": [
    "string"
],
  "version": 0,
  "all_import_requests_published": true,
  "cleaned_entities": [
    "string"
]

}
```

--------------------------------

### Get Promotion Example

Source: https://docs.newstore.net/api/integration/discounts-promos/promotions_api

Retrieves a specific automatic promotion by its ID. This example shows a CartLevelPercentage promotion response.

```json
{
  "links": {
    "self": "/promotion/64357c41-cad8-4000-8000-d998be563098"
  },
  "promotion": {
    "id": "64357c41-cad8-4000-8000-d998be563098",
    "name": "Black Friday Promo",
    "description": "Black Friday Promo",
    "validFrom": "2023-11-01T00:00:00",
    "validTo": "2023-12-01T00:00:00",
    "category": {
      "kind": "CartLevelPercentage",
      "discount": 10
    },
    "active": true,
    "createdAt": "2023-04-11T00:00:00",
    "createdBy": "25dd570161b05f0cae353a56757f8495",
    "updatedAt": "2023-04-11T00:00:00",
    "updatedBy": "25dd570161b05f0cae353a56757f8495",
    "tenant": "dodici",
    "currencies": [
      {
        "code": "EUR",
        "minimumCartValue": 50
      }
    ],
    "stores": [
      "f9c7b6ec-b296-4eba-b083-c8b53d14407d"
    ],
    "localizedTimezone": true,
    "exclusive": true,
    "segment": {
      "key": "type",
      "value": "gold member",
      "schema": 1
    },
    "version": "a43a5a2d-1424-4c80-a252-992d489062eb"
}

}
```

--------------------------------

### Example URL with Pagination Parameters

Source: https://docs.newstore.net/api/integration/consumer-app/BridgeAPI

Shows how to use cursor and size parameters for paginating results, such as customer orders.

```url
GET /customers/orders?cursor=0&size=10
```

```url
GET /customers/orders?cursor=10&size=10
```

--------------------------------

### Get Last Safety Stock Update Status Example

Source: https://docs.newstore.net/api/integration/order-management/stock_api_v1

Retrieves the status of the last safety stock update. This example shows a JSON response indicating the status is 'in_progress'.

```json
{
  "status": "in_progress"
}
```

--------------------------------

### Get Safety Stock CSV Example

Source: https://docs.newstore.net/api/integration/order-management/stock_api_v1

Retrieves a CSV file containing safety stock for all products across all fulfillment locations. This example shows the expected CSV format.

```csv
Product ID,Location,Safety Stock
,US01,200
,US02,200
10000101,US01,20
10000101,US02,20
"10000101,12",US02,20

```

--------------------------------

### Example URL with Localization Parameters

Source: https://docs.newstore.net/api/integration/consumer-app/BridgeAPI

Demonstrates how locale and currency parameters are passed in a URL for localized content.

```url
/categories/tree?locale=nl-NL&currency=EUR
```

--------------------------------

### Price Response Sample

Source: https://docs.newstore.net/api/integration/catalog-sfcc/customer-app-api_api

Example JSON response for product prices, including currency and a list of product prices.

```json
{
  "pricebook_id": "default",
  "currency": "USD",
  "traits": [
    "display_only"
],
  "elements": [
    {
      "product_id": "1000101",
      "amount": 1500
},
    {
      "product_id": "1000102",
      "amount": 1000
},
    {
      "product_id": "1000103",
      "amount": 300
}
]

}
```

--------------------------------

### List Catalog Import Configurations Response Sample (200)

Source: https://docs.newstore.net/api/integration/catalog-sfcc/sfcc-catalog-locale-manager_api

Sample JSON response when successfully listing all catalog import configurations for a tenant.

```json
[
  {
    "catalog_name": "brd-products-newstore",
    "import_configuration": [
      "string"
    ]
  }

]
```

--------------------------------

### Get Routing Rules Section Response

Source: https://docs.newstore.net/api/integration/delivery/fulfillment_config_routing_ruleset_api

Example response for retrieving a section of the routing rules. This specific example shows the 'zip_code_regions' section with various regions and their associated zip codes.

```json
{
  "zip_code_regions": {
    "West": [
      "90210",
      "90211",
      "90212",
      "90213"
],
    "East": [
      "10001",
      "10002",
      "10003",
      "10004",
      "10005"
],
    "South": [
      "33101",
      "33102",
      "33103",
      "33104",
      "33105",
      "33106"
]
}

}
```

--------------------------------

### Start global ATP export

Source: https://docs.newstore.net/api/integration/order-management/availability_export_api

Starts an export of the ATP quantities in all fulfillment locations. The exported ATP can be retrieved using the Get ATP for channel method. Requires `newStoreAccessToken` authorization.

```APIDOC
## Start global ATP export

### Description
Starts an export of the ATP quantities in all fulfillment locations.

### Method
POST

### Endpoint
/v0/d/availabilities/bulk

### Authorizations
_newStoreAccessToken_

### Request Body
#### Request Body schema: application/json
- **last_updated_at** (integer or null) - Optional - A full availability export is performed when this value is not provided. When this value is provided, the export will not contain availabilities that were updated before the provided value. You can use the value of the 'last_updated_at' property of the response provided by the /availabilities/bulk GET method.

### Request Example
```json
{
  "last_updated_at": 59837741
}
```

### Responses
#### Success Response (201)
Success. The response contains the identifier of the created bulk export job.
- **availability_export_id** (string) - The identifier of the created bulk export job.

#### Response Example
```json
{
  "availability_export_id": "34vj3g4i325k23hkrnekrnkq"
}
```

#### Error Responses
- **400**: The body of request is invalid.
- **500**: An error occurred on the server.
- **default**: Unexpected Error
```

--------------------------------

### Start ATP export for channel

Source: https://docs.newstore.net/api/integration/order-management/availability_export_api

Starts an export job of the ATP for a specific group of fulfillment locations. The exported ATP can be retrieved using the Get ATP for channel method. Requires `newStoreAccessToken` authorization.

```APIDOC
## Start ATP export for channel

### Description
Starts an export job of the ATP, for a group of fulfillment locations. To retrieve the exported ATP, use the Get ATP for channel method.

### Method
POST

### Endpoint
/v0/d/availabilities/bulk/{group_name_or_availability_export_id}

### Authorizations
_newStoreAccessToken_

### Path Parameters
- **group_name_or_availability_export_id** (string) - Required - The identifier for the fulfillment location group for which you want to start an ATP export. See Create a fulfillment location group.

### Request Body
#### Request Body schema: application/json
- **last_updated_at** (integer or null) - Optional - A full availability export is performed when this value is not provided. When this value is provided, the export will not contain availabilities that were updated before the provided value. You can use the value of the 'last_updated_at' property of the response provided by the /availabilities/bulk GET method.

### Request Example
```json
{
  "last_updated_at": 59837741
}
```

### Responses
#### Success Response (201)
Success. The response contains the `availability_export_id` for the created bulk export job.
- **availability_export_id** (string) - The identifier for the created bulk export job.

#### Response Example
```json
{
  "availability_export_id": "34vj3g4i325k23hkrnekrnkq"
}
```

#### Error Responses
- **400**: The request body is invalid.
- **404**: The requested group in {group_name} was not found.
- **500**: An error occurred on the server.
- **default**: Unexpected Error
```

--------------------------------

### Full Product Details Response Sample

Source: https://docs.newstore.net/api/integration/consumer-app/BridgeAPI

This sample shows the full details of a product, including media, pricing, labels, and additional attributes. It is returned when the 'full_details' query parameter is true.

```json
{
  "results": [
    {
      "type": "string",
      "id": "1234",
      "sku": "CF-1234",
      "name": "Polo",
      "caption": "Summer collection",
      "description": "string",
      "specification": "string",
      "stock_notifications_enabled": true,
      "store_availability_enabled": true,
      "available": true,
      "size_chart_url": "http://example.com",
      "web_url": "http://example.com",
      "media": [
        {
          "url": "https://merchant.com/images/blue-shirt.jpg"
}
],
      "pricing": {
        "effective": 45,
        "original": 109.99,
        "custom": {
          "member_effective": 45,
          "member_original": 89.99
}
},
      "labels": [
        {
          "id": "new",
          "display_text": "Nieuw!"
}
],
      "additional_attributes": [
        {
          "id": "brand",
          "name": "Merk",
          "value": "Highstreet"
}
],
      "swatches": {
        "attribute_id": "style",
        "values": [
          {
            "image": "https://img1.g-star.com/image/private/c_fill,f_auto,h_24,q_80/v1622042603/D20145-C072-996-M07.jpg"
}
]
}
}
]

}
```

--------------------------------

### Get Cash Drawer Response Payload

Source: https://docs.newstore.net/api/integration/payments/cash_drawer_bff

Example JSON response when successfully retrieving cash drawer configuration.

```json
{
  "cash_drawer_id": "de70517a",
  "name": "Kesha",
  "currency": "USD",
  "float": 200,
  "status": "active",
  "type": "integrated"
}
```

--------------------------------

### List Payment Options Response Sample

Source: https://docs.newstore.net/api/integration/payments/payment_options_api

Example JSON response for listing payment options and their configurations for a store. Includes details for gift card, Adyen terminal, and non-integrated payment methods.

```json
{
  "gift_card": {
    "cash_out_enabled": true
  },
  "adyen_terminal": {
    "merchant_account": "Example_POS",
    "company_account": "NewStore",
    "username": "ws_21132@Company.Example",
    "password": "*******",
    "terminal_api_url": "https://terminal-api-test.adyen.com",
    "store_id": "1201"
  },
  "non_integrated": {
    "custom_payment_method": {
      "label": "My Payment Method"
    }
  }
}
```

--------------------------------

### Get Reason Code Response Sample

Source: https://docs.newstore.net/api/integration/discounts-promos/reason-codes-promotions-api

Example of a successful response when retrieving a specific reason code. It includes the code and its localizations.

```json
{
  "localizations": [
    {
      "name": "defect",
      "locale": "en-us"
}
],
  "code": "string"

}
```

--------------------------------

### Example Product Search Query

Source: https://docs.newstore.net/api/integration/consumer-app/BridgeAPI

Demonstrates how to search for 'Polo shirt' within the 'men' category, with a price range between €25 and €75.

```HTTP
GET /product_search?q=Polo+shirt&cat=men&price:range=25,75
```

--------------------------------

### Create Store Response Sample

Source: https://docs.newstore.net/api/integration/inventory-management/store_api

This JSON response is returned after successfully creating a store. It includes all the details of the created store, along with system-generated fields like revision, updated_at, and created_at.

```json
{
  "label": "001_US_ABC_Street",
  "physical_address": {
    "address_line_1": "12 ABC Street",
    "city": "New York",
    "country_code": "US",
    "latitude": 40.7256956,
    "longitude": -74.0023217,
    "state": "NY",
    "zip_code": "10001"
  },
  "shipping_address": {
    "address_line_1": "12 ABC Street",
    "city": "New York",
    "country_code": "US",
    "state": "NY",
    "zip_code": "10002"
  },
  "division_name": "US",
  "manager_id": "466ba016-42d4-47cb-a953-0b808c949b64",
  "image_url": "www.image-url.com",
  "phone_number": "202-555-0138",
  "active_status": true,
  "supported_shipping_methods": [
    "in_store_pick_up"
  ],
  "gift_wrapping": false,
  "pricebook": "dodici-ca",
  "delivery_zip_codes": [
    "10001",
    "10002"
  ],
  "shipping_provider_info": { },
  "business_hours": [
    {
      "from_time": "09:00",
      "to_time": "21:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 0
    },
    {
      "from_time": "09:00",
      "to_time": "20:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 1
    },
    {
      "from_time": "09:00",
      "to_time": "20:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 2
    },
    {
      "from_time": "09:00",
      "to_time": "20:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 3
    },
    {
      "from_time": "09:00",
      "to_time": "20:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 4
    },
    {
      "from_time": "09:00",
      "to_time": "20:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 5
    },
    {
      "from_time": "09:00",
      "to_time": "20:00",
      "earliest_pick_up": "10:00",
      "latest_pick_up": "20:00",
      "weekday": 6
}
  ],
  "timezone": "America/New_York",
  "tax_id": null,
  "tax_included": true,
  "catalog": "storefront-catalog-en",
  "locale": "en-US",
  "store_id": "050_Mc_Avenue",
  "display_price_unit_type": "gross",
  "revision": 1,
  "updated_at": null,
  "created_at": null
}
```

--------------------------------

### Get Refund Request Details Response

Source: https://docs.newstore.net/api/integration/payments/refund_request_api_v1

Example response for retrieving the details of a specific refund request. This includes all information about the refund, its status, and associated items.

```json
{
  "refund": {
    "id": "28d07ccd-c609-46cf-bd52-c43ef70737d5",
    "revision": 1,
    "created_at": "2018-10-25T10:18:09.815041Z",
    "updated_at": "2018-10-25T10:18:09.815041Z",
    "order_id": "91207347-47b6-4b21-b736-5fe9ec82e9ea",
    "amount": 90.3,
    "currency": "USD",
    "value": 100,
    "type": "percentage",
    "reason_code": 2,
    "reason": "Item is damaged",
    "note": "The white shirt has yellow stains on it",
    "requested_at": "2018-10-25T10:18:09.783315Z",
    "user_id": "22IB3UROr1S3Je9hDaRh7f",
    "user_email": "johndoe@example.com",
    "status": "succeeded",
    "refund_level": "item_level",
    "is_historical": false,
    "metadata": {
      "extended_attributes": [
        {
          "name": "somekey1",
          "value": "somevalue1"
},
        {
          "name": "somekey2",
          "value": "somevalue2"
}
]
},
    "items": [
      {
        "type": "product",
        "id": "6f38b75f-3fb3-4454-975d-af0cb412f8fa",
        "refund": {
          "net": 60,
          "tax": 6.65,
          "gross": 66.65
}
},
      {
        "type": "shipping",
        "id": "2728c174-719d-47c3-bd5e-51ec470180fe",
        "refund": {
          "net": 22,
          "tax": 1.65,
          "gross": 23.65
}
}
]
}

}
```

--------------------------------

### Create Manifest Response Sample (200 OK)

Source: https://docs.newstore.net/api/integration/delivery/delivery_api

This is a sample successful response when a manifest is created. It includes the manifest ID, carrier details, and a document URL.

```json
{
  "manifest": {
    "id": "string",
    "carrier_id": "string",
    "carrier_code": "string",
    "document_url": "string"
  }
}
```

--------------------------------

### Get Address Response (200)

Source: https://docs.newstore.net/api/integration/customer/consumer_profile_api_v1

Example JSON response for retrieving a specific address by profile ID and address ID. The structure is similar to the create/update response.

```json
{
  "id": "NS-EU-01FXX4THCG41RFCXVEQGKD60Y4-01FXX4TTF7X8CF5JD60Y4-01FXX4TTF7X8CF5JR3B35TD70F",
  "full_name": "string",
  "company_name": "string",
  "address_line_1": "string",
  "address_line_2": "string",
  "zip_code": "string",
  "city": "string",
  "state": "string",
  "country_code": "string",
  "contact_phone": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"

}
```

--------------------------------

### Sorting Example

Source: https://docs.newstore.net/api/integration/consumer-app/BridgeAPI

Demonstrates how to sort search results by price in ascending order.

```HTTP
sort=price-low-to-high
```

--------------------------------

### Get Service Level by ID

Source: https://docs.newstore.net/api/integration/delivery/service_levels_api

This is an example of a successful response when retrieving a specific service level using its ID. It details the configuration for the '2_DAY' service level.

```json
{
  "2_DAY": {
    "currency_code": "USD",
    "delivery_time": "2-3 business days",
    "delivery_time_after_cutoff_hour": "",
    "display_name": "Standard",
    "price": 22,
    "remorse_period": 30,
    "tax_code": ""
  }
}
```

--------------------------------

### Example Order Response (201 Created)

Source: https://docs.newstore.net/api/integration/consumer-app/BridgeAPI

This is a sample JSON response for a successful order creation (HTTP 201). It includes details about the order, customer, items, addresses, payments, and totals.

```json
{
  "id": "PNZfEiFcNM",
  "number": "EU000027546",
  "customer_id": "1234-6789-1234-0986",
  "customer_email": "han@therepublic.com",
  "creation_date": "2018-08-17 14:53:00 UTC",
  "source": "app",
  "status": "created",
  "items": [
    {
      "product_id": "1234_001-M",
      "product_name": "Basic T-Shirt",
      "product_image": "https://images.com/basic-tshirt.jpg",
      "quantity": 2,
      "full_price": 19.99,
      "configuration": [
        {
          "name": "color",
          "value": "white"
},
        {
          "name": "size",
          "value": "M"
}
]
}
],
  "billing_address": {
    "first_name": "string",
    "last_name": "string",
    "company": "string",
    "street": "string",
    "house_number": "string",
    "addition": "string",
    "postal_code": "string",
    "city": "string",
    "state": "string",
    "country_id": "st",
    "telephone": "string",
    "custom": { },
    "id": "string"
},
  "payments": [
    {
      "amount": 19.99,
      "method_name": "iDeal (ING)",
      "status": "paid"
}
],
  "shipments": [
    {
      "address": {
        "first_name": "string",
        "last_name": "string",
        "company": "string",
        "street": "string",
        "house_number": "string",
        "addition": "string",
        "postal_code": "string",
        "city": "string",
        "state": "string",
        "country_id": "st",
        "telephone": "string",
        "custom": { },
        "id": "string"
},
      "method_name": "UPS Ground Shipping",
      "status": "shipped"
}
],
  "totals": {
    "discount": 20,
    "sub_total": 100,
    "tax": 0,
    "shipping_costs": 1.5,
    "payment_costs": 0,
    "grand_total": 81.5,
    "custom": {
      "colorado_sales_tax": 0.27
}
},
  "prices_include_tax": true,
  "currency_code": { },
  "tracking_url": "string"
}
```

--------------------------------

### Get Routing Rules Response Sample (200 OK)

Source: https://docs.newstore.net/api/integration/delivery/fulfillment_config_routing_ruleset_api

Example of a successful response when retrieving the current routing rules. This JSON structure defines routes, service level priorities, location groups, and zip code regions.

```json
{
  "routes": [
    {
      "fulfilled_by": {
        "2_DAY": [
          "2_DAY::WEST"
],
        "GROUND": [
          "GROUND::WEST"
]
},
      "destination_region": {
        "country": "US",
        "zip_code_region": "WEST"
}
}
],
  "sl_levels_priority": [
    "GROUND",
    "2_DAY"
],
  "location_groups": {
    "2_DAY::WEST": [
      "DC01",
      "US15",
      "US16"
],
    "GROUND::WEST": [
      "US01",
      "US02",
      "US03"
]
},
  "zip_code_regions": {
    "WEST": [
      "*"
]
}

}
```

--------------------------------

### Create or Overwrite Catalog Import Configuration Response Sample (200)

Source: https://docs.newstore.net/api/integration/catalog-sfcc/sfcc-catalog-locale-manager_api

Sample JSON response indicating successful storage of a catalog import configuration.

```json
{
  "message": "example message"

}
```

--------------------------------

### List Service Levels Response Sample

Source: https://docs.newstore.net/api/integration/delivery/service_levels_api

Example of a successful response when listing all service level configurations. This shows the structure of service level data including pricing and delivery times.

```json
{
  "2_DAY": {
    "currency_code": "USD",
    "delivery_time": "2-3 business days",
    "delivery_time_after_cutoff_hour": "",
    "display_name": "Standard",
    "price": 22,
    "remorse_period": 30,
    "tax_code": ""
},
  "GROUND": {
    "currency_code": "USD",
    "delivery_time": "3-7 business days",
    "delivery_time_after_cutoff_hour": "",
    "display_name": "Ground - 5 minute remorse period",
    "price": 5,
    "remorse_period": 350,
    "tax_code": ""
}

}
```

--------------------------------

### Response Sample for GET /locales

Source: https://docs.newstore.net/api/integration/catalog-sfcc/consumer-api_api

This is a sample JSON response for the GET /locales endpoint, listing available locales for a shop.

```json
{
  "locales": [
    "string"
]

}
```

--------------------------------

### Response Sample for Listing Printers (200 OK)

Source: https://docs.newstore.net/api/integration/inventory-management/store_api

Example JSON response containing a list of printers within a store.

```json
{
  "printers": [
    {
      "ipv4": "string",
      "ipv6": "string",
      "location": "string",
      "mac_address": "stringstringstrin",
      "manufacturer": "Virtual",
      "model": "string",
      "name": "string",
      "paper_size": "string",
      "printer_location_id": "stringstringstringstringstringstring",
      "store_id": "string",
      "type": "document_printer",
      "url": "string",
      "port": 0,
      "serial_number": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "revision": 0,
      "tenant": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "uuid": "stringstringstringstringstringstring"
    }
  ]
}
```

--------------------------------

### Show Import Schema Response (Empty)

Source: https://docs.newstore.net/api/integration/catalog-sfcc/catalog-import-schemas

Example response when retrieving an import schema. The content will be the schema definition itself.

```json
{ }
```

--------------------------------

### Get Catalog Import Configuration Response Sample (200)

Source: https://docs.newstore.net/api/integration/catalog-sfcc/sfcc-catalog-locale-manager_api

Sample JSON response for a single catalog import configuration.

```json
{
  "catalog_name": "brd-products-newstore",
  "import_configuration": [
    "string"
  ]

}
```

--------------------------------

### JSON Error Response Example

Source: https://docs.newstore.net/api/integration/payments/newstore_checkout_bff

Example of a 400 Bad Request JSON response indicating invalid payment wallet selection.

```json
{
  "request_id": "XXX-YYYY-ZZZZ-XYZ-XYZ",
  "messages": [
    "payment_wallet.payment_wallet: payment_wallet must be one of the following: APPLE_PAY, PAYPAL"
  ]

}
```

--------------------------------

### Get stock location

Source: https://docs.newstore.net/api/integration/inventory-management/stock_locations_api

Retrieves the details of a specific stock location by its name. Use this to get information about an existing stock location.

```APIDOC
## Get stock location

### Description
Retrieves the stock location with the specified name.

### Method
GET

### Endpoint
/v0/stock_locations/{name}

### Parameters
#### Path Parameters
- **name** (string) - Required - The name of the stock location. To retrieve the name, use the List stock locations method.

### Responses
#### Success Response (200)
Successful response.
- **display_name** (string) - The human readable display name of the stock location.
- **name** (string) - The unique name of the stock location.
- **salable** (boolean) - Indicates if the stock location is salable.

#### Error Response (404)
Stock location not found.

### Response Example
```json
{
  "display_name": "Main",
  "name": "main",
  "salable": true
}
```
```

--------------------------------

### Response Sample for GET /job_history

Source: https://docs.newstore.net/api/integration/catalog-sfcc/sfcc-integration_api

This is a sample JSON response for the GET /job_history endpoint, detailing job information and pagination links.

```JSON
{
  "jobs": {
    "uuid": "string",
    "entity": "catalog",
    "createdAt": "string",
    "status": "pending",
    "message": "string",
    "catalogImportId": "string",
    "metadata": {
      "job_id": "string",
      "execution_id": "string",
      "site_id": "string",
      "cartridge_version": "string"
    },
    "links": {
      "logs": "string",
      "input": "string",
      "output": "string",
      "details": "string"
  }
},
  "nextPage": "string"
}
```

--------------------------------

### Response Sample for GET /currencies

Source: https://docs.newstore.net/api/integration/catalog-sfcc/consumer-api_api

This is a sample JSON response for the GET /currencies endpoint, listing available currency codes for a shop.

```json
{
  "currency_codes": [
    "string"
]

}
```

--------------------------------

### Create or Overwrite Catalog Import Configuration Request Sample

Source: https://docs.newstore.net/api/integration/catalog-sfcc/sfcc-catalog-locale-manager_api

Sample JSON payload for creating or overwriting a catalog import configuration.

```json
[
  {
    "newstore_catalog_id": "storefront-catalog-en",
    "locale": "en-US",
    "is_master": true,
    "default_locale": "x-default",
    "master_catalog": "brd-products-newstore"
}

]
```
Tokens:
Raw