vendors.md

Vendors

VendorsApi vendorsApi = client.getVendorsApi();

Class Name

VendorsApi

Methods

• Bulk Create Vendors
• Bulk Retrieve Vendors
• Bulk Update Vendors
• Create Vendor
• Search Vendors
• Retrieve Vendor
• Update Vendor

Bulk Create Vendors

Creates one or more Vendor objects to represent suppliers to a seller.

CompletableFuture<BulkCreateVendorsResponse> bulkCreateVendorsAsync(
    final BulkCreateVendorsRequest body)

Parameters

Parameter	Type	Tags	Description
body	BulkCreateVendorsRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

BulkCreateVendorsResponse

Example Usage

BulkCreateVendorsRequest body = new BulkCreateVendorsRequest.Builder(
    new LinkedHashMap<String, Vendor>() {{
        put("key0", new Vendor.Builder()
            .build());
        put("key1", new Vendor.Builder()
            .build());
    }}
)
.build();

vendorsApi.bulkCreateVendorsAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Bulk Retrieve Vendors

Retrieves one or more vendors of specified Vendor IDs.

CompletableFuture<BulkRetrieveVendorsResponse> bulkRetrieveVendorsAsync(
    final BulkRetrieveVendorsRequest body)

Parameters

Parameter	Type	Tags	Description
body	BulkRetrieveVendorsRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

BulkRetrieveVendorsResponse

Example Usage

BulkRetrieveVendorsRequest body = new BulkRetrieveVendorsRequest.Builder()
    .vendorIds(Arrays.asList(
        "INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4"
    ))
    .build();

vendorsApi.bulkRetrieveVendorsAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Bulk Update Vendors

Updates one or more of existing Vendor objects as suppliers to a seller.

CompletableFuture<BulkUpdateVendorsResponse> bulkUpdateVendorsAsync(
    final BulkUpdateVendorsRequest body)

Parameters

Parameter	Type	Tags	Description
body	BulkUpdateVendorsRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

BulkUpdateVendorsResponse

Example Usage

BulkUpdateVendorsRequest body = new BulkUpdateVendorsRequest.Builder(
    new LinkedHashMap<String, UpdateVendorRequest>() {{
        put("key0", new UpdateVendorRequest.Builder(
            new Vendor.Builder()
                .build()
        )
        .build());
        put("key1", new UpdateVendorRequest.Builder(
            new Vendor.Builder()
                .build()
        )
        .build());
    }}
)
.build();

vendorsApi.bulkUpdateVendorsAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Create Vendor

Creates a single Vendor object to represent a supplier to a seller.

CompletableFuture<CreateVendorResponse> createVendorAsync(
    final CreateVendorRequest body)

Parameters

Parameter	Type	Tags	Description
body	CreateVendorRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

CreateVendorResponse

Example Usage

CreateVendorRequest body = new CreateVendorRequest.Builder(
    "idempotency_key2"
)
.build();

vendorsApi.createVendorAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Search Vendors

Searches for vendors using a filter against supported Vendor properties and a supported sorter.

CompletableFuture<SearchVendorsResponse> searchVendorsAsync(
    final SearchVendorsRequest body)

Parameters

Parameter	Type	Tags	Description
body	SearchVendorsRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.

Response Type

SearchVendorsResponse

Example Usage

SearchVendorsRequest body = new SearchVendorsRequest.Builder()
    .build();

vendorsApi.searchVendorsAsync(body).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Retrieve Vendor

Retrieves the vendor of a specified Vendor ID.

CompletableFuture<RetrieveVendorResponse> retrieveVendorAsync(
    final String vendorId)

Parameters

Parameter	Type	Tags	Description
vendorId	String	Template, Required	ID of the Vendor to retrieve.

Response Type

RetrieveVendorResponse

Example Usage

String vendorId = "vendor_id8";

vendorsApi.retrieveVendorAsync(vendorId).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});

Update Vendor

Updates an existing Vendor object as a supplier to a seller.

CompletableFuture<UpdateVendorResponse> updateVendorAsync(
    final UpdateVendorRequest body,
    final String vendorId)

Parameters

Parameter	Type	Tags	Description
body	UpdateVendorRequest	Body, Required	An object containing the fields to POST for the request. See the corresponding object definition for field details.
vendorId	String	Template, Required	-

Response Type

UpdateVendorResponse

Example Usage

UpdateVendorRequest body = new UpdateVendorRequest.Builder(
    new Vendor.Builder()
        .id("INV_V_JDKYHBWT1D4F8MFH63DBMEN8Y4")
        .name("Jack's Chicken Shack")
        .version(1)
        .status("ACTIVE")
        .build()
)
.idempotencyKey("8fc6a5b0-9fe8-4b46-b46b-2ef95793abbe")
.build();

String vendorId = "vendor_id8";

vendorsApi.updateVendorAsync(body, vendorId).thenAccept(result -> {
    // TODO success callback handler
    System.out.println(result);
}).exceptionally(exception -> {
    // TODO failure callback handler
    exception.printStackTrace();
    return null;
});