openapi: 3.2.0 info: version: storefront-v1 title: Storefront API V1 Billtos API servers: - url: https://dogfood.commerce.insitesandbox.com security: [] tags: - name: Billtos paths: /api/v1/billtos/{billToId}/shiptos/{shipToId}: get: tags: - Billtos operationId: ShipTosV1_GetAsync parameters: - name: billToId in: path required: true schema: type: string - name: shipToId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' security: - access_token: [] patch: tags: - Billtos operationId: ShipTosV1_PatchAsync parameters: - name: billToId in: path required: true schema: type: string - name: shipToId in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' security: - access_token: [] /api/v1/billtos/{billToId}/shiptos: get: tags: - Billtos operationId: ShipTosV1_GetCollectionAsync parameters: - name: billToId in: path required: true schema: type: string - name: apiParameter.billToId in: query required: false schema: type: string - name: apiParameter.expand in: query required: false schema: type: string - name: apiParameter.filter in: query required: false schema: type: string - name: apiParameter.page in: query required: false schema: type: integer format: int32 - name: apiParameter.pageSize in: query required: false schema: type: integer format: int32 - name: apiParameter.sort in: query required: false schema: type: string - name: apiParameter.exclude in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToCollectionModel' security: - access_token: [] post: tags: - Billtos operationId: ShipTosV1_PostAsync parameters: - name: billToId in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' security: - access_token: [] /api/v1/billtos: get: tags: - Billtos operationId: BillTosV1_GetCollectionAsync parameters: - name: parameter.expand in: query required: false schema: type: string - name: parameter.filter in: query required: false schema: type: string - name: parameter.page in: query required: false schema: type: integer format: int32 - name: parameter.pageSize in: query required: false schema: type: integer format: int32 - name: parameter.sort in: query required: false schema: type: string - name: parameter.exclude in: query required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToCollectionModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToCollectionModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToCollectionModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToCollectionModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToCollectionModel' security: - access_token: [] post: tags: - Billtos operationId: BillTosV1_PostAsync requestBody: $ref: '#/components/requestBodies/Insite.Customers.WebApi.V1.ApiModels.BillToModel' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' security: - access_token: [] /api/v1/billtos/{billToId}: get: tags: - Billtos operationId: BillTosV1_GetAsync parameters: - name: billToId in: path required: true schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' security: - access_token: [] patch: tags: - Billtos operationId: BillTosV1_PatchAsync parameters: - name: billToId in: path required: true schema: type: string requestBody: $ref: '#/components/requestBodies/Insite.Customers.WebApi.V1.ApiModels.BillToModel' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' security: - access_token: [] components: schemas: Insite.Websites.WebApi.V1.ApiModels.CountryModel: type: object properties: uri: type: string id: type: string name: type: string abbreviation: type: string states: type: array items: $ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.StateModel' properties: type: object additionalProperties: type: string Insite.Core.WebApi.SortOptionModel: type: object properties: displayName: type: string sortType: type: string Insite.Customers.WebApi.V1.ApiModels.ShipToModel: type: object properties: uri: type: string isNew: type: boolean oneTimeAddress: type: boolean label: type: string validation: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.CustomerValidationDto' isDefault: type: boolean id: type: string customerNumber: type: string customerSequence: type: string customerName: type: string firstName: type: string lastName: type: string contactFullName: type: string companyName: type: string attention: type: string address1: type: string address2: type: string address3: type: string address4: type: string city: type: string postalCode: type: string state: $ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.StateModel' country: $ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.CountryModel' phone: type: string fullAddress: type: string email: type: string fax: type: string isVmiLocation: type: boolean properties: type: object additionalProperties: type: string Insite.Customers.WebApi.V1.ApiModels.BillToModel: type: object properties: uri: type: string shipTosUri: type: string isGuest: type: boolean label: type: string budgetEnforcementLevel: type: string costCodeTitle: type: string customerCurrencySymbol: type: string costCodes: type: array items: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.CostCodeModel' shipTos: type: array items: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' validation: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.CustomerValidationDto' isDefault: type: boolean accountsReceivable: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.AccountsReceivableDto' id: type: string customerNumber: type: string customerSequence: type: string customerName: type: string firstName: type: string lastName: type: string contactFullName: type: string companyName: type: string attention: type: string address1: type: string address2: type: string address3: type: string address4: type: string city: type: string postalCode: type: string state: $ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.StateModel' country: $ref: '#/components/schemas/Insite.Websites.WebApi.V1.ApiModels.CountryModel' phone: type: string fullAddress: type: string email: type: string fax: type: string isVmiLocation: type: boolean properties: type: object additionalProperties: type: string Insite.Customers.WebApi.V1.ApiModels.ShipToCollectionModel: type: object properties: uri: type: string pagination: $ref: '#/components/schemas/Insite.Core.WebApi.PaginationModel' shipTos: type: array items: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' properties: type: object additionalProperties: type: string Insite.Websites.WebApi.V1.ApiModels.StateModel: type: object properties: uri: type: string id: type: string name: type: string abbreviation: type: string properties: type: object additionalProperties: type: string Insite.Core.WebApi.PaginationModel: type: object properties: currentPage: format: int32 type: integer page: format: int32 type: integer pageSize: format: int32 type: integer defaultPageSize: format: int32 type: integer totalItemCount: format: int32 type: integer numberOfPages: format: int32 type: integer pageSizeOptions: type: array items: format: int32 type: integer sortOptions: type: array items: $ref: '#/components/schemas/Insite.Core.WebApi.SortOptionModel' sortType: type: string nextPageUri: type: string prevPageUri: type: string nextPageToken: type: string Insite.Customers.Services.Dtos.AgingBucketDto: type: object properties: amount: format: decimal type: number amountDisplay: type: string label: type: string Insite.Customers.Services.Dtos.FieldValidationDto: type: object properties: isRequired: type: boolean isDisabled: type: boolean maxLength: format: int32 type: integer Insite.Customers.Services.Dtos.AccountsReceivableDto: type: object properties: agingBuckets: type: array items: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.AgingBucketDto' agingBucketTotal: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.AgingBucketDto' agingBucketFuture: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.AgingBucketDto' Insite.Customers.WebApi.V1.ApiModels.BillToCollectionModel: type: object properties: uri: type: string pagination: $ref: '#/components/schemas/Insite.Core.WebApi.PaginationModel' billTos: type: array items: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' properties: type: object additionalProperties: type: string Insite.Customers.Services.Dtos.CustomerValidationDto: type: object properties: firstName: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' lastName: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' companyName: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' attention: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' address1: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' address2: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' address3: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' address4: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' country: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' state: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' city: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' postalCode: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' phone: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' email: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' fax: $ref: '#/components/schemas/Insite.Customers.Services.Dtos.FieldValidationDto' Insite.Customers.WebApi.V1.ApiModels.CostCodeModel: type: object properties: id: format: uuid type: string example: 00000000-0000-0000-0000-000000000000 costCode: type: string description: type: string isActive: type: boolean requestBodies: Insite.Customers.WebApi.V1.ApiModels.ShipToModel: content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.ShipToModel' required: true Insite.Customers.WebApi.V1.ApiModels.BillToModel: content: application/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/json: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' application/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/xml: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' text/html: schema: $ref: '#/components/schemas/Insite.Customers.WebApi.V1.ApiModels.BillToModel' required: true securitySchemes: access_token: type: apiKey description: Token used to access storefront API. name: access_token in: query