Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Newstore reservations API

Reservations

Newstore reservations API is one of 42 APIs that Newstore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include reservations. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 7 operations across 4 paths, and defines 18 schemas. It is described by OpenAPI 2.0, at version 1.0.

Requests are made against the base URL https://dodici-demo.p.newstore.net.

7 operations 4 paths 18 schemas 3 GET3 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
1.0
Base URL
https://dodici-demo.p.newstore.net
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Newstore reservations API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth) using the application flow, exposing 29 scopes.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 3 GET, 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

reservations 7

Reservations

GET
/inventory/config/reservations
showReservationConfig
showReservationConfig → default200400429500502503
PATCH
/inventory/config/reservations
updateReservationConfig
updateReservationConfig 2 params → default204400429500502503
GET
/inventory/reservations
listReservations
listReservations 11 params → default200400429500502503
POST
/inventory/reservations
createReservation
createReservation 3 params → default201400429500502503
GET
/inventory/reservations/{reservation_id}
showReservation
showReservation 2 params → default200400429500502503
PATCH
/inventory/reservations/{reservation_id}
updateReservation
updateReservation 3 params → default204400404409429500502
PATCH
/inventory/reservations/{reservation_id}/items
updateReservationItems
updateReservationItems 3 params → default204400404409429500502

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are ReservationSummaryResponseV1 (10 properties), ReservationDetailsResponseV1 (10 properties), Problem (9 properties), CreateReservationRequestV1 (6 properties). Each schema is shown below with its type and property counts.

ReservationItemStatus
string
The status of a reservation item.
UpdatedReservationStatus
string
ReservationSummaryResponseV1
object
10 properties 10 required
Problem
object
9 properties
ReservationConfigUpdate
object
3 properties
ReservationsPaginationInfo
object
4 properties 1 required
ReservationDetailsResponseV1
object
10 properties 10 required
ListReservationsResponseV1
object
2 properties 2 required
ReservationStatus
string
The status of a reservation.
InitialReservationStatus
string
Initial status of the reservation. If PENDING then the reservation will need to be confirmed by a store associate before the stock is reserved.
UpdatedItemStatus
string
ReservationConfigResponse
object
3 properties 3 required
ReservationItemDetailsResponse
object
5 properties 4 required
ReservationItemRequest
object
1 property 1 required
ReservationItemUpdate
object
3 properties 2 required
CreateReservationRequestV1
object
6 properties 3 required
ReservationUpdate
object
1 property 1 required
ReservationItemSummaryResponse
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

newstore-reservations-api-openapi.yml Raw ↑

Other APIs Newstore publishes across the network.

Newstore address API
Newstore audit-events API
Newstore cart API
Newstore cashboxes API
Newstore customer-configuration API
Newstore customer-profile API
Newstore customerProfile API
Newstore data API
Newstore EasypostAdapterConfig API
Newstore external-public API
Newstore fulfillment-requests API
Newstore identity-providers API