Mỗi sản phẩm SelSup cần một thương hiệu. Đối với các sản phẩm không có thương hiệu, hãy tạo ra một bản ghi No brand chuyên dụng trước tiên và sử dụng nhận dạng của nó trong thẻ sản phẩm.
/api/brand
Các dòng công việc sẵn sàng sử dụng
Các dòng công việc sẵn sàng sử dụng
01
Tìm hoặc tạo thương hiệu trước khi tạo sản phẩm
Tìm tên chính xác trước, nếu hàng trống, hãy tạo nhãn hiệu và lưu trữ nhãn hiệu ID cho thẻ sản phẩm.
Gọi GET /api/brand/find với truy vấn và count=true.
So sánh tên trong đơn xin việc của bạn.
Nếu không có sự phù hợp, gửi POST /api/brand với tên.
Sử dụng brandId từ phản ứng khi tạo mô hình sản phẩm.
Các trường logo xuất hiện sau khi tải lên một hình ảnh. Các trường mô hình chia sẻ không tham gia vào API này được cố ý bỏ qua.
Brand10 trường
brandIdinteger
Chỉ số thương hiệu trong tài khoản SelSup hiện tại.
read-only
namestring
Tên thương hiệu. không gian dẫn và sau được loại bỏ khi được lưu.
Bắt buộc
logoUrlstring
URL công khai của logo hiện tại.
read-only
logoSizeinteger
Kích thước logo trong byte.
read-only
logoWidthinteger
Độ rộng logo trong pixel.
read-only
logoHeightinteger
Độ cao logo trong pixel.
read-only
deletedboolean
Nếu thương hiệu được lưu trữ.
ozonNamestring
Tên thương hiệu trong danh mục Ozon.
nullable
ozonIdinteger · int64
Định dạng thương hiệu ở Ozon.
nullable
oneCIdstring
Chỉ số thương hiệu bên ngoài trong 1C.
nullable
Hợp đồng lỗi
Cách trả lại lỗi ứng dụng
Mã error giống nhau ở mọi địa điểm, trong khi thông điệp đối diện người dùng được dịch bởi máy chủ. Xây dựng logic ứng dụng xung quanh error và sử dụng localMessage chỉ cho hiển thị.
error
Mã máy tính có thể đọc ổn định cho logic tích hợp.
localMessage
Thông điệp sẵn sàng hiển thị trong ngôn ngữ của người dùng mã thông báo API.
params
Các giá trị được máy chủ liên kết vào mẫu tin nhắn địa phương.
文
localMessage sử dụng trường lang của người dùng sở hữu mã thông báo API. Ngôn ngữ tài liệu và tiêu đề Accept-Language không thay đổi nó; tiếng Nga được sử dụng khi người dùng không có ngôn ngữ được cấu hình.
RUUser locale là ru
{
"error": "error_brand_already_exists",
"localMessage": "Бренд Base уже существует",
"params": {
"name": "Base"
}
}
VNTiếng Việt (vn)
{
"error": "error_brand_already_exists",
"localMessage": "Thương hiệu Base đã tồn tại",
"params": {
"name": "Base"
}
}
Điểm cuối
Điểm cuối
GET
Tìm thương hiệu
/api/brand/find
Tấm mã với truy cập đọc
Điểm cuối chính cho danh sách, tìm kiếm và đồng bộ hóa. Nó trả lại các thương hiệu từ tài khoản hiện tại và hỗ trợ trang web ổn định.
i
total chỉ được trả lại khi count=true. Khóa tính toán cho các trang tiếp theo.
Các tham số truy vấn
Trường
Loại
Bắt buộc
Mô tả
query
string
Không
Substring để tìm kiếm trong tên thương hiệu.
deleted
boolean
Không
đúng cho lưu trữ, sai cho hoạt động.
brandOneCId
string
Không
Định dạng chính xác của 1C bên ngoài.
hasOzonId
boolean
Không
đúng để trả lại chỉ các thương hiệu được lập bản đồ cho Ozon.
limitGiá trị mặc định: 50
integer
Không
Đăng ký mỗi trang, lên đến 500.
pageGiá trị mặc định: 1
integer
Không
Số trang bắt đầu từ 1.
countGiá trị mặc định: false
boolean
Không
Bao gồm tổng số trận đấu tổng cộng.
sortBy
stringNAME, BRANDID
Không
Tên cho tên thương hiệu, BRANDID cho nhận dạng bên trong.
ascendingGiá trị mặc định: false
boolean
Không
đúng cho sự tăng lên, sai cho sự giảm xuống.
curl --request GET 'https://api.selsup.ru/api/brand/find?query=Base&limit=50&page=1&count=true&sortBy=NAME&ascending=true' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
GET
Danh sách tất cả các thương hiệu
/api/brand/all
Tấm mã với truy cập đọc
Trả lại mọi thương hiệu trong tài khoản, sắp xếp theo tên.
i
Đối với thư mục lớn và đồng bộ hóa lặp lại, sử dụng /find với pagination.
curl --request GET 'https://api.selsup.ru/api/brand/all' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
GET
Nhận một thương hiệu bằng ID
/api/brand/{brandId}
Tấm mã với truy cập đọc
Trả lại một thương hiệu từ tài khoản hiện tại bằng danh tính nội bộ của nó.
i
Việc thực hiện hiện hiện tại trả về một giá trị trống cho một brandId không rõ thay vì HTTP 404. xử lý một phản ứng trống.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
brandId
integer
Có
Định dạng thương hiệu trong SelSup.
curl --request GET 'https://api.selsup.ru/api/brand/8124' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
POST
Tạo một thương hiệu
/api/brand
Tấm mã với quyền truy cập viết
Tạo một thương hiệu trong tài khoản hiện tại. Tên là đủ cho trường hợp thông thường.
i
Tên được so sánh không nhạy cảm với trường hợp; Base và base được coi là cùng một thương hiệu.
Cơ quan yêu cầu
application/json
Trường
Loại
Bắt buộc
Mô tả
name
string
Có
Tên thương hiệu độc đáo, không trống rỗng.
ozonName
string
Không
Tên từ thư mục Ozon, khi được biết.
ozonId
integer · int64
Không
ID thương hiệu Ozon khi thẻ được gửi mà không cần nhập khẩu trước đó.
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
400error_empty_brand_name
Tên thương hiệu không được chỉ định
tên bị thiếu, trống rỗng, hoặc chỉ chứa không gian trắng.
400error_brand_already_exists
Thương hiệu {name} đã tồn tại
Tài khoản đã có một sự phù hợp không nhạy cảm với trường hợp. params.name chứa tên mâu thuẫn.
400error_subscription_expired
Đăng ký của bạn đã hết hạn. Thanh toán cước phí để tiếp tục sử dụng dịch vụ.
Hãy trả thuế để tiếp tục sử dụng dịch vụ. Sử dụng error_subscription_expired trong logic tích hợp.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
PUT
Tải đổi thương hiệu
/api/brand/{brandId}
Tấm mã với quyền truy cập viết
Thay thế các trường thương hiệu có thể chỉnh sửa. ID đến từ URL; không gửi brandId trong JSON.
i
Đây là PUT, vì vậy bao gồm tất cả các giá trị bạn cần để bảo tồn. Các trường logo được quản lý bởi các điểm cuối riêng biệt.
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
400error_empty_brand_name
Tên thương hiệu không được chỉ định
tên bị thiếu, trống rỗng, hoặc chỉ chứa không gian trắng.
400error_brand_already_exists
Thương hiệu {name} đã tồn tại
Tài khoản đã có một sự phù hợp không nhạy cảm với trường hợp. params.name chứa tên mâu thuẫn.
400error_subscription_expired
Đăng ký của bạn đã hết hạn. Thanh toán cước phí để tiếp tục sử dụng dịch vụ.
Hãy trả thuế để tiếp tục sử dụng dịch vụ. Sử dụng error_subscription_expired trong logic tích hợp.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
DELETE
Xóa, lưu trữ hoặc khôi phục một thương hiệu
/api/brand/{brandId}
Tấm mã với quyền truy cập viết
Với delete=true, SelSup cố gắng xóa cứng. Nếu có tham chiếu, nó sẽ lưu trữ thương hiệu thay vào đó. deleted=false khôi phục nó.
Các tham chiếu đã ngăn chặn việc xóa, vì vậy thương hiệu đã được lưu trữ.
brand_has_been_restore
Thương hiệu đã được khôi phục từ hồ sơ.
"brand_signed_as_deleted"
Hầm lẫn3
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
POST
Lên lên logo
/api/brand/{brandId}/image
Tấm mã với quyền truy cập viết
Tải lên một hình ảnh như multipart/form-data. Một logo hiện có được thay thế.
i
Gửi tập tin nhị phân trong tập tin; điểm cuối này không chấp nhận JSON.
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
400error_brand_to_found
Không tìm thấy thương hiệu {name}
BrandId không tồn tại trong tài khoản hiện tại. Tài liệu bảo quản mã error chính xác như được trả về bởi API.
400error_wrong_image_format
Định dạng hình ảnh không chính xác cho tệp: {name}
Dữ liệu không thể được giải mã như một định dạng hình ảnh được hỗ trợ.
400error_max_upload_size_exceeded
Kích thước tệp được phép đã bị vượt quá
Các yêu cầu đa phần vượt quá giới hạn tải lên máy chủ.
400error_subscription_expired
Đăng ký của bạn đã hết hạn. Thanh toán cước phí để tiếp tục sử dụng dịch vụ.
Hãy trả thuế để tiếp tục sử dụng dịch vụ. Sử dụng error_subscription_expired trong logic tích hợp.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
DELETE
Xóa logo
/api/brand/{brandId}/image
Tấm mã với quyền truy cập viết
Xóa tệp logo và đặt lại kích thước của nó trong hồ sơ thương hiệu.
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
400error_brand_to_found
Không tìm thấy thương hiệu {name}
BrandId không tồn tại trong tài khoản hiện tại. Tài liệu bảo quản mã error chính xác như được trả về bởi API.
400error_empty_brand_logo
Thương hiệu không có hình ảnh
Việc xóa logo được yêu cầu cho một thương hiệu không có logo.
400error_cant_remove_brand_logo
Không thể xóa hình ảnh thương hiệu
Chất lưu trữ không thể xóa tệp hoặc cập nhật hồ sơ thương hiệu.
400error_subscription_expired
Đăng ký của bạn đã hết hạn. Thanh toán cước phí để tiếp tục sử dụng dịch vụ.
Hãy trả thuế để tiếp tục sử dụng dịch vụ. Sử dụng error_subscription_expired trong logic tích hợp.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.
POST
Tái bản hợp nhất
/api/brand/{brandId}/merge/{removeBrandId}
Tấm mã với quyền truy cập viết
Di chuyển các mô hình sản phẩm từ RemoveBrandId sang BrandId, sau đó xóa vĩnh viễn Remove BrandId.
i
Điều này không thể được hủy bỏ. BrandId được giữ lại; removeBrandId là bản sao để loại bỏ.
Các tham số đường
Trường
Loại
Bắt buộc
Mô tả
brandId
integer
Có
Định dạng thương hiệu chính.
removeBrandId
integer
Có
Tái danh hiệu thương hiệu để xóa.
curl --request POST 'https://api.selsup.ru/api/brand/8124/merge/9012' \
--header 'Authorization: YOUR_API_TOKEN'
Các lỗi ứng dụng thường được trả về như JSON với error, localMessage và params. Nhánh trên error; văn bản địa phương có thể thay đổi. Cách trả lại lỗi ứng dụng ↑
401auth_required
Định nghĩa xác thực cần thiết
Authorization bị mất tích, trống rỗng hoặc chứa một token không hợp lệ.
400error_access_denied
Truy cập bị từ chối
Các token tồn tại, nhưng vai trò của nó không thể thực hiện hoạt động này.
400error_brand_not_found
Không tìm thấy thương hiệu: {name}
Một trong những thương hiệu được yêu cầu hợp nhất không tồn tại trong tài khoản hiện tại.
400error_subscription_expired
Đăng ký của bạn đã hết hạn. Thanh toán cước phí để tiếp tục sử dụng dịch vụ.
Hãy trả thuế để tiếp tục sử dụng dịch vụ. Sử dụng error_subscription_expired trong logic tích hợp.
500error_unknown
Một lỗi không rõ đã xảy ra. Nếu sự cố vẫn tiếp diễn, hãy liên hệ với bộ phận hỗ trợ
Thất bại nội bộ: tiết kiệm thời gian yêu cầu và hỗ trợ liên lạc; đừng mù quáng thử lại đột biến.