external-vendors
Operations addressed under /external-vendors — 28 operations.
get-vendor-external-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalDto>.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid | no |
VendorExternalType | int | no |
VendorExternalNumber | string | no |
IsActive | bool | no |
MarketPaymentType | int? | yes |
TransferType | int? | yes |
Citizenid | string | no |
SellerName | string | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-vendor-external-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
citizenidcustomerIdidisActivemarketPaymentTypesellerNametransferTypevendorExternalNumbervendorExternalTypePermitted values — validated against the vendor_external_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SELLER | no label seeded |
2 | DISTRIBUTOR | no label seeded |
create-vendor-external
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as CreateVendorExternalDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
VendorExternalNumber | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_5 | 400 | VENDOR_EXTERNAL_IS_NOT_NULL | This person has a vendor record. :{0} |
create-vendor-external › Request Body
vendorExternalTypePermitted values — validated against the vendor_external_type parameter.
| Value | Meaning |
|---|---|
1 | SELLER |
2 | DISTRIBUTOR |
Permitted values — validated against the vendor_external_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SELLER | no label seeded |
2 | DISTRIBUTOR | no label seeded |
citizenidcustomerIdmarketPaymentTypesellerNametransferTypecreate-vendor-external › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
get-all-vendor-external-account-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalAccountDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
Iban | string | no |
CurrencyNumber | string | no |
BankCode | int | no |
CustomerAccountId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-all-vendor-external-account-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
bankCodePermitted values — validated against the bank_code parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Diğer | no label seeded |
1 | ADABANK A.Ş. | no label seeded |
2 | AKBANK T.A.Ş. | no label seeded |
3 | ALTERNATİFBANK A.Ş. | no label seeded |
4 | ANADOLUBANK A.Ş. | no label seeded |
5 | ARAP TÜRK BANKASI A.Ş. | no label seeded |
6 | BANK MELLAT | no label seeded |
7 | BANK OF CHINA TURKEY A.Ş. | no label seeded |
8 | BURGAN BANK A.Ş. | no label seeded |
9 | CITIBANK A.Ş. | no label seeded |
10 | DENİZBANK A.Ş. | no label seeded |
11 | DEUTSCHE BANK A.Ş. | no label seeded |
12 | FİBABANKA A.Ş. | no label seeded |
13 | HSBC BANK A.Ş. | no label seeded |
14 | ICBC TURKEY BANK A.Ş. | no label seeded |
15 | ING BANK A.Ş. | no label seeded |
16 | ODEA BANK A.Ş. | no label seeded |
17 | QNB FİNANSBANK A.Ş. | no label seeded |
18 | RABOBANK A.Ş. | no label seeded |
19 | SOCIETE GENERALE S.A. | no label seeded |
20 | ŞEKERBANK T.A.Ş. | no label seeded |
21 | T.C. ZİRAAT BANKASI A.Ş. | no label seeded |
22 | TURKISH BANK A.Ş. | no label seeded |
23 | TURKLAND BANK A.Ş. | no label seeded |
24 | TÜRK EKONOMİ BANKASI A.Ş. | no label seeded |
25 | TÜRKİYE GARANTİ BANKASI A.Ş. | no label seeded |
26 | TÜRKİYE HALK BANKASI A.Ş. | no label seeded |
27 | TÜRKİYE İŞ BANKASI A.Ş. | no label seeded |
28 | TÜRKİYE VAKIFLAR BANKASI T.A.O. | no label seeded |
29 | YAPI VE KREDİ BANKASI A.Ş. | no label seeded |
30 | ALBARAKA TÜRK KATILIM BANKASI A.Ş. | no label seeded |
31 | HAYAT FİNANS KATILIM BANKASI A.Ş. | no label seeded |
32 | KUVEYT TÜRK KATILIM BANKASI A.Ş. | no label seeded |
33 | T.O.M. KATILIM BANKASI A.Ş. | no label seeded |
34 | TÜRKİYE EMLAK KATILIM BANKASI A.Ş. | no label seeded |
35 | TÜRKİYE FİNANS KATILIM BANKASI A.Ş. | no label seeded |
36 | VAKIF KATILIM BANKASI A.Ş. | no label seeded |
37 | ZİRAAT KATILIM BANKASI A.Ş. | no label seeded |
currencyNumbercustomerAccountIdibanidget-vendor-external-detail-list-by-merchant-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
merchantIdget-vendor-external-detail-list-by-merchant-id › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
customerIdidisActivemerchantidvendorExternalNumbervendorExternalTypePermitted values — validated against the vendor_external_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SELLER | no label seeded |
2 | DISTRIBUTOR | no label seeded |
get-vendor-external-list-details
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalDetailsDto>.
| Field | Declared type | Nullable |
|---|---|---|
Accounts | List<VendorAccountDto> (collection) | no |
Distributors | List<VendorDistributorDto> (collection) | no |
Poses | List<VendorPosDto> (collection) | no |
Merchants | List<GetVendorExternalMerchantList.VendorExternalMerchantDto> (collection) | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-vendor-external-list-details › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
citizenNumbercustomerIdidisActivenametaxNumbervendorExternalNumbervendorExternalTypePermitted values — validated against the vendor_external_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SELLER | no label seeded |
2 | DISTRIBUTOR | no label seeded |
get-vendor-external-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as VendorExternalDto.
| Field | Declared type | Nullable |
|---|---|---|
CustomerId | Guid | no |
VendorExternalType | int | no |
VendorExternalNumber | string | no |
IsActive | bool | no |
MarketPaymentType | int? | yes |
TransferType | int? | yes |
Citizenid | string | no |
SellerName | string | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idget-vendor-external-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
citizenidcustomerIdidisActivemarketPaymentTypesellerNametransferTypevendorExternalNumbervendorExternalTypePermitted values — validated against the vendor_external_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SELLER | no label seeded |
2 | DISTRIBUTOR | no label seeded |
delete-vendor-external
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
iddelete-vendor-external › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-vendor-external-account-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalAccountDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
Iban | string | no |
CurrencyNumber | string | no |
BankCode | int | no |
CustomerAccountId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idget-vendor-external-account-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
bankCodePermitted values — validated against the bank_code parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
0 | Diğer | no label seeded |
1 | ADABANK A.Ş. | no label seeded |
2 | AKBANK T.A.Ş. | no label seeded |
3 | ALTERNATİFBANK A.Ş. | no label seeded |
4 | ANADOLUBANK A.Ş. | no label seeded |
5 | ARAP TÜRK BANKASI A.Ş. | no label seeded |
6 | BANK MELLAT | no label seeded |
7 | BANK OF CHINA TURKEY A.Ş. | no label seeded |
8 | BURGAN BANK A.Ş. | no label seeded |
9 | CITIBANK A.Ş. | no label seeded |
10 | DENİZBANK A.Ş. | no label seeded |
11 | DEUTSCHE BANK A.Ş. | no label seeded |
12 | FİBABANKA A.Ş. | no label seeded |
13 | HSBC BANK A.Ş. | no label seeded |
14 | ICBC TURKEY BANK A.Ş. | no label seeded |
15 | ING BANK A.Ş. | no label seeded |
16 | ODEA BANK A.Ş. | no label seeded |
17 | QNB FİNANSBANK A.Ş. | no label seeded |
18 | RABOBANK A.Ş. | no label seeded |
19 | SOCIETE GENERALE S.A. | no label seeded |
20 | ŞEKERBANK T.A.Ş. | no label seeded |
21 | T.C. ZİRAAT BANKASI A.Ş. | no label seeded |
22 | TURKISH BANK A.Ş. | no label seeded |
23 | TURKLAND BANK A.Ş. | no label seeded |
24 | TÜRK EKONOMİ BANKASI A.Ş. | no label seeded |
25 | TÜRKİYE GARANTİ BANKASI A.Ş. | no label seeded |
26 | TÜRKİYE HALK BANKASI A.Ş. | no label seeded |
27 | TÜRKİYE İŞ BANKASI A.Ş. | no label seeded |
28 | TÜRKİYE VAKIFLAR BANKASI T.A.O. | no label seeded |
29 | YAPI VE KREDİ BANKASI A.Ş. | no label seeded |
30 | ALBARAKA TÜRK KATILIM BANKASI A.Ş. | no label seeded |
31 | HAYAT FİNANS KATILIM BANKASI A.Ş. | no label seeded |
32 | KUVEYT TÜRK KATILIM BANKASI A.Ş. | no label seeded |
33 | T.O.M. KATILIM BANKASI A.Ş. | no label seeded |
34 | TÜRKİYE EMLAK KATILIM BANKASI A.Ş. | no label seeded |
35 | TÜRKİYE FİNANS KATILIM BANKASI A.Ş. | no label seeded |
36 | VAKIF KATILIM BANKASI A.Ş. | no label seeded |
37 | ZİRAAT KATILIM BANKASI A.Ş. | no label seeded |
currencyNumbercustomerAccountIdibanidcreate-vendor-external-account
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idcreate-vendor-external-account › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-vendor-external-account
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_10 | 400 | VENDOR_EXTERNAL_ACCOUNT_NOT_FOUND | Account cannot be found. :{0} |
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idvendorAccountIddelete-vendor-external-account › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-vendor-external-details-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as VendorExternalDetailsDto.
| Field | Declared type | Nullable |
|---|---|---|
Accounts | List<VendorAccountDto> (collection) | no |
Distributors | List<VendorDistributorDto> (collection) | no |
Poses | List<VendorPosDto> (collection) | no |
Merchants | List<GetVendorExternalMerchantList.VendorExternalMerchantDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idget-vendor-external-details-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
citizenNumbercustomerIdisActivenametaxNumbervendorExternalNumbervendorExternalTypePermitted values — validated against the vendor_external_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | SELLER | no label seeded |
2 | DISTRIBUTOR | no label seeded |
get-vendor-external-mail-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalMailDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
Email | string | no |
IsPriority | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-vendor-external-mail-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
emailidisPrioritycreate-vendor-external-mail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idcreate-vendor-external-mail › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idupdate-vendor-external-mail-priority
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idmailIdupdate-vendor-external-mail-priority › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-vendor-external-mail
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idmailIddelete-vendor-external-mail › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update-vendor-external-merchant-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idupdate-vendor-external-merchant-id › Request Body
isActivemerchantidupdate-vendor-external-merchant-id › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
get-vendor-external-phone-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalPhoneDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid? | yes |
PhoneNumber | string | no |
IsPriority | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-vendor-external-phone-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
idisPriorityphoneNumbercreate-vendor-external-phone
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idcreate-vendor-external-phone › Request Body
isPriorityphoneNumbercreate-vendor-external-phone › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
idupdate-external-vendor-phone-priority
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idphoneIdupdate-external-vendor-phone-priority › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-vendor-external-phone
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idphoneIddelete-vendor-external-phone › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-vendor-external-pos-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalPosDto>.
| Field | Declared type | Nullable |
|---|---|---|
VendorExternalPosId | Guid? | yes |
TerminalCode | string | no |
MccCode | int | no |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idget-vendor-external-pos-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-vendor-external-pos
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idcreate-vendor-external-pos › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-vendor-external-pos
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_43 | 400 | VENDOR_EXTERNAL_POS_NOT_FOUND | Pos cannot be found. :{0} |
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idvendorExternalPosIddelete-vendor-external-pos › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update-vendor-external-pos-status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_43 | 400 | VENDOR_EXTERNAL_POS_NOT_FOUND | Pos cannot be found. :{0} |
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idvendorExternalPosIdupdate-vendor-external-pos-status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
update vendor external status
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the update-vendor-external-status service definition through PUT /external-vendors/{id}/status.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idupdate vendor external status › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
get-vendor-external-distributor-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<VendorExternalDistributorDto>.
| Field | Declared type | Nullable |
|---|---|---|
VendorExternalDistributorId | Guid | no |
DistributorVendorExternalId | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-vendor-external-distributor-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-vendor-external-distributor
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
ERR_LOAN_83 | 400 | DISTRIBUTOR_NOT_FOUND | ExternalVendorId is not found for distributor to be added for vendor |
ERR_LOAN_87 | 400 | VENDOR_EXTERNAL_TYPE_MUST_BE_DISTRIBUTOR | The vendor_external_type must be defined as distributor for the distributor to be added. Id: {0} |
path Parameters
idcreate-vendor-external-distributor › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-vendor-external-distributor
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_LOAN_6 | 400 | VENDOR_EXTERNAL_NOT_FOUND | External vendor cannot be found. :{0} |
ERR_LOAN_84 | 400 | VENDOR_EXTERNAL_DISTRIBUTOR_NOT_FOUND | Vendor External Distributor Relation is not found. Id:{0} |
path Parameters
idvendorExternalDistributorIddelete-vendor-external-distributor › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.