@itentialopensource/adapter-scansource

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/address/{collectionKey}/{addressId}": { "get": { "tags": [ "Address" ], "operationId": "addressGetAddress", "description": "The parameters and request body are for method: addressGetAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "number" }, "Created": { "type": "string" }, "Updated": { "type": "string" }, "AddressType": { "type": "number" }, "Name": { "type": "string" }, "Attention": { "type": "string" }, "Phone": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "CountryCode": { "type": "string" }, "ExtendedData": { "type": "string" } } }, "example": { "Id": 8, "Created": "string", "Updated": "string", "AddressType": 3, "Name": "string", "Attention": "string", "Phone": "string", "Street1": "string", "Street2": "string", "City": "string", "StateProvince": "string", "PostalCode": "string", "CountryCode": "string", "ExtendedData": "string" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "title": "addressId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "delete": { "tags": [ "Address" ], "operationId": "addressDelete", "description": "The parameters and request body are for method: addressDelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "title": "addressId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/exists/{collectionKey}": { "get": { "tags": [ "Address" ], "operationId": "addressExists", "description": "The parameters and request body are for method: addressExists. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/{collectionKey}": { "put": { "tags": [ "Address" ], "operationId": "addressUpdateAddress", "description": "The parameters and request body are for method: addressUpdateAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "addressUpdateModel" } } } }, "post": { "tags": [ "Address" ], "operationId": "addressAddAddress", "description": "The parameters and request body are for method: addressAddAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "addressModel" } } } } }, "/address/copy/{collectionKey}/{addressId}": { "post": { "tags": [ "Address" ], "operationId": "addressCopyAddress", "description": "The parameters and request body are for method: addressCopyAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "title": "addressId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/clear/{collectionKey}": { "delete": { "tags": [ "Address" ], "operationId": "addressClear", "description": "The parameters and request body are for method: addressClear. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/move/{sourceCollectionKey}/{destinationCollectionKey}/{addressId}": { "post": { "tags": [ "Address" ], "operationId": "addressMoveAddress", "description": "The parameters and request body are for method: addressMoveAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "sourceCollectionKey", "in": "path", "required": true, "schema": { "title": "sourceCollectionKey", "type": "string" } }, { "name": "destinationCollectionKey", "in": "path", "required": true, "schema": { "title": "destinationCollectionKey", "type": "string" } }, { "name": "addressId", "in": "path", "required": true, "schema": { "title": "addressId", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/search/{collectionKey}": { "get": { "tags": [ "Address" ], "operationId": "addressSearch", "description": "The parameters and request body are for method: addressSearch. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "number" }, "Created": { "type": "string" }, "Updated": { "type": "string" }, "AddressType": { "type": "number" }, "Name": { "type": "string" }, "Attention": { "type": "string" }, "Phone": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "CountryCode": { "type": "string" }, "ExtendedData": { "type": "string" } } } }, "example": [ { "Id": 1, "Created": "string", "Updated": "string", "AddressType": 3, "Name": "string", "Attention": "string", "Phone": "string", "Street1": "string", "Street2": "string", "City": "string", "StateProvince": "string", "PostalCode": "string", "CountryCode": "string", "ExtendedData": "string" }, { "Id": 10, "Created": "string", "Updated": "string", "AddressType": 1, "Name": "string", "Attention": "string", "Phone": "string", "Street1": "string", "Street2": "string", "City": "string", "StateProvince": "string", "PostalCode": "string", "CountryCode": "string", "ExtendedData": "string" } ] } } } }, "parameters": [ { "name": "collectionKey", "in": "path", "required": true, "schema": { "title": "collectionKey", "type": "string" } }, { "name": "page", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "pageSize", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "stateProvince", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "postalCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "countryCode", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "useAndOperator", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/countries/{region}": { "get": { "tags": [ "Address" ], "operationId": "addressGetAddressCountries", "description": "The parameters and request body are for method: addressGetAddressCountries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "number" }, "CountryCode": { "type": "string" }, "Region": { "type": "number" }, "RegexValidationPattern": { "type": "string" } } } }, "example": [ { "Id": 9, "CountryCode": "string", "Region": 0, "RegexValidationPattern": "string" } ] } } } }, "parameters": [ { "name": "region", "in": "path", "required": true, "schema": { "title": "region", "type": "number" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/provinces/{countryCode}": { "get": { "tags": [ "Address" ], "operationId": "addressGetAddressProvinceStates", "description": "The parameters and request body are for method: addressGetAddressProvinceStates. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "number" }, "ProvinceStateCode": { "type": "string" }, "Description": { "type": "string" }, "CountryCode": { "type": "string" }, "Region": { "type": "number" } } } }, "example": [ { "Id": 9, "ProvinceStateCode": "string", "Description": "string", "CountryCode": "string", "Region": 2 } ] } } } }, "parameters": [ { "name": "countryCode", "in": "path", "required": true, "schema": { "title": "countryCode", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/address/validate": { "post": { "tags": [ "Address" ], "operationId": "addressValidate", "description": "The parameters and request body are for method: addressValidate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "State": { "type": "string" }, "Classification": { "type": "string" }, "Attributes": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string" }, "Value": { "type": "string" } } } }, "EffectiveAddress": { "type": "object", "properties": { "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "StateProvince": { "type": "string" }, "PostalCode": { "type": "string" }, "CountryCode": { "type": "string" } } } } }, "example": { "State": "string", "Classification": "string", "Attributes": [ { "Name": "string", "Value": "string" }, { "Name": "string", "Value": "string" }, { "Name": "string", "Value": "string" }, { "Name": "string", "Value": "string" }, { "Name": "string", "Value": "string" } ], "EffectiveAddress": { "Street1": "string", "Street2": "string", "City": "string", "StateProvince": "string", "PostalCode": "string", "CountryCode": "string" } } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "addressModel" } } } } }, "/cart/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "operationId": "cartGetCart", "description": "The parameters and request body are for method: cartGetCart. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "number" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "ExtendedData": { "type": "string" }, "CartItems": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "number" }, "Item": { "type": "string" }, "Quantity": { "type": "number" }, "ExtendedData": { "type": "string" }, "Created": { "type": "string" }, "Updated": { "type": "string" } } } }, "CartCheckoutInfo": { "type": "object", "properties": { "PONumber": { "type": "string" }, "EndUserPO": { "type": "string" }, "RequestedDeliveryDate": { "type": "string" }, "ShipMethodServiceLevelCode": { "type": "string" }, "ServiceLevelDescription": { "type": "string" }, "ShippingAccountNumber": { "type": "string" }, "FreightForwarderNumber": { "type": "string" }, "ShipComplete": { "type": "boolean" }, "Memo": { "type": "string" }, "PayorId": { "type": "string" }, "ShippingAddress": { "type": "object", "properties": { "Name": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" } } }, "Carrier": { "type": "object", "properties": { "CarrierAddress": { "type": "object", "properties": { "Name": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" } } }, "Phone": { "type": "string" } } }, "Created": { "type": "string" }, "Updated": { "type": "string" } } }, "Created": { "type": "string" }, "Updated": { "type": "string" } } }, "example": { "Id": 8, "Name": "string", "Description": "string", "ExtendedData": "string", "CartItems": [ { "Id": 7, "Item": "string", "Quantity": 5, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 3, "Item": "string", "Quantity": 8, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 7, "Item": "string", "Quantity": 10, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 9, "Item": "string", "Quantity": 1, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 3, "Item": "string", "Quantity": 6, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 10, "Item": "string", "Quantity": 3, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 4, "Item": "string", "Quantity": 8, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 5, "Item": "string", "Quantity": 9, "ExtendedData": "string", "Created": "string", "Updated": "string" } ], "CartCheckoutInfo": { "PONumber": "string", "EndUserPO": "string", "RequestedDeliveryDate": "string", "ShipMethodServiceLevelCode": "string", "ServiceLevelDescription": "string", "ShippingAccountNumber": "string", "FreightForwarderNumber": "string", "ShipComplete": false, "Memo": "string", "PayorId": "string", "ShippingAddress": { "Name": "string", "Street1": "string", "Street2": "string", "City": "string", "State": "string", "PostalCode": "string", "Country": "string" }, "Carrier": { "CarrierAddress": { "Name": "string", "Street1": "string", "Street2": "string", "City": "string", "State": "string", "PostalCode": "string", "Country": "string" }, "Phone": "string" }, "Created": "string", "Updated": "string" }, "Created": "string", "Updated": "string" } } } } }, "parameters": [ { "name": "cartCollectionKey", "in": "path", "required": true, "schema": { "title": "cartCollectionKey", "type": "string" } }, { "name": "cartId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Cart" ], "operationId": "cartUpdateCart", "description": "The parameters and request body are for method: cartUpdateCart. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cartCollectionKey", "in": "path", "required": true, "schema": { "title": "cartCollectionKey", "type": "string" } }, { "name": "updateCartItems", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "cartModel" } } } }, "post": { "tags": [ "Cart" ], "operationId": "cartAddCart", "description": "The parameters and request body are for method: cartAddCart. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cartCollectionKey", "in": "path", "required": true, "schema": { "title": "cartCollectionKey", "type": "string" } }, { "name": "currentCart", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "cartModel" } } } }, "delete": { "tags": [ "Cart" ], "operationId": "cartDelete", "description": "The parameters and request body are for method: cartDelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cartCollectionKey", "in": "path", "required": true, "schema": { "title": "cartCollectionKey", "type": "string" } }, { "name": "cartId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/cart/exists/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "operationId": "cartExists", "description": "The parameters and request body are for method: cartExists. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cartCollectionKey", "in": "path", "required": true, "schema": { "title": "cartCollectionKey", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/cart/copy/{cartCollectionKey}/{cartId}": { "post": { "tags": [ "Cart" ], "operationId": "cartCopyCart", "description": "The parameters and request body are for method: cartCopyCart. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "cartCollectionKey", "in": "path", "required": true, "schema": { "title": "cartCollectionKey", "type": "string" } }, { "name": "cartId", "in": "path", "required": true, "schema": { "title": "cartId", "type": "number" } }, { "name": "currentCart", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/cart/list/{cartCollectionKey}": { "get": { "tags": [ "Cart" ], "operationId": "cartGetCartList", "description": "The parameters and request body are for method: cartGetCartList. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "CurrentCartId": { "type": "number" }, "Carts": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "number" }, "Name": { "type": "string" }, "Description": { "type": "string" }, "ExtendedData": { "type": "string" }, "CartItems": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "number" }, "Item": { "type": "string" }, "Quantity": { "type": "number" }, "ExtendedData": { "type": "string" }, "Created": { "type": "string" }, "Updated": { "type": "string" } } } }, "CartCheckoutInfo": { "type": "object", "properties": { "PONumber": { "type": "string" }, "EndUserPO": { "type": "string" }, "RequestedDeliveryDate": { "type": "string" }, "ShipMethodServiceLevelCode": { "type": "string" }, "ServiceLevelDescription": { "type": "string" }, "ShippingAccountNumber": { "type": "string" }, "FreightForwarderNumber": { "type": "string" }, "ShipComplete": { "type": "boolean" }, "Memo": { "type": "string" }, "PayorId": { "type": "string" }, "ShippingAddress": { "type": "object", "properties": { "Name": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" } } }, "Carrier": { "type": "object", "properties": { "CarrierAddress": { "type": "object", "properties": { "Name": { "type": "string" }, "Street1": { "type": "string" }, "Street2": { "type": "string" }, "City": { "type": "string" }, "State": { "type": "string" }, "PostalCode": { "type": "string" }, "Country": { "type": "string" } } }, "Phone": { "type": "string" } } }, "Created": { "type": "string" }, "Updated": { "type": "string" } } }, "Created": { "type": "string" }, "Updated": { "type": "string" } } } } } }, "example": { "CurrentCartId": 7, "Carts": [ { "Id": 8, "Name": "string", "Description": "string", "ExtendedData": "string", "CartItems": [ { "Id": 7, "Item": "string", "Quantity": 10, "ExtendedData": "string", "Created": "string", "Updated": "string" }, { "Id": 7, "Item": "string", "Quantity": 4, "ExtendedData": "string", "Create