Google Content API for Shopping Orders API

Manage orders

OpenAPI Specification

google-shopping-orders-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Google Content API for Shopping Accounts Orders API
  description: The Content API for Shopping allows apps to interact directly with the Google Merchant Center platform, enabling management of product listings, account information, data feeds, inventory, orders, and promotions. It provides programmatic access to create, update, and delete products, manage shipping and tax settings, handle order workflows, and access reporting data.
  version: 2.1.0
  contact:
    name: Google Shopping
    url: https://developers.google.com/shopping-content
  license:
    name: Google APIs Terms of Service
    url: https://developers.google.com/terms
servers:
- url: https://shoppingcontent.googleapis.com/content/v2.1
  description: Content API for Shopping v2.1 Server
tags:
- name: Orders
  description: Manage orders
paths:
  /{merchantId}/orders:
    get:
      operationId: listOrders
      summary: Google Content API for Shopping List Orders
      description: Lists the orders in the specified merchant account.
      tags:
      - Orders
      parameters:
      - name: merchantId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response with order list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrdersListResponse'
components:
  schemas:
    OrdersListResponse:
      type: object
      properties:
        kind:
          type: string
        nextPageToken:
          type: string
        resources:
          type: array
          items:
            type: object
externalDocs:
  description: Content API for Shopping Documentation
  url: https://developers.google.com/shopping-content/guides/quickstart