Newstore external-public API
The external-public API from Newstore — 89 operation(s) for external-public.
Newstore external-public API is one of 42 APIs that Newstore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include external-public. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 150 operations across 89 paths, and defines 323 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.
150 operations
89 paths
323 schemas
13 DELETE71 GET21 PATCH37 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Newstore external-public API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (oauth) using the application flow, exposing 29 scopes.
Paths & Operations 150
Across 89 paths, the API surfaces 150 operations — 13 DELETE, 71 GET, 21 PATCH, 37 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.
external-public 150
POST
/catalog/import-schemas
createImportSchema
DELETE
/catalog/import-schemas/{id}
destroyImportSchema
GET
/catalog/import-schemas/{id}
showImportSchema
PATCH
/catalog/import-schemas/{id}
updateImportSchema
GET
/catalog/exports/catalogs/{catalog}/pricebooks/{pricebook}
showPricebookExport
GET
/catalog/catalogs/{catalog}/offlineproducts
listProducts
POST
/checkout/carts
createCart
GET
/checkout/carts/{cartId}
showCart
PATCH
/checkout/carts/{cartId}
updateCart
POST
/checkout/carts/{cartId}/items
createLineItem
DELETE
/checkout/carts/{cartId}/items/{lineItemId}
destroyLineItem
PATCH
/checkout/carts/{cartId}/items/{lineItemId}
updateLineItem
POST
/checkout/carts/{cartId}/items/{lineItemId}/add-ons
createAddOnLineItem
GET
/clienteling/profiles
listProfiles
GET
/clienteling/profiles/{customer_id}
showProfile
POST
/customer/profiles/lookup-bulk-emails
createRetrievalBulkEmailProfiles
POST
/customer/data
createData
DELETE
/customer/data/{data_id}
destroyData
GET
/customer/data/{data_id}
showData
POST
/customer/tokens
createTokensOperations
GET
/customer/profiles
listProfiles
POST
/customer/profiles
createOrShowProfile
GET
/customer/profiles/{profile_id}
showProfile
PATCH
/customer/profiles/{profile_id}
updateProfile
POST
/customer/profiles/{profile_id}
createProfileDeletionRequest
GET
/customer/profiles/{profile_id}/addresses
listAddresses
POST
/customer/profiles/{profile_id}/addresses
createOrShowAddress
DELETE
/customer/profiles/{profile_id}/addresses/{address_id}
destroyAddress
GET
/customer/profiles/{profile_id}/addresses/{address_id}
showAddress
PATCH
/customer/profiles/{profile_id}/addresses/{address_id}
updateAddress
GET
/customer/config
showConfiguration
PATCH
/customer/config
updateConfiguration
GET
/stores
listStores
GET
/stores/{storeId}
showStore
PATCH
/stores/{storeId}
updateStore
GET
/stores/{storeId}/cashboxes
listCashboxes
POST
/stores/{storeId}/cashboxes
createCashbox
GET
/stores/{storeId}/cashboxes/{cashboxId}
showCashbox
POST
/stores/{storeId}/cashboxes/{cashboxId}/release
createCashboxRelease
GET
/orders/{orderId}
showOrder
GET
/orders/{orderId}/returns/{returnId}
showReturn
GET
/config
showTenantConfig
GET
/config/offline-mode
showTenantOfflineModeConfig
PATCH
/config/offline-mode
updateTenantOfflineModeConfig
DELETE
/fulfillment/adapters/config
destroyEasypostAdapterConfig
GET
/fulfillment/adapters/config
showEasypostAdapterConfig
PUT
/fulfillment/adapters/config
replaceEasypostAdapterConfig
GET
/fulfillment/configurations/shipments/{name}
showConfigurationByName
POST
/fulfillment/configurations/shipments/{name}
createConfigurationByName
GET
/fulfillment/configurations/shipments/checks
showConfigurationsChecks
GET
/fulfillment/provider-rate-priorities
showProviderRatePriorities
PUT
/fulfillment/provider-rate-priorities
replaceProviderRatePriorities
GET
/fulfillment/provider-rates
listProviderRates
DELETE
/fulfillment/provider-rates/{provider_rate_id}
destroyProviderRate
GET
/fulfillment/provider-rates/{provider_rate_id}
showProviderRate
PUT
/fulfillment/provider-rates/{provider_rate_id}
replaceProviderRate
GET
/fulfillment/shipping-audits
listShippingOptionAudits
GET
/fulfillment/shipping-audits/{audit_id}
showShippingOptionAudit
GET
/fulfillment/shipping-labels/{public_key}
showShippingLabel
GET
/fulfillment/package-types
listPackageTypes
POST
/fulfillment/package-types
createPackageType
DELETE
/fulfillment/package-types/{package_type_id}
destroyPackageType
GET
/fulfillment/package-types/{package_type_id}
showPackageType
PATCH
/fulfillment/package-types/{package_type_id}
updatePackageType
GET
/iam/providers
listProviders
POST
/iam/providers
createProvider
DELETE
/iam/providers/{alias}
destroyProvider
GET
/iam/providers/{alias}
showProvider
PATCH
/iam/providers/{alias}
updateProvider
GET
/iam/supported-providers
listSupportedProviders
GET
/iam/users
listUsers
POST
/iam/users
createUser
DELETE
/iam/users/{id}
destroyUser
GET
/iam/users/{id}
showUser
PUT
/iam/users/{id}
replaceUser
GET
/iam/permissions
listPermissions
GET
/iam/roles
listRoles
POST
/iam/roles
createRole
DELETE
/iam/roles/{id}
destroyRole
GET
/iam/roles/{id}
showRole
PUT
/iam/roles/{id}
replaceRole
GET
/iam/roles/{id}/users
listUsersByRole
GET
/inventory/config
showInventoryConfig
PUT
/inventory/config
replaceInventoryConfig
GET
/inventory/config/reservations
showReservationConfig
PATCH
/inventory/config/reservations
updateReservationConfig
GET
/inventory/reservations
listReservations
POST
/inventory/reservations
createReservation
GET
/inventory/reservations/{reservation_id}
showReservation
PATCH
/inventory/reservations/{reservation_id}
updateReservation
PATCH
/inventory/reservations/{reservation_id}/items
updateReservationItems
GET
/v0/orders
showOrderHistoryForCustomer
GET
/v0/orders/{id}
showSalesOrderByIdAndIdType
POST
/v0/orders/{id}/_extend_grace_period
createGracePeriod
GET
/v0/orders/{id}/cancel
showCancellationStatus
POST
/v0/orders/{id}/cancel
createCancellation
POST
/v0/orders/{id}/items/{item_uuid}/cancel
createLineItemCancellation
POST
/v0/orders/{id}/prices
createPriceInformationForItems
PATCH
/v0/orders/{id}/serial_numbers
updateSalesOrderSerialNumbers
GET
/v0/stock/insights
listAtpInsights
DELETE
/payment/providers/{newstore}/locations/{location}/mappings
destroyProviderLocationMapping
PUT
/payment/providers/{newstore}/locations/{location}/mappings
replaceProviderLocationMapping
GET
/payment/providers/{newstore}/locations/mappings
listProviderLocationMappings
GET
/promotions/configurations/{section-id}
showConfiguration
PATCH
/promotions/configurations/{section-id}
updateConfiguration
GET
/promotions/reason-codes
listReasonCodes
POST
/promotions/reason-codes
createReasonCode
DELETE
/promotions/reason-codes/{code}
destroyReasonCode
GET
/promotions/reason-codes/{code}
showReasonCode
PATCH
/promotions/reason-codes/{code}
updateReasonCode
GET
/v0/routing/ruleset
showRoutingRuleset
PATCH
/v0/routing/ruleset
updateRoutingRuleset
PUT
/v0/routing/ruleset
replaceRoutingRuleset
GET
/v0/routing/ruleset/{section}
showRoutingRulesetSection
POST
/v0/fulfillment_request/{ffr_uuid}/set_items_states
updateFulfillmentRequestItemStates
GET
/v0/fulfillment_requests/{order_uuid}
listFulfillmentRequestsForOrder
GET
/v0/config/routing/can_update_ffr_processed_externally
showExternalFulfillmentSettings
POST
/v0/config/routing/can_update_ffr_processed_externally
createExternalFulfillmentSettings
GET
/v0/config/routing/cancel_on_conflict
showCancellationPolicySettings
POST
/v0/config/routing/cancel_on_conflict
createCancellationPolicySettings
GET
/v0/config/routing/enable_automatic_rerouting
showAutomaticReroutingSetting
POST
/v0/config/routing/enable_automatic_rerouting
createAutomaticReroutingSetting
GET
/v0/config/routing/enable_capacity_based_routing
showCapacityBasedRoutingSettings
POST
/v0/config/routing/enable_capacity_based_routing
createCapacityBasedRoutingSettings
GET
/v0/config/routing/reroute_to_rejected_fulfillment_nodes
showRejectedReroutingSettings
POST
/v0/config/routing/reroute_to_rejected_fulfillment_nodes
createRejectedReroutingSettings
GET
/v0/config/routing/skip_shipping_offer_update_for_dc_orders
showShippingOfferUpdateSettings
POST
/v0/config/routing/skip_shipping_offer_update_for_dc_orders
createShippingOfferUpdateSettings
GET
/v0/config/routing/uses_external_atp
showExternalAtpSettings
POST
/v0/config/routing/uses_external_atp
createExternalAtpSettings
GET
/v0/routing/shipments_limit
listShipmentLimits
POST
/v0/routing/shipments_limit
createShipmentLimits
GET
/v0/routing/insights/order/{order_id}
listOrderRoutingInsights
GET
/v1/r/config/order_injection
showOrderInjectionConfiguration
PATCH
/v1/r/config/order_injection
updateOrderInjectionConfiguration
POST
/v1/r/config/order_injection
createOrderInjectionConfiguration
POST
/v0/d/fulfill_order
createInjectedOrder
GET
/audit-events
listAuditEvents
GET
/taxes/config/stores
listStoreConfigs
POST
/taxes/config/stores
createStoreConfig
DELETE
/taxes/config/stores/{id}
destroyStoreConfig
GET
/taxes/config/stores/{id}
showStoreConfig
PATCH
/taxes/config/stores/{id}
updateStoreConfig
POST
/taxes/previews/transactions
createTaxTransactionPreview
GET
/taxes/transactions/{orderId}
showOrderTaxTransaction
PATCH
/taxes/transactions/{orderId}
updateOrderTaxTransaction
GET
/taxes/transactions/{orderId}/returns/{returnId}
showReturnTaxTransaction
GET
/taxes/config
showTenantConfig
PATCH
/taxes/config
updateTenantConfig
POST
/taxes/config
createTenantConfig
Schemas 323
The contract defines 323 schemas that model the data the API accepts and returns. The most detailed are SalesOrderDetailResponse (27 properties), InjectedOrderRequest (25 properties), EnrichedTransactionItemDto (19 properties), ConfigModelResponse (17 properties). Each schema is shown below with its type and property counts.
OptInState
string
The current opt-in state for this store.
TaxStatus
string
Type of the tax status applied to the tax line TAXABLE: Taxes are applied to the tax line. NOTTAXABLE: No taxes are applied to the tax line. EXEMPT: Taxes are…
TokensRequest
object
Tokens request.
1 property
1 required
RejectedReroutingSettings
object
2 properties
1 required
ChangeItemExtendedAttribute
object
2 properties
2 required
ProcessorMetadata
object
1 property
1 required
ConfigModel
object
15 properties
15 required
LocationMappingBody
object
4 properties
3 required
Salesorderitems1
object
Routing insights data for the current sales order item uuid
7 properties
7 required
TaxCalculationStrategy
string
Tax calculation strategy.
Status11
string
Current status of fulfillment request: dispatched - fulfillment request was sent to sent to store/DC services, but wasn't acknowledged yet; acknowledged - fulf…
Type1
string
The type of the discount, either 'fixed' or 'percentage'.
ReservationStatus
string
The status of a reservation.
ChangeItemRequestBody
object
3 properties
ServiceLevels
object
2 properties
Role
object
Needed for granting permissions per group not individually.
6 properties
2 required
CancellationPolicySettingsReasons
string
ItemPrice
object
2 properties
2 required
SalesOrderProductAttributes
object
Additional product-related information.
6 properties
1 required
Origin
object
The ship-from origin for this fulfillment group. Omitted when neither zip code nor country code is known.
2 properties
OfflineCountriesConfigV1Dto
object
13 properties
13 required
IdentityProviderResponse
object
Configured identity provider
5 properties
Status2
string
Status of this item: dispatched - item was routed to a store/DC (check status of fulfillment request to see whether DC/store service has already accepted this…
ExternalFulfillmentSettingsRequest
object
Payload for setting external-fulfillment configuration.
1 property
1 required
AddOnLinks
object
3 properties
1 required
RoutingInsightsRoutingStrategy1
object
2 properties
1 required
SalesOrderOrigin
string
Describes in which Order Management System the order originated from.
RoutingInsightsRoutingStrategies
object
2 properties
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.
TokensResponse
object
Tokens response.
2 properties
2 required
AvalaraConfigUpdateDto
object
6 properties
Current
object
The current routing strategy
2 properties
1 required
StoreConfigListDto
object
3 properties
2 required
AddressResponse
object
12 properties
4 required
OfflineCountriesConfigUpdateV1Dto
object
11 properties
ShipmentLimitsResponse
object
List of all shipments limit rules
1 property
1 required
CashboxV1Dto
object
8 properties
7 required
CancellationPolicySettingsValue
object
Order cancellation policies.
2 properties
VertexConfigCreateDto
object
12 properties
3 required
CustomConfigUpdateDto
object
5 properties
Allocation
object
3 properties
3 required
SalesOrderAddress
object
Address
15 properties
RemoveItemResponseBody
object
2 properties
2 required
Fulfillment
string
Fulfillment type
AuditResponse
object
1 property
1 required
ListAddressesResponse
object
List addresses response
2 properties
2 required
FiscalEnvironment
string
Fiscal environment of the tenant.
TenantConfigV1Dto
object
6 properties
3 required
ItemResource
object
11 properties
7 required
PackageTypeResponse
object
A package type that is available for associates to select during the packing flow.
4 properties
4 required
Timezone
string
Timezone.
CashboxCreateV1Dto
object
2 properties
2 required
EnrichedTransactionItemDto
object
19 properties
11 required
PostUsersRequest
object
7 properties
1 required
SalesOrderCustomer
object
4 properties
ReasonCodePatch
object
1 property
1 required
Application
string
Abbreviation of the application this permission belongs to.
LimitExceededWhen
object
2 properties
2 required
Category
string
Describes if it is a Payment (authorization or capture) or Refund.
RoleItem
object
Needed for granting permissions per group not individually.
4 properties
2 required
CustomConfigAuthenticationDto
object
3 properties
3 required
VertexExemptionClassItemUpdateDto
object
4 properties
3 required
PackageDimensions
object
The physical dimensions of a package type.
4 properties
4 required
F11nWarningCode
string
Fiscalization warning codes that are propagated to the clients (e.g. Associate App) for providing information on possible action items.
PostRolesRequest
object
Needed for granting permissions per group not individually.
2 properties
2 required
CreateCartRequestBody
object
8 properties
6 required
SalesOrderDiscount
object
7 properties
4 required
GetUsersByRoleResponse
object
Gets all users by role
1 property
Reservation
object
4 properties
4 required
TaxExemptionCountryCode
string
The list of countries where this tax exemption class is relevant. '' indicates worldwide support
ChannelType1
string
SalesOrder
object
10 properties
9 required
RequestContext
object
The HTTP request that carried the audited change.
6 properties
retrieveBulkEmailLookupRequest
object
Request for retrieving a consumer profile ID to email mapping.
1 property
1 required
FutureAllocation
object
3 properties
3 required
Profiles
object
Clienteling profile information for multiple customers.
2 properties
2 required
Level
string
On which level the discount was applied, either on the entire order or only on this item.
Correlation
object
Correlation information used to interpret routing attempts by LO uuids
3 properties
3 required
TransactionType
string
Type of the transaction.
InjectedOrderResponse
object
3 properties
3 required
RoutingInsightsCorrelation
object
Information regarding which entities were affected by this event
6 properties
6 required
AddItemResponseBody
object
2 properties
2 required
AddItemExtendedAttribute
object
2 properties
2 required
LocationMapping
object
3 properties
3 required
TransactionDto
object
9 properties
2 required
IdentityProviderVendor
string
Supported Vendors for Identity Providers
ReservationUpdate
object
1 property
1 required
Link
object
2 properties
1 required
EnrichedTransactionAddressDto
object
8 properties
VertexExemptionClassItemCreateDto
object
4 properties
3 required
ResponseCreateconfigurationbyname
object
1 property
SalesOrderSerialNumbersRequestItemEpc
object
The epc which should be assigned to the specified order line item.
3 properties
3 required
AuditEventList
object
One page of audit log events, ordered newest first.
2 properties
1 required
CashboxCreatedV1Dto
object
9 properties
7 required
Value
object
fulfillment node ID to customs signer config
6 properties
3 required
OfflineCountriesConfigMetadataV1Dto
object
13 properties
13 required
RoutingInsights
object
Routing insights data by salesorderuuid or externalid
1 property
1 required
ItemLinks
object
5 properties
2 required
SalesOrderTaxLine
object
4 properties
2 required
IntegrationConfig
object
Third party promotions engine integration config.
2 properties
CreateProfileRequest
object
8 properties
1 required
IdentityProvidersResponse
object
A list of configured identity providers
1 property
StoreConfigDto
object
14 properties
9 required
OfflineCountriesUpdateRequestV1Dto
object
1 property
1 required
Routes
object
2 properties
weight_unit
string
Unit of measurement for the weight.
CashboxReleaseV1Dto
object
1 property
1 required
EnrichedTransactionDto
object
11 properties
3 required
Item8
object
5 properties
5 required
ImportSchemaCreated
object
2 properties
2 required
ExtendedAttributeModel
object
Key-value pair describing a custom attribute associated with the profile.
2 properties
2 required
State
string
New state that should be applied to this item defined by sales order item UUID.
Meta
object
Additional response information.
1 property
1 required
ChangeCartRequestBody
object
1 property
AtpInsightsResponse
object
Limited response of valid request for fetching allocations by ATP keys.
5 properties
3 required
OfflineCountryConfigV1Dto
object
2 properties
2 required
OfflineCountryConfigMetadataV1Dto
object
4 properties
2 required
SalesOrderItem
object
6 properties
6 required
GetPermissionsResponse
object
Returns a list of available permissions the system provides.
1 property
VertexTargetField
string
Vertex flexible field type.
Localization
object
2 properties
2 required
GetResponse
object
2 properties
2 required
InjectedOrderItemIds
object
3 properties
3 required
ByoCrmConfigRequest
object
BYO CRM configuration settings
3 properties
GetRolesResponse
object
Returns a list of roles.
1 property
StoreListV1Dto
object
2 properties
1 required
FixedRateConfigUpdateDto
object
3 properties
Original
object
The original routing strategy on order creation
2 properties
1 required
CustomApiVersion
string
Custom provider API version.
TenantConfigDto
object
13 properties
7 required
RoutingInsightsData
object
Routing insights information for an order
6 properties
6 required
ReplaceProviderRateSchema
object
6 properties
6 required
SalesOrderCancellationResponse
object
Request schema for order cancellation status.
3 properties
3 required
SalesOrderItemPaymentHistory
object
Contains the payments/refunds history for the order. Can also include multiple payments against multiple credit sources (i.e. gift card + credit card)
5 properties
4 required
CartLinks
object
4 properties
2 required
VertexAuthLoginType
string
Vertex Login Type. Used for selecting the authentication method. trustedid field is required if logintype is set to trustedid. username and password fields are…
CustomConfigAdditionalUpdateDto
object
1 property
ReservationItemSummaryResponse
object
2 properties
2 required
SalesOrderSerialNumbersRequest
object
The response for adding serial number information.
1 property
1 required
ExemptionClassItemCreateDto
object
3 properties
2 required
SalesOrderPrice1
object
The response for retrieving price information.
5 properties
5 required
CustomConfigAdditionalCreateDto
object
1 property
FiscalMode
string
Fiscal mode. Defaults to standard if not provided.
F11nTransactionType
string
Transaction type.
AvalaraExemptionClassItemUpdateDto
object
4 properties
3 required
OrderInjectionTenantConfiguration
object
Tenant configuration object.
2 properties
CreateIdentityProviderRequest
object
Create an Identity Provider
4 properties
3 required
OrderInjectionConfigurationBigSalesOrder
object
The order item limits that determine if the order is routed or is considered a big order and placed on hold.
1 property
1 required
VertexExemptionClassItemDto
object
4 properties
3 required
OptedIn
object
Opt-in status information for a conversation between a customer and a store.
2 properties
2 required
RoutingStatus
string
CreatePackageTypeRequest
object
Request body for creating a new package type. Package types define the packages available for an associate to choose from during the packing flow in the Associ…
3 properties
3 required
PutRolesByIdRequest
object
Needed for granting permissions per group not individually.
2 properties
2 required
StoreConfigV1Dto
object
3 properties
3 required
RoutingInsightsStrategyType
string
SalesOrderExternalIdentifier
object
External identifier for the order item
2 properties
ExemptionClassItemUpdateDto
object
3 properties
2 required
LineItem11
object
Line item
2 properties
2 required
StoreUpdateV1Dto
object
3 properties
1 required
SalesOrderItemStatus
string
Current status of the order item. 'pending' means the item is in the grace period, 'onhold' means the item couldn't be fulfilled and is in a conflict status.
ImportSchemaGet
object
3 properties
3 required
TransactionUpdateDto
object
1 property
1 required
ListReservationsResponseV1
object
2 properties
2 required
InjectedOrderAddress
object
12 properties
2 required
VertexAdministrativeOriginCreateDto
object
8 properties
8 required
CartResource
object
12 properties
10 required
DestinationRegion1
object
2 properties
Type12
string
The type of payment information that is passed: either the payment is already authorized, or already captured. The Order Injection API does not support not aut…
GetUsersResponse
object
Gets all users
2 properties
PaginationInfo
object
Pagination info.
3 properties
3 required
SalesOrderFulfillment
object
2 properties
1 required
SalesOrderTotals
object
7 properties
OrderFulfillmentRequestsResponse
object
Fulfillment requests for an order
1 property
1 required
retrieveBulkEmailLookupResponse
object
Response with the mapping of profile IDs to profile emails for the requested profile emails.
1 property
1 required
SalesOrderChannelType
string
The channel through which the order was placed.
Currency2
string
The currency for all the prices contained within this payload.
F11nTaxMethod
string
Defines the tax method used (tax inclusive or exclusive).
IdentityProviderConfig
object
Identity Provider configuration
5 properties
Body
object
1 property
AddressModel
object
Address model request without autogenerated fields like createdat, token, id, etc..
9 properties
1 required
Routingruleset1
object
5 properties
UpdatePackageTypeRequest
object
Request body for updating an existing package type. All fields are optional; only provided fields will be updated.
3 properties
CustomV0AvalaraConfigDto
object
4 properties
4 required
LocationMappingsResponse
object
1 property
1 required
ReservationItemRequest
object
1 property
1 required
FulfillmentRequest
object
The fulfillment request.
6 properties
6 required
PutUsersByIdRequest
object
6 properties
6 required
UpdatedItemStatus
string
Actor
object
Who (or what) caused the audited change. Sourced from the caller's JWT; empty fields are omitted from the payload.
7 properties
SupportedIdentityProviders
object
A list of supported identity providers and protocols
1 property
ProviderRateSchema
object
7 properties
7 required
ListProfilesResponse
object
List profiles response.
2 properties
2 required
TaxTotalsDto
object
9 properties
9 required
RoutingInsightsActivity
object
5 properties
5 required
VertexAdministrativeOriginUpdateDto
object
8 properties
CashboxGetV1Dto
object
9 properties
8 required
ProfileResponse
object
12 properties
12 required
dimension_unit
string
Unit of measurement for the dimensions.
ReservationItemStatus
string
The status of a reservation item.
UpdateAddressRequest
object
Update address request.
10 properties
1 required
PackageWeight
object
The weight of a package type.
2 properties
2 required
OfflineCountriesResponseV1Dto
object
1 property
1 required
ReservationItemDetailsResponse
object
5 properties
4 required
TransactionState
string
Fiscal transaction state.
Currency3
string
Currency code in ISO 4217 format.
TaxRateDto
object
7 properties
4 required
OrderInjectionConfigurationResponse
object
Update configuration response
4 properties
ContextV1Dto
object
5 properties
2 required
CashboxState
string
The state of the cashbox, whether it is activated or deactivated.
ItemType
string
Type of the item.
ReservationSummaryResponseV1
object
10 properties
10 required
CountryCode
string
Country code for this address. Must be ISO-3166 reference
StoreConfigUpdateDto
object
7 properties
bulkProfileLookupResponse
object
2 properties
2 required
ReservationDetailsResponseV1
object
10 properties
10 required
ReservationsPaginationInfo
object
4 properties
1 required
AuditReadOnly
object
7 properties
6 required
Profile
object
Clienteling profile information for a customer.
5 properties
5 required
OrderManagementState
string
Order state.
ReservationConfigResponse
object
3 properties
3 required
Error1
object
3 properties
2 required
ConfigurationRequest
object
Configurations request for updating BYO CRM settings and customer feature toggles.
3 properties
ListResponse
object
1 property
1 required
VertexConfigDto
object
12 properties
3 required
ConfigModelResponse
object
17 properties
15 required
TransactionSignatureStrategy
string
Offline transaction signature strategy that will be used while processing offline transactions. standard-signing Offline orders will be fiscally signed accordi…
StoreV1Dto
object
7 properties
5 required
ShipmentLimitsRequest
object
Limit shipment rules for given currency x service level
3 properties
3 required
CustomV0AvalaraConfigUpdateDto
object
4 properties
AuditOperation
string
The operation performed on the resource.
VertexFlexibleFieldConfigCreateDto
object
3 properties
3 required
ExternalFulfillmentSettingsResponse
object
Current external-fulfillment configuration setting.
2 properties
2 required
StoreConfigCreateDto
object
8 properties
2 required
Permission
object
List of all available system permissions.
3 properties
2 required
Price1
object
4 properties
3 required
DownloadResponse
object
1 property
1 required
AvalaraConfigCreateDto
object
6 properties
4 required
ReservationItemUpdate
object
3 properties
2 required
Problem
object
9 properties
UpdateProfileRequest
object
Update profile request.
9 properties
1 required
ExemptionClass
string
The tax exemption class that identifies the customer's group/organization that accredited them with the tax exemption status. For custom tax exemption classes,…
VertexAdministrativeOriginDto
object
8 properties
8 required
Strategies
object
2 properties
Source
string
Price source
SalesOrderExtendedAttribute
object
2 properties
2 required
CustomConfigCreateDto
object
5 properties
1 required
ResponseShowconfigurationbyname
object
1 property
ConfigurationResponse
object
Configurations response containing BYO CRM settings and customer feature toggles.
3 properties
3 required
SalesOrderPricesResponse
object
The response for retrieving price information.
2 properties
2 required
TransactionMinV1Dto
object
8 properties
6 required
TenantConfigUpdateDto
object
7 properties
CashboxListV1Dto
object
1 property
1 required
SignatureResponseV1Dto
object
13 properties
7 required
ShowProviderRatesSchema
object
1 property
1 required
CreateDataRequest
object
Create data request.
3 properties
2 required
AuditEvent
object
A single audit log event.
11 properties
9 required
ProfileDeletionRequest
object
Profile deletion request payload.
1 property
1 required
SalesOrderListResponse
object
Order history for a customer retrieved from external OMS
1 property
1 required
IdentityProviderProtocol
string
Supported Protocols for Identity Providers
RoutingInsightsServiceLevels
object
2 properties
RoutingInsightsFulfillmentRequests
object
Any fulfillment request identifiers for this LO uuid
3 properties
CustomConfigDto
object
5 properties
1 required
ByoCrmConfigResponse
object
BYO CRM configuration settings
3 properties
3 required
AddItemItemPrice
object
2 properties
FixedRateConfigCreateDto
object
3 properties
1 required
AddOnResource
object
8 properties
6 required
ExtendedAttribute
object
2 properties
2 required
CancellationPolicySettings
object
2 properties
1 required
SupportedIdentityProvider
object
Supported identity providers and protocols
2 properties
ChangeItemResponseBody
object
2 properties
2 required
InjectedOrderPayment
object
A payment supplied for this order. Only payments that are already authorized or captured are supported. Tokens that are not authorized are not supported. The v…
8 properties
6 required
AvalaraConfigDto
object
6 properties
4 required
InjectedOrderRequest
object
An order placed in an external system, identified by its externalid in NewStore. An order contains a list of shipments and the products in each shipment.
25 properties
7 required
CalculationMode
string
Type of the tax calculation STANDARD: Standard tax calculation (default). Taxes will be calculated for each line from itemprice quantity respecting the taxmeth…
SalesOrderDetail
object
15 properties
5 required
FallbackErrorDto
object
3 properties
3 required
ExternalAtpSettings
object
2 properties
1 required
PackageTypesResponse
object
List of all package types configured.
1 property
1 required
FulfillmentRequestItemsStatesRequest
object
Request payload for marking fulfillment request items as shipped or rejected.
5 properties
1 required
CapacityBasedRoutingSettings
object
2 properties
1 required
SalesOrderDetailResponse
object
Schema for fetching sales order using external ID
27 properties
10 required
VertexConfigUpdateDto
object
12 properties
CustomV0AvalaraConfigCreateDto
object
4 properties
4 required
InjectedOrderExtendedAttribute
object
Extra information about the order, which is propagated through NewStore applications.
2 properties
2 required
CustomConfigAuthenticationMethod
string
Custom provider authentication method.
ProviderRateShippingType
string
Required for backwards compatibility purposes.
ShippingOfferUpdateSettings
object
2 properties
1 required
AvalaraEnv
string
Avalara environment.
CreateReservationRequestV1
object
6 properties
3 required
VertexFlexibleFieldConfigDto
object
3 properties
3 required
TenantConfigCreateDto
object
7 properties
2 required
ReservationConfigUpdate
object
3 properties
TaxServiceErrorCode
string
The error code from the underlying tax provider.
EasypostAdapterConfig
object
8 properties
1 required
AuditEventReadOnly
object
4 properties
4 required
FiscalProviderId
string
The fiscal provider id being used.
SalesOrderTaxMethod
string
Method of calculation of the taxes, can be vatincluded or vatexcluded.
User
object
12 properties
SalesOrderCancellationRequest
object
Request schema for order cancellation.
2 properties
1 required
AutomaticReroutingSettings
object
2 properties
1 required
SalesOrderItemShipment
object
4 properties
2 required
SalesOrderFulfillmentType
string
The fulfillment type of the order. In case of mixed cart orders, fulfillment type is always 'multiple'
LocalizedReasonCode
object
3 properties
3 required
PeriodType
string
Period of the report.
UpdateIdentityProviderRequest
object
Update an Identity Provider.
2 properties
1 required
ReasonCodeInit
object
2 properties
2 required
AuditsResponse
object
2 properties
2 required
ExemptionClassItemDto
object
3 properties
2 required
FixedRateConfigDto
object
3 properties
1 required
SalesOrderPricesRequest
object
The request for retrieving price information.
1 property
1 required
SalesOrderPaymentMethod
string
The method customer paid for the order.
AddItemRequestBody
object
7 properties
1 required
PaginatedResponse
object
Contains default fields for paginatable APIs.
3 properties
3 required
SalesOrderGiftWrapping
object
Gift wrapping information. This field is not required and will not be present if gift wrapping is not applicable for the order
3 properties
1 required
VertexFlexibleFieldConfigUpdateDto
object
3 properties
AvalaraExemptionClassItemDto
object
4 properties
3 required
CreateDataResponse
object
Store file response.
1 property
1 required
UpdatedReservationStatus
string
Putroutingrulesetresponse
object
2 properties
SalesOrderStatus
string
Current status of the sales order
AvalaraExemptionClassItemCreateDto
object
4 properties
3 required
SalesOrderSerialNumbersRequestItem
object
3 properties
2 required
CustomConfigAdditionalDto
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Newstore 12
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 fulfillment-requests API
Newstore identity-providers API
Newstore Import Schemas API
#external-public