Sign in
Nexus

Create physical nexus

The Create Physical Nexus API allows you to create a new physical nexus by specifying its attributes, including the location, start date, end date, etc.

post/v1/nexus/physical_nexus

Headers

x-organization-idstring nullable required

The unique identifier for the organization making the request

The unique identifier for the organization making the request

Request body

country_code'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'CI' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'XK' | 'ZZ_EU' required
state_codestring required

The state or province code in ISO 3166-2 format (e.g., CA).

start_datestring date required

The date when the nexus became effective (YYYY-MM-DD).

end_datestring date nullable

The date when the nexus ended, if applicable.

category'PHYSICAL_BUSINESS_LOCATION' | 'TELECOMMUTING_OR_REMOTE_EMPLOYEE' | 'WARRANTY_AND_REPAIR_SERVICES' | 'CATALOGUE_DISTRIBUTION_OR_ADVERTISING_MATERIAL' | 'DELIVERY_BY_COMMON_CARRIER' | 'DELIVERY_BY_OWN_VEHICLES' | 'IN_STATE_SALES_PERSON' | 'INDEPENDENT_CONTRACTOR_OR_THIRD_PARTY_SALES_PERSON' | 'WAREHOUSE_AND_INVENTORY_PRESENCE' | 'EMPLOYEES_AGENTS_CONTRACTORS' | 'OWN_LEASE_A_PROPERTY' | 'INVENTORY' | 'DELIVERY_USING_COMPANY_VEHICLES' | 'OWN_BUSINESS_INFRASTRUCTURE_AND_EQUIPMENT' | 'ON_SITE_INSTALLATION_MAINTENANCE_SERVICES' | 'FREQUENT_PARTICIPATION_IN_TRADE_SHOWS_EVENTS' | 'MANUFACTURE_OR_PRODUCTION_IN_CANADA' | 'PERFORMING_SERVICES_IN_THE_JURISDICTION' | 'MANUFACTURING_FACILITIES' | 'SERVERS_DATA_CENTERS' | 'TRADE_SHOW_PRESENCE' | 'TRADE_SHOW_PRESENCE_WITHOUT_SALES' | 'DIGITAL_INFRASTRUCTURE_LOCALIZED' | 'PERMANENT_ESTABLISHMENT' | 'ENTER_CONTRACTS_WITH_LOCALS' | 'CONSIGNMENT_STOCK_ARRANGEMENTS' required
external_idstring nullable

Optional external identifier for the nexus.

source'USER' | 'DEEL'
street_1string nullable

Primary street address for the physical presence location.

street_2string nullable

Additional street address details, such as suite or unit number.

citystring nullable

City of the physical presence location.

postal_codestring nullable

ZIP or postal code of the physical presence location.

Response

Successfully created physical nexus

country_code'AF' | 'AX' | 'AL' | 'DZ' | 'AS' | 'AD' | 'AO' | 'AI' | 'AQ' | 'AG' | 'AR' | 'AM' | 'AW' | 'AU' | 'AT' | 'AZ' | 'BS' | 'BH' | 'BD' | 'BB' | 'BY' | 'BE' | 'BZ' | 'BJ' | 'BM' | 'BT' | 'BO' | 'BQ' | 'BA' | 'BW' | 'BV' | 'BR' | 'IO' | 'BN' | 'BG' | 'BF' | 'BI' | 'CV' | 'KH' | 'CM' | 'CA' | 'KY' | 'CF' | 'TD' | 'CL' | 'CN' | 'CX' | 'CC' | 'CO' | 'KM' | 'CG' | 'CD' | 'CK' | 'CR' | 'HR' | 'CU' | 'CW' | 'CY' | 'CZ' | 'DK' | 'DJ' | 'DM' | 'DO' | 'EC' | 'EG' | 'SV' | 'GQ' | 'ER' | 'EE' | 'SZ' | 'ET' | 'FK' | 'FO' | 'FJ' | 'FI' | 'FR' | 'GF' | 'PF' | 'TF' | 'GA' | 'GM' | 'GE' | 'DE' | 'GH' | 'GI' | 'GR' | 'GL' | 'GD' | 'GP' | 'GU' | 'GT' | 'GG' | 'GN' | 'GW' | 'GY' | 'HT' | 'HM' | 'VA' | 'HN' | 'HK' | 'HU' | 'IS' | 'IN' | 'ID' | 'IR' | 'IQ' | 'IE' | 'IM' | 'IL' | 'IT' | 'CI' | 'JM' | 'JP' | 'JE' | 'JO' | 'KZ' | 'KE' | 'KI' | 'KP' | 'KR' | 'KW' | 'KG' | 'LA' | 'LV' | 'LB' | 'LS' | 'LR' | 'LY' | 'LI' | 'LT' | 'LU' | 'MO' | 'MG' | 'MW' | 'MY' | 'MV' | 'ML' | 'MT' | 'MH' | 'MQ' | 'MR' | 'MU' | 'YT' | 'MX' | 'FM' | 'MD' | 'MC' | 'MN' | 'ME' | 'MS' | 'MA' | 'MZ' | 'MM' | 'NA' | 'NR' | 'NP' | 'NL' | 'NC' | 'NZ' | 'NI' | 'NE' | 'NG' | 'NU' | 'NF' | 'MK' | 'MP' | 'NO' | 'OM' | 'PK' | 'PW' | 'PS' | 'PA' | 'PG' | 'PY' | 'PE' | 'PH' | 'PN' | 'PL' | 'PT' | 'PR' | 'QA' | 'RE' | 'RO' | 'RU' | 'RW' | 'BL' | 'SH' | 'KN' | 'LC' | 'MF' | 'PM' | 'VC' | 'WS' | 'SM' | 'ST' | 'SA' | 'SN' | 'RS' | 'SC' | 'SL' | 'SG' | 'SX' | 'SK' | 'SI' | 'SB' | 'SO' | 'ZA' | 'GS' | 'SS' | 'ES' | 'LK' | 'SD' | 'SR' | 'SJ' | 'SE' | 'CH' | 'SY' | 'TW' | 'TJ' | 'TZ' | 'TH' | 'TL' | 'TG' | 'TK' | 'TO' | 'TT' | 'TN' | 'TR' | 'TM' | 'TC' | 'TV' | 'UG' | 'UA' | 'AE' | 'GB' | 'US' | 'UM' | 'UY' | 'UZ' | 'VU' | 'VE' | 'VN' | 'VG' | 'VI' | 'WF' | 'EH' | 'YE' | 'ZM' | 'ZW' | 'XK' | 'ZZ_EU' required
state_codestring required

The state or province code in ISO 3166-2 format (e.g., CA).

start_datestring date required

The date when the nexus became effective (YYYY-MM-DD).

end_datestring date nullable

The date when the nexus ended, if applicable.

category'PHYSICAL_BUSINESS_LOCATION' | 'TELECOMMUTING_OR_REMOTE_EMPLOYEE' | 'WARRANTY_AND_REPAIR_SERVICES' | 'CATALOGUE_DISTRIBUTION_OR_ADVERTISING_MATERIAL' | 'DELIVERY_BY_COMMON_CARRIER' | 'DELIVERY_BY_OWN_VEHICLES' | 'IN_STATE_SALES_PERSON' | 'INDEPENDENT_CONTRACTOR_OR_THIRD_PARTY_SALES_PERSON' | 'WAREHOUSE_AND_INVENTORY_PRESENCE' | 'EMPLOYEES_AGENTS_CONTRACTORS' | 'OWN_LEASE_A_PROPERTY' | 'INVENTORY' | 'DELIVERY_USING_COMPANY_VEHICLES' | 'OWN_BUSINESS_INFRASTRUCTURE_AND_EQUIPMENT' | 'ON_SITE_INSTALLATION_MAINTENANCE_SERVICES' | 'FREQUENT_PARTICIPATION_IN_TRADE_SHOWS_EVENTS' | 'MANUFACTURE_OR_PRODUCTION_IN_CANADA' | 'PERFORMING_SERVICES_IN_THE_JURISDICTION' | 'MANUFACTURING_FACILITIES' | 'SERVERS_DATA_CENTERS' | 'TRADE_SHOW_PRESENCE' | 'TRADE_SHOW_PRESENCE_WITHOUT_SALES' | 'DIGITAL_INFRASTRUCTURE_LOCALIZED' | 'PERMANENT_ESTABLISHMENT' | 'ENTER_CONTRACTS_WITH_LOCALS' | 'CONSIGNMENT_STOCK_ARRANGEMENTS' required
external_idstring nullable

Optional external identifier for the nexus.

source'USER' | 'DEEL'
street_1string nullable

Primary street address for the physical presence location.

street_2string nullable

Additional street address details, such as suite or unit number.

citystring nullable

City of the physical presence location.

postal_codestring nullable

ZIP or postal code of the physical presence location.

idstring required

The unique identifier for the physical nexus.

Changes

Changed in 1 of the 4 revisions of this API.78

  • 6ba4f4c774c378See the full diff
    • ▲

      added the new required header request parameter x-organization-id

      new-required-request-parameter

    • ▲

      response property city list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property end_date list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property external_id list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property postal_code list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property street_1 list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property street_2 list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      the endpoint scheme security APIKeyHeader was added to the API

      api-security-added

    • ○

      the endpoint scheme security APIKeyHeader AND CustomHeader was removed from the API

      api-security-removed

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    • ○

      request property list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

    This revision also has 362 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog