OpenAPI Specification
swagger: '2.0'
info:
version: '1.0'
title: NewStore address providers API
description: NewStore public APIs
contact:
email: support@newstore.com
name: NewStore API Support
url: https://developer.newstore.com
host: dodici-demo.p.newstore.net
basePath: /
schemes:
- https
consumes:
- application/json
produces:
- application/json
security: []
tags:
- name: providers
description: Payment provider operations
paths:
/payment/providers/{newstore}/locations/{location}/mappings:
delete:
description: "\n<div style=\"background-color: rgba(243, 156, 18, 0.15); border: 1px solid #f39c12; border-left: 4px solid #f39c12; padding: 12px; margin: 10px 0; border-radius: 4px; color: #f39c12;\">\n <strong>\U0001F6A7 BETA:</strong> This endpoint is in beta and may change.\n <br />\n See <a href=\"https://docs.newstore.com/docs/api-lifecycle\" target=\"_blank\" style=\"color: #f39c12; text-decoration: underline;\">API Lifecycle Documentation</a> for details.\n</div>\n\n"
summary: destroyProviderLocationMapping
tags:
- providers
operationId: destroyProviderLocationMapping
deprecated: false
produces:
- application/json
- application/problem+json
consumes:
- application/json
parameters:
- name: newstore
in: path
required: true
type: string
description: ''
- name: location
in: path
required: true
type: string
description: ''
- name: Content-Type
in: header
required: false
enum:
- application/json
type: string
description: ''
- name: body
in: body
required: false
default: '{}'
description: ''
schema:
type: object
responses:
default:
description: Default Response
headers: {}
'200':
description: Successful Response
schema: {}
headers: {}
'400':
description: Bad Request
schema:
$ref: '#/definitions/Problem'
headers: {}
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/Problem'
headers:
Retry-After:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Problem'
headers: {}
'502':
description: Bad Gateway
schema:
$ref: '#/definitions/Problem'
headers: {}
'503':
description: Service Unavailable
schema:
$ref: '#/definitions/Problem'
headers: {}
security:
- oauth:
- newstore:configuration:read
put:
description: ''
summary: replaceProviderLocationMapping
tags:
- providers
operationId: replaceProviderLocationMapping
deprecated: false
produces:
- application/json
- application/problem+json
consumes:
- application/json
parameters:
- name: newstore
in: path
required: true
type: string
description: ''
- name: location
in: path
required: true
type: string
description: ''
- name: Content-Type
in: header
required: false
enum:
- application/json
type: string
description: ''
- name: body
in: body
required: true
description: ''
schema:
$ref: '#/definitions/LocationMappingBody'
responses:
default:
description: Default Response
headers: {}
'200':
description: Successful Response
schema: {}
headers: {}
'400':
description: Bad Request
schema:
$ref: '#/definitions/Problem'
headers: {}
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/Problem'
headers:
Retry-After:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Problem'
headers: {}
'502':
description: Bad Gateway
schema:
$ref: '#/definitions/Problem'
headers: {}
'503':
description: Service Unavailable
schema:
$ref: '#/definitions/Problem'
headers: {}
security:
- oauth:
- newstore:configuration:read
/payment/providers/{newstore}/locations/mappings:
get:
description: ''
summary: listProviderLocationMappings
tags:
- providers
operationId: listProviderLocationMappings
deprecated: false
produces:
- application/json
- application/problem+json
parameters:
- name: newstore
in: path
required: true
type: string
description: ''
responses:
default:
description: Default Response
headers: {}
'200':
description: Successful Response
schema:
$ref: '#/definitions/LocationMappingsResponse'
headers: {}
'400':
description: Bad Request
schema:
$ref: '#/definitions/Problem'
headers: {}
'429':
description: Too Many Requests
schema:
$ref: '#/definitions/Problem'
headers:
Retry-After:
type: string
'500':
description: Internal Server Error
schema:
$ref: '#/definitions/Problem'
headers: {}
'502':
description: Bad Gateway
schema:
$ref: '#/definitions/Problem'
headers: {}
'503':
description: Service Unavailable
schema:
$ref: '#/definitions/Problem'
headers: {}
security:
- oauth:
- newstore:configuration:read
definitions:
ProcessorMetadata:
title: ProcessorMetadata
type: object
properties:
embedded_processor:
type: string
minLength: 1
required:
- embedded_processor
Problem:
title: Problem
type: object
properties:
detail:
description: A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
example: some description for the error situation
type: string
error_code:
type: string
instance:
description: A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.
example: /some/uri-reference#specific-occurrence-context
type: string
message:
type: string
messages:
type: array
items:
type: string
request_id:
type: string
status:
description: The HTTP status code generated by the origin server for this occurrence of the problem.
type: integer
minimum: 100.0
maximum: 600.0
exclusiveMaximum: true
format: int32
title:
description: A short summary of the problem type. Written in English and readable for engineers, usually not suited for non technical stakeholders and not localized.
example: some title for the error situation
type: string
type:
description: A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is neither recommended to be dereferenceable and point to a human-readable documentation nor globally unique for the problem type.
example: /some/uri-reference
type: string
default: about:blank
LocationMappingBody:
title: LocationMappingBody
type: object
properties:
connected_account_id:
type: string
minLength: 1
environment:
type: string
minLength: 1
location_id:
type: string
minLength: 1
metadata:
$ref: '#/definitions/ProcessorMetadata'
required:
- connected_account_id
- environment
- location_id
LocationMappingsResponse:
title: LocationMappingsResponse
type: object
properties:
location_mappings:
type: object
additionalProperties:
$ref: '#/definitions/LocationMapping'
required:
- location_mappings
LocationMapping:
title: LocationMapping
type: object
properties:
connected_account_id:
type: string
environment:
type: string
location_id:
type: string
required:
- connected_account_id
- environment
- location_id
securityDefinitions:
oauth:
type: oauth2
flow: application
tokenUrl: https://id.p.newstore.net/auth/realms/dodici-demo/protocol/openid-connect/token
scopes:
catalog:import-schemas:read: Grants privileges to read import schema
catalog:import-schemas:write: Grants privileges to write import schema
catalog:pricebook-export:read: Grants privileges to export pricebook data
catalog:product-export:read: Grants privileges to export product data
checkout:carts:read: Grants privileges to read cart data
checkout:carts:write: Grants privileges to write cart data
clienteling:profile:read: Grants privileges to read clienteling profiles
customer:profile:read: Grants privileges to read API customer data
customer:profile:write: Grants privileges to modify API customer data
newstore:configuration:read: Grants privileges to read configuration
newstore:configuration:write: Grants privileges to write configuration
fiscalization:orders:read: View orders with fiscal transactions and signatures
fiscalization:orders:write: Create orders with fiscal transactions and signatures
shipments:read: Read Shipping Options and Audits
iam:providers:read: ' Grants read privileges to provider resources'
iam:providers:write: ' Grants write privileges to provider resources'
iam:roles:read: ' Grants privileges to read roles data'
iam:roles:write: ' Grants privileges to write roles data'
iam:users:read: ' Grants privileges to read user data'
iam:users:write: ' Grants privileges to write user data'
inventory:reservations:read: Allows access to retrieve reservations
inventory:reservations:write: Allows access to create and update reservations
promotions:config:read: Grants privileges to read configuration
promotions:config:write: Grants privileges to write into configuration
promotions:reason-codes:read: Grants privileges to list reason codes
promotions:reason-codes:write: Grants privileges to create and update reason codes
audit-events:read: Grants read access to the tenant's audit events.
taxes:preview-transactions:write: Preview tax transactions
taxes:transactions:read: Read tax transactions