Gopuff

opencollection: 1.0.0
info:
  name: Powered by Gopuff Fulfillment API
  version: '1.0'
request:
  auth:
    type: apikey
    key: X-Gopuff-Partner-Key
    value: '{{X-Gopuff-Partner-Key}}'
    placement: header
items:
- info:
    name: Shops
    type: folder
  items:
  - info:
      name: Get Partner Shop Status
      type: http
    http:
      method: GET
      url: https://fulfillment-api-eus.partners.gopuff.com/shopify/v1/shops
    docs: Returns the partnership status, configured shop metadata, and serving region for the authenticated partner Shopify
      shop.
- info:
    name: Zones
    type: folder
  items:
  - info:
      name: Check Delivery Zone Eligibility
      type: http
    http:
      method: POST
      url: https://fulfillment-api-eus.partners.gopuff.com/shopify/v1/shops/zones/check
      body:
        type: json
        data: '{}'
    docs: Determines whether a customer location is inside a Gopuff MFC delivery zone. Either an address or a coarse IP location
      can be supplied. When the customer is in zone, the response includes the serving MFC identifier and the eligible product
      collection so the Powered by Gopuff Shopify theme can selectively enable instant delivery messaging.
- info:
    name: Availability
    type: folder
  items:
  - info:
      name: Get Product Availability
      type: http
    http:
      method: POST
      url: https://fulfillment-api-eus.partners.gopuff.com/shopify/v1/shops/availability
      body:
        type: json
        data: '{}'
    docs: Returns real-time product availability at the Gopuff MFC servicing a given customer location. Products are matched
      via UPC mapped to the Gopuff catalog during partner onboarding; only items in the partner's curated instant-delivery
      collection are checked.
- info:
    name: Rates
    type: folder
  items:
  - info:
      name: Get Carrier Rates
      type: http
    http:
      method: POST
      url: https://fulfillment-api-eus.partners.gopuff.com/shopify/v1/shops/rates
      body:
        type: json
        data: '{}'
    docs: Returns Gopuff Instant Delivery carrier rates for a Shopify checkout. Invoked by the Shopify Carrier Service framework.
      Rates are pre-negotiated and set by the partner's Gopuff agreement; merchants are not allowed to add handling fees on
      top of the returned rates.
- info:
    name: Orders
    type: folder
  items:
  - info:
      name: Route Order to Gopuff
      type: http
    http:
      method: POST
      url: https://fulfillment-api-eus.partners.gopuff.com/shopify/v1/shops/orders
      body:
        type: json
        data: '{}'
    docs: Routes a completed Shopify checkout to the nearest Gopuff MFC for picking, packing, and delivery. Returns the Gopuff
      Order ID, which is also written back to the corresponding Shopify order's Additional details panel within 5 to 10 seconds.
  - info:
      name: Get Order
      type: http
    http:
      method: GET
      url: https://fulfillment-api-eus.partners.gopuff.com/shopify/v1/shops/orders/:order_id
      params:
      - name: order_id
        value: ''
        type: path
        description: Gopuff Order ID.
    docs: Returns the current status, fulfillment lifecycle, and tracking information for a Gopuff order. Order status mirrors
      the realtime fulfillment updates Gopuff pushes to Shopify when the order is out for delivery and when it is delivered.
bundled: true