Class ShopManager

Returns ShopManager

Returns Promise<GetAuthorisedResellerBrandResponse>

A promise that resolves to the authorised reseller brand response containing:

• is_authorised_reseller: Whether the shop is authorised reseller
• total_count: Number of authorised brands linked with the shop
• more: Whether there are more pages
• authorised_brand_list: List of authorised brands with brand_id and brand_name

const brands = await sdk.shop.getAuthorisedResellerBrand({
  page_no: 1,
  page_size: 10
});
console.log('Is authorised reseller:', brands.response.is_authorised_reseller);
console.log('Total brands:', brands.response.total_count);
brands.response.authorised_brand_list.forEach(brand => {
  console.log('Brand:', brand.brand_name);
});
Copy

Returns Promise<GetBRShopOnboardingInfoResponse>

Returns Promise<GetProfileResponse>

A promise that resolves to the profile response containing:

• shop_logo: The Image URL of the shop logo
• description: The content of the shop description
• shop_name: The content of the shop name
• invoice_issuer: The invoice issuer information for BR CNPJ seller only

const profile = await sdk.shop.getProfile();
console.log('Shop name:', profile.response.shop_name);
console.log('Shop logo:', profile.response.shop_logo);
Copy

Returns Promise<GetShopHolidayModeResponse>

Returns Promise<GetShopInfoResponse>

A promise that resolves to the shop info response containing:

• shop_name: Name of the shop
• region: Shop's area
• status: Shop status (BANNED, FROZEN, NORMAL)
• is_cb: Whether the shop is a cross-border shop
• auth_time: Timestamp when shop was authorized
• expire_time: Expiration date for shop authorization
• is_sip: Whether it's a SIP primary/affiliate shop
• Additional fields for merchant info, fulfillment type, etc.

const shopInfo = await sdk.shop.getShopInfo();
console.log('Shop name:', shopInfo.shop_name);
console.log('Region:', shopInfo.region);
console.log('Status:', shopInfo.status);
Copy

Returns Promise<GetShopNotificationResponse>

A promise that resolves to the notification response containing:

• cursor: Last notification_id returned in the page
• data: Notification data with create_time, content, title, and url

const notifications = await sdk.shop.getShopNotification({
  page_size: 10
});
console.log('Title:', notifications.data.title);
console.log('Content:', notifications.data.content);
console.log('Cursor:', notifications.cursor);
Copy

Returns Promise<GetWarehouseDetailResponse>

A promise that resolves to the warehouse detail response containing:

• warehouse_id: Warehouse address identifier
• warehouse_name: The warehouse name
• warehouse_type: Type of warehouse
• location_id: Location identifier for stocks
• address_id: Identity of address
• region, state, city, address: Location details
• zipcode, district, town, state_code: Additional location info
• holiday_mode_state: Holiday mode status

const warehouses = await sdk.shop.getWarehouseDetail({
  warehouse_type: 1 // Pickup warehouse
});
warehouses.response.forEach(wh => {
  console.log('Warehouse:', wh.warehouse_name);
  console.log('Location ID:', wh.location_id);
});
Copy

Returns Promise<SetShopHolidayModeResponse>

Returns Promise<UpdateProfileResponse>

A promise that resolves to the updated profile response

const result = await sdk.shop.updateProfile({
  shop_name: 'New Shop Name',
  description: 'Welcome to our shop. Quality products at great prices!'
});
console.log('Updated shop:', result.response.shop_name);
Copy