VU CUSTOM
Developer Docs
User GuidesDeveloper DocsBest Practice and FAQs
Developer Docs
User GuidesDeveloper DocsBest Practice and FAQs
  • VU OS Admin API Overview
  • Account Management
    • Overview
    • Create a sold_to_account
    • Create a ship_to_account
    • Batch update sold_to_account
    • Batch update ship_to_account
    • Get a list of sold_to_accounts
    • Get a list of ship_to_accounts
    • Delete a sold_to_account
    • Delete a ship_to_account
  • Orders
    • Overview
    • Create an order
    • Get an order
    • Get a list of orders
    • Update an order
    • Delete an order
    • Add tags to an order
    • Add tags to many orders
    • Delete tags from an order
    • Delete tags from many orders
  • Products
    • Overview
    • Create a product
    • Get a list of products
    • Get a specific product
    • Delete a product
  • Recipes
    • Overview
    • Retrieving Recipes
  • Fulfillments
    • Overview
    • Create a fulfillment
    • Retrieve a fulfillment
    • Retrieve a list of fulfillments
  • Order Lines
    • Overview
    • Add tags to an order line
    • Retrieve a list of orderlines
    • Retrieve a specific order line
    • Delete tags from an order line
    • Update a specific order line
  • Integration
    • Integrate the Customizer with Your Frontend
    • Understanding Recipe IDs in VU Custom
    • Styling the Customizer
    • Test the Customizer
Powered by GitBook
On this page
  • Introduction
  • Key Features
  • Authentication
  • Getting Help

VU OS Admin API Overview

Introduction

Admin API enables you to programmatically interact with VU OS, allowing you to build integrations and automate workflows. With this API, you can manage orders, products, fulfillments, and customer data.

Key Features

  • Customer Data: Handle customer accounts and addresses (CRUD)

  • Order Management: Create, retrieve, and update orders and tags (CRUD)

  • Product Catalog: Manage products (CRUD)

  • Recipes: Retrieve recipes based on recipe ID

  • Fulfillment Tracking: Track shipping and delivery information

Webhook Support: Receive real-time notifications of important events

Authentication

All Admin API queries require a valid API key and secret. Please contact your assigned Solution Architect to obtain these. Once you have these here is what the request should look like:

  • Use HTTPS

  • Include authentication credentials

  • Specify an API version

  • Set the Content-Type header to application/json.

The API accepts and returns JSON data.

Example request:

curl -X GET 'https://admin.vucustom.com/api/2024-01/products' \
  -u username:password \
  -H 'Content-Type: application/json'

API Versioning

The API is versioned to ensure stability for your integrations. Include the version in all API requests:

https://admin.vucustom.com/api/{api_version}/{resource}

Current version: v1

Getting Help

  1. Use the search feature in this documentation portal to find answers first.

  2. Contact your Solution Architect for technical support if you don't find answers in this documentation portal.

NextOverview

Last updated 4 months ago