1. Introduction to our API
ADG
  • Introduction to our API
    • Product Catalog
    • Webhooks Overview
    • Notifications Guide
    • Getting Started
    • Overview
  • User
    • Client
      • Generate Service Client Access Token
    • User
      • Login User by Username and Password
      • Login User with Refresh Token
    • Schemas
      • AssignUserRoleDto
      • BulkResponse
      • BulkResponseItem
      • ClientTokenResponseDTO
      • ConflictErrorResponse
      • CreateInvitationDto
      • CreateInvitationDtoBulkModel
      • CreateInvitationResponse
      • CreateRoleDTO
      • CreateServiceClientDto
      • CreateServiceClientResponseDTO
      • CreateUserDto
      • CreateVendorInvitationDto
      • CreateVendorInvitationDtoBulkModel
      • CreateVendorInvitationResponse
      • DeleteInvitationResponse
      • DeleteVendorInvitationResponse
      • Error
      • ExternalErrorResponse
      • ForbiddenErrorResponse
      • ForgotPasswordDTO
      • FutureAssociationsDTO
      • GetInvitationResponse
      • GetInvitationsByMerchantIdResponse
      • GetInvitationsByMerchantIdResponseDto
      • GetServiceClientTokenDto
      • GetVendorInvitationResponse
      • GetVendorInvitationsByVendorIdResponse
      • GetVendorInvitationsByVendorIdResponseDto
      • InvitationDeliveryMethodEnum
      • InvitationDeliveryResponse
      • InvitationStatusEnum
      • InvitationsByMerchantIdSortByEnum
      • LoginUserDto
      • LoginUserWithAuthorizationCode
      • LoginUserWithRefreshToken
      • NotFoundErrorResponse
      • OnboardUserDto
      • PasswordPolicyDTO
      • PatchUserDTO
      • PermissionDTO
      • PermissionSet
      • PermissionSetsRequestDTO
      • PermissionSetsResponseDTO
      • ResendInvitationResponse
      • ResendVendorInvitationResponse
      • ResetPasswordDTO
      • ResourceDTO
      • RoleDTO
      • RolePermissionDTO
      • RoleWithPermissionDTO
      • SearchRolesEnum
      • SearchRolesResponseDTO
      • SearchUsersEnum
      • SearchUsersResponseDTO
      • ServiceClientResponseDTO
      • StringBulkModel
      • TokenResponseDTO
      • UnassignUserRoleDTO
      • UnauthorizedErrorResponse
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateAssociationTypeDTO
      • UpdateAttributesDto
      • UpdateRoleDTO
      • UpdateRolePermissionsDTO
      • UserResponseDTO
      • ValidateEmailsResponse
      • ValidationErrorResponse
      • ValidationResponseDTO
  • Order
    • OrderItems
      • Search for order items based on various criteria and filters
    • Orders
      • Create a New Order.
      • Search for orders based on various criteria and filters.
      • Create multiple orders
      • Retrieve multiple orders
      • Update multiple orders
      • Retrieve a list of orders
      • Retrieve an order by Order ID.
      • Update order data.
      • Retrieve an order by Safe ID
      • Retrieve order item by Order Item ID
      • Update an item within an order.
      • Cancel Order or order items
      • Change the order status to Customer Care Hold
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order.
      • Retrieve audit logs for a specific order item.
      • Add a Refund Request.
    • Schemas
      • APIClientInfoModel
      • AddRefundItemModel
      • AddRefundModel
      • AddressModel
      • AttributeModel
      • BaseAddressModel
      • BillingInfoModel
      • BulkResponse
      • BulkResponseItem
      • CancelOrderItemModel
      • CancelOrderModel
      • CancelOrderResponse
      • ConflictErrorResponse
      • CoordinatesModel
      • CreateOrderCustomerPaymentMethodModel
      • CreateOrderCustomerTransactionModel
      • CreateOrderItemImageModel
      • CreateOrderItemModel
      • CreateOrderModel
      • CreateOrderModelBulkModel
      • CreateOrderResponse
      • CustomerCareHoldOrderResponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetOrderCustomerPaymentMethodModel
      • GetOrderCustomerTransactionModel
      • GetOrderItemImageModel
      • GetOrderItemModel
      • GetOrderItemRefundDataItemModel
      • GetOrderItemRefundDataModel
      • GetOrderItemResponse
      • GetOrderModel
      • GetOrderResponse
      • GetOrdersCountByStatusResponse
      • GetOrdersPollingStoppedCountResponse
      • InsertModel
      • ListOrderModel
      • ListOrdersResponse
      • NotFoundErrorResponse
      • OptionModel
      • OrderItemStatus
      • OrderStatus
      • OrdersCountByStatus
      • PriceModel
      • ProcessingLockModel
      • RefreshProcessingModel
      • RefreshProcessingResponse
      • ReprintCostCoverageModel
      • ReprintModel
      • ReprintShipmentItemModel
      • ReprintShipmentModel
      • ResourceFormat
      • SearchOrderItemsResponse
      • SearchOrderModel
      • SearchOrdersResponse
      • ShipmentMetadata
      • StartProcessingModel
      • StartProcessingResponse
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateOrderItemImageModel
      • UpdateOrderItemModel
      • UpdateOrderItemResponse
      • UpdateOrderModel
      • UpdateOrderModelBulkModel
      • UpdateOrderResponse
      • UpdatePriceModel
      • ValidationErrorResponse
      • VariantAttribute
      • VariantOption
  • Note
    • Notes
      • Create a New Note
      • Search All Notes
      • View Note by ID
      • Update Note
      • Delete Note
      • View Note Audit Logs
    • Schemas
      • CreateNoteModel
      • CreateNoteReponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetNoteByIdResponse
      • GetNoteResponseItemModel
      • GetNotesResponse
      • NotFoundErrorResponse
      • ResourceFormat
      • ResourceReferenceModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateNotePayload
      • UpdateNoteResponse
      • UserReferenceModel
      • ValidationErrorResponse
  • Catalog
    • Categories
      • View all product categories
      • Create a new category
      • Update category
      • Delete category
      • Get audit logs of a category
    • MerchantCatalog
      • Create a merchant catalog
      • Update a merchant catalog
      • Partially update a merchant catalog
      • Get a list of merchant catalogs
      • Delete a merchant catalog
      • Get a merchant catalog and search variants in it
      • Get a merchant catalog with variants
      • Get a list of variants the merchant can use in accordance with their enabled catalog
      • Search for variants in enabled merchant catalog with fallback to global catalog
      • Get audit logs of a merchant catalog
    • Products
      • View all products
      • Retrieve product variant details
      • Create a new product
      • Search products
      • Bulk create products
      • Bulk update products
      • Update product
      • Delete product
      • Update variant
      • Get audit logs of a product
    • Variants
      • Delete variant
      • Create a variant
      • Search product variants
      • Get audit logs of a variant
    • MerchantVariants
      • Add new variants to a merchant catalog
      • Update a merchant catalog variants
      • Update a merchant catalog by removing variants
    • Schemas
      • AddMerchantVariantsDto
      • AddMerchantVariantsResponse
      • BulkResponse
      • BulkResponseItem
      • Category
      • CategoryGetChangesResponse
      • CategoryModel
      • CreateCategoryModel
      • CreateCategoryResponse
      • CreateMerchantCatalogDto
      • CreateMerchantCatalogResponse
      • CreatePrintMethodDto
      • CreatePrintMethodResponse
      • CreateProductModel
      • CreateProductModelBulkModel
      • CreateProductResponse
      • CreateVariantModel
      • CreateVariantResult
      • DecorationModel
      • DeleteMerchantVariantsDto
      • DeleteMerchantVariantsResponse
      • Error
      • ForbiddenErrorResponse
      • GetAuditLogResponse
      • GetCategoriesResponse
      • GetEffectiveProductsResponse
      • GetEffectiveVariantListResponse
      • GetEffectiveVariantsByProductResponse
      • GetPrintMethodResponse
      • GetPrintMethodsResponse
      • GetProductVariantsResponse
      • GetProductsResponse
      • ListMerchantCatalogsResponse
      • MerchantCatalogDto
      • MerchantVariantAttributeDto
      • MerchantVariantDto
      • Meta
      • MultiPrice
      • MultiPriceModel
      • NotFoundErrorResponse
      • PrintMethod
      • PatchMerchantCatalogDto
      • PatchMerchantCatalogResponse
      • Price
      • PriceModel
      • PrintImageModel
      • PrintImageUploadStatus
      • PrintMethodDto
      • ProblemDetails
      • Product
      • ProductAttribute
      • ProductAttributeModel
      • ProductAttributeValue
      • ProductAttributeValueModel
      • ProductExtra
      • ProductExtraModel
      • ProductGetChangesResponse
      • ProductModel
      • ProductStatus
      • ResourceFormat
      • SearchEffectiveVariantsDto
      • SearchEffectiveVariantsResponse
      • SearchEffectiveVariantsSeparateDto
      • SearchEffectiveVariantsSeparateResponse
      • SearchMerchantCatalogVariantsResponse
      • SearchMerchantVariantDto
      • SearchProductsResponse
      • SearchVariantsModel
      • StringAuditEvent
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdateCategoryModel
      • UpdateMerchantCatalogDto
      • UpdateMerchantCatalogResponse
      • UpdateMerchantVariantsDto
      • UpdateMerchantVariantsResponse
      • UpdatePrintMethodDto
      • UpdatePrintMethodResponse
      • UpdateProductModel
      • UpdateProductModelBulkModel
      • UpdateProductResponse
      • UpdateProductVariantModel
      • UpdateProductVariantResponse
      • ValidationErrorResponse
      • Variant
      • VariantAttribute
      • VariantAttributeModel
      • VariantDecoration
      • VariantExtra
      • VariantExtraModel
      • VariantGetChangesResponse
      • VariantModel
  • Shipment
    • Packing Slip
      • Generates a packing slip for a specific shipment by Shipment ID.
    • Shipments
      • Get details of a specific shipment by Shipment ID.
      • Update details of a specific shipment by Shipment ID.
      • Create packages for a specific shipment.
      • Delete shipment with packages.
      • Get all shipments for an order by Order ID.
      • Create shipment for order, vendor, and order items.
      • Get shipment with packages for order and vendor.
      • Get shipment details by Order Item ID.
      • Update a specific shipment package.
      • Delete a specific shipment package.
      • Cancel shipment.
      • Unassign items to shipment.
      • Shipment resubmission to assigned facility.
      • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
      • Search shipments.
      • Reroute shipment.
      • Rejects a shipment.
      • Bulk reroute shipments.
      • Get shipment audit logs.
      • Get package audit logs.
      • Get message audit logs for shipment updates.
      • Assign Shipment.
    • Schemas
      • AssignDTO
      • AssignShipmentResponse
      • BulkResponse
      • BulkResponseItem
      • CancelShipmentDto
      • ConflictErrorResponse
      • CountryCodes
      • CreatePackageDTO
      • CreatePackagesResponse
      • CreateShipmentDTO
      • CreateShipmentResponse
      • CurrencyCodes
      • Error
      • ExternalErrorResponse
      • ForbiddenErrorResponse
      • GeneratePackingSlipResponse
      • GetAuditLogResponse
      • GetOrdersCountByFacilityResponse
      • GetPackageResponse
      • GetShipmentPollingStoppedCountResponse
      • GetShipmentsCountByStatusResponse
      • GetVendorShipmentsCountByStatusResponse
      • LanguageCodes
      • NotFoundErrorResponse
      • OrderCount
      • OrderItem
      • OrderItemDTO
      • OrderItemImage
      • OrderItemImageDTO
      • OrderItemStatus
      • PackageDTO
      • PackageOrderItemDTO
      • PackingSlipDto
      • Price
      • Reject
      • RejectResponse
      • ReprintDTO
      • Reroute
      • RerouteBulkModel
      • RerouteOrderItem
      • RerouteResponse
      • ResourceFormat
      • SearchShipmentModel
      • SearchShipmentResponse
      • SelectedCarrierShippingServiceMethod
      • SelectedCarrierShippingServiceMethodDTO
      • SelectedShippingMapping
      • SelectedShippingMappingDTO
      • SelectedShippingMappingMethod
      • SelectedShippingMappingMethodDTO
      • SelectedVendorMapping
      • SelectedVendorMappingDTO
      • ShipmentDTO
      • ShipmentStatus
      • ShipmentsCountByStatus
      • ShippingAddressDTO
      • StringAuditEvent
      • UnassignOrderItemDTO
      • UnauthorizedResult
      • UnhandledErrorResponse
      • UpdatePackageDTO
      • UpdateShipmentDTO
      • ValidationErrorResponse
      • VendorCostDTO
      • VendorCostShippingDTO
      • VendorCostVasEntryDTO
      • VendorCreatePackagesResponse
      • VendorOrderItemModel
      • VendorPackageModel
      • VendorReassignShipmentDTO
      • VendorReassignShipmentResponse
      • VendorRejectShipmentDTO
      • VendorSearchShipmentModel
      • VendorSearchShipmentResponse
      • VendorShipmentResponse
      • VendorUpdateShipmentStatusEnumDTO
      • VendorUpdateTrackingDTO
      • VendorUploadItemImageDTO
      • VendorUploadItemImageResponse
  • Schemas
    • Schemas
      • CreateNoteModel
      • APIClientInfoModel
      • CreateNoteReponse
      • AddRefundItemModel
      • AddRefundModel
      • Error
      • AddressModel
      • ForbiddenErrorResponse
      • AttributeModel
      • GetAuditLogResponse
      • GetNoteByIdResponse
      • BaseAddressModel
      • GetNoteResponseItemModel
      • BillingInfoModel
      • GetNotesResponse
      • BulkResponse
      • BulkResponseItem
      • NotFoundErrorResponse
      • CancelOrderItemModel
      • ResourceFormat
      • ResourceReferenceModel
      • CancelOrderModel
      • CancelOrderResponse
      • StringAuditEvent
      • ConflictErrorResponse
      • UnauthorizedResult
      • CoordinatesModel
      • UnhandledErrorResponse
      • UpdateNotePayload
      • CreateOrderCustomerPaymentMethodModel
      • UpdateNoteResponse
      • CreateOrderCustomerTransactionModel
      • UserReferenceModel
      • CreateOrderItemImageModel
      • CreateOrderItemModel
      • ValidationErrorResponse
      • CreateOrderModel
      • CreateOrderModelBulkModel
      • CreateOrderResponse
      • CustomerCareHoldOrderResponse
      • GetOrderCustomerPaymentMethodModel
      • GetOrderCustomerTransactionModel
      • GetOrderItemImageModel
      • GetOrderItemModel
      • GetOrderItemRefundDataItemModel
      • GetOrderItemRefundDataModel
      • GetOrderItemResponse
      • GetOrderModel
      • GetOrderResponse
      • GetOrdersCountByStatusResponse
      • GetOrdersPollingStoppedCountResponse
      • ListOrderModel
      • ListOrdersResponse
      • OptionModel
      • OrderItemStatus
      • OrderStatus
      • OrdersCountByStatus
      • PriceModel
      • RefreshProcessingModel
      • RefreshProcessingResponse
      • ReprintCostCoverageModel
      • ReprintModel
      • ReprintShipmentItemModel
      • ReprintShipmentModel
      • SearchOrderItemsResponse
      • SearchOrderModel
      • SearchOrdersResponse
      • ShipmentMetadata
      • StartProcessingModel
      • StartProcessingResponse
      • UpdateOrderItemImageModel
      • UpdateOrderItemModel
      • UpdateOrderItemResponse
      • UpdateOrderModel
      • UpdateOrderModelBulkModel
      • UpdateOrderResponse
      • UpdatePriceModel
      • VariantAttribute
      • VariantOption
  1. Introduction to our API

Overview

Welcome to ADG API Documentation#

Experience our scalable solutions and industry-leading expertise designed to support your business growth with innovative print-on-demand capabilities.
ADG stands out as North America's premier print fulfillment partner, offering the widest array of printing equipment, unmatched scalability, and a dedication to customer success.

What You Can Do#

Our API enables you to automate and integrate every step of the print fulfillment process:
Submit & manage orders – Create individual or bulk print orders programmatically using our Orders API
Sync your product catalog – Retrieve available products, variants, SKUs, and artwork specifications
Configure webhooks – Subscribe to real-time event notifications for order and shipment activity
Track shipments – Receive tracking details as soon as your shipments are fulfilled and shipped

Before You Begin#

To use the ADG API, you will need:
An active ADG merchant account
Your API credentials — Username & Password for development and testing, or Client ID & Secret for production integrations

Quick Start Guide#

Getting Started
Learn how to authenticate and structure your first API call.
Product Catalog
Explore available products, variants, SKUs, decoration areas, and artwork requirements.
Webhooks Overview
Configure webhook subscriptions to receive real-time order and shipment event notifications.
Notifications Guide
Understand the full notification payload structure for order creation, updates, and shipment tracking.

Why ADG#

99.99% availabilityOur APIs are built for mission-critical integrations
Thousands of API calls dailyProven at scale across merchant integrations
6.6 Million sq. ft.Of production and warehouse facilities globally
Modified at 2026-10-09 16:31:11
Previous
Getting Started
Next
Generate Service Client Access Token
Built with