> For the complete documentation index, see [llms.txt](https://docs.b2b-sellers.com/b2b-platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.b2b-sellers.com/b2b-platform/api-reference/store-api/offer.md). # Offer Offer addon ## POST /offer-request > Create a offer request ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"responses":{"OfferResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferResponse":{"description":"Returns the offer","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object"},"entity":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}},"schemas":{}},"paths":{"/offer-request":{"post":{"tags":["StoreApi-B2bOffer"],"description":"Create a offer request","requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"billigAddressId":{"type":"string"},"deliverAddressId":{"type":"string"},"subject":{"type":"string"},"commission":{"type":"string"},"customerComment":{"type":"string"}}}}}},"responses":{"200":{"$ref":"#/components/responses/OfferResponse"}}}}}} ``` ## POST /offer-item-request > Create a offer item request ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"responses":{"OfferResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferResponse":{"description":"Returns the offer","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object"},"entity":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}},"schemas":{}},"paths":{"/offer-item-request":{"post":{"tags":["StoreApi-B2bOffer"],"description":"Create a offer item request","requestBody":{"required":false,"content":{"application/json":{"schema":{"properties":{"billigAddressId":{"type":"string"},"deliverAddressId":{"type":"string"},"subject":{"type":"string"},"commission":{"type":"string"},"customerComment":{"type":"string"},"lineItems":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"productId":{"type":"string"},"quantity":{"type":"integer"},"comment":{"type":"string"}}}}}}}}},"responses":{"200":{"$ref":"#/components/responses/OfferResponse"}}}}}} ``` ## GET /b2b/offer-reference-product/{productId} > Get reffered product ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{}},"paths":{"/b2b/offer-reference-product/{productId}":{"get":{"tags":["StoreApi-B2bOffer"],"description":"Get reffered product","parameters":[{"in":"path","name":"productId","description":"ID of product","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}}}}}} ``` ## POST /offer-order/{id} > Converts an offer into an order ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{}},"paths":{"/offer-order/{id}":{"post":{"tags":["StoreApi-B2bOffer"],"summary":"Converts an offer into an order","parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Order","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}}}}}}} ``` ## POST /offer/{id}/request-validity-extension > Request validity for an offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{}},"paths":{"/offer/{id}/request-validity-extension":{"post":{"tags":["StoreApi-B2bOffer"],"description":"Request validity for an offer","parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}}}} ``` ## POST /offer-states > list offer states ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{},"responses":{"OfferStatesResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferStatesResponse":{"description":"Returns the offer states","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitySearchResult"}}}}}}}}},"paths":{"/offer-states":{"post":{"tags":["StoreApi-B2bOffer"],"description":"list offer states","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"$ref":"#/components/responses/OfferStatesResponse"}}}}}} ``` ## GET /offer-document/{id} > gets a document related to an offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}}},"paths":{"/offer-document/{id}":{"get":{"tags":["StoreApi-B2bOffer"],"description":"gets a document related to an offer","parameters":[{"in":"path","name":"id","description":"ID of document","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"the document"}}}}}} ``` ## GET /offer-mail/{id} > Get event mail ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"responses":{"OfferMailResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"offerOrder":{"description":"Returns the mail contents","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"string"}}}}}}}}}}},"paths":{"/offer-mail/{id}":{"get":{"tags":["StoreApi-B2bOffer"],"summary":"Get event mail","parameters":[{"in":"path","name":"id","description":"ID of offer mail","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OfferMailResponse"}}}}}} ``` ## POST /offer-mail/{id} > Send offer mail ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{}},"paths":{"/offer-mail/{id}":{"post":{"tags":["StoreApi-B2bOffer"],"summary":"Send offer mail","parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a success response indicating a successful send","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}}}} ``` ## GET /offer/{id} > Get a offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"responses":{"OfferResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferResponse":{"description":"Returns the offer","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object"},"entity":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}},"schemas":{}},"paths":{"/offer/{id}":{"get":{"tags":["StoreApi-B2bOffer"],"description":"Get a offer","parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OfferResponse"}}}}}} ``` ## PUT /offer/{id} > Update a offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{},"responses":{"OfferResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferResponse":{"description":"Returns the offer","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object"},"entity":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}}},"paths":{"/offer/{id}":{"put":{"tags":["StoreApi-B2bOffer"],"description":"Update a offer","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/B2bsellersOffer"}}}},"parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OfferResponse"}}}}}} ``` ## DELETE /sales-representative/offer/{id} > Delete a offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{}},"paths":{"/sales-representative/offer/{id}":{"delete":{"tags":["StoreApi-B2bOffer"],"description":"Delete a offer","parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}}}} ``` ## POST /offer/list > List offers ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{},"responses":{"OfferListResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferListResponse":{"description":"Returns a list of offers","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"array","items":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}}}},"paths":{"/offer/list":{"post":{"tags":["StoreApi-B2bOffer"],"summary":"List offers","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"$ref":"#/components/responses/OfferListResponse"}}}}}} ``` ## GET /offer/ > List offers ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{},"responses":{"OfferListResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferListResponse":{"description":"Returns a list of offers","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"array","items":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}}}},"paths":{"/offer/":{"get":{"tags":["StoreApi-B2bOffer"],"summary":"List offers","requestBody":{"required":false,"content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Criteria"}]}}}},"responses":{"200":{"$ref":"#/components/responses/OfferListResponse"}}}}}} ``` ## POST /offer/ > create new offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{},"responses":{"OfferResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferResponse":{"description":"Returns the offer","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object"},"entity":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}}},"paths":{"/offer/":{"post":{"tags":["StoreApi-B2bOffer"],"summary":"create new offer","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/B2bsellersOffer"}}}},"responses":{"200":{"$ref":"#/components/responses/OfferResponse"}}}}}} ``` ## Clone an offer > This route is used to clone a Offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"responses":{"OfferResponse":{"openapi":"3.0.0","info":[],"paths":[],"components":{"responses":{"OfferResponse":{"description":"Returns the offer","content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"object"},"entity":{"$ref":"#/components/schemas/B2bsellersOffer"}}}}}}}}}},"schemas":{}},"paths":{"/sales-representative/clone-offer/{id}":{"post":{"tags":["StoreApi-B2bOffer"],"summary":"Clone an offer","description":"This route is used to clone a Offer","parameters":[{"in":"path","name":"id","description":"ID of offer","required":true,"schema":{"type":"string"}}],"responses":{"200":{"$ref":"#/components/responses/OfferResponse"}}}}}} ``` ## POST /offer-add-products/{offerId} > Add items to an offer ```json {"openapi":"3.0.0","info":{"title":"B2Bsellers Suite API","version":"1.0.0"},"tags":[{"name":"StoreApi-B2bOffer","description":"Offer addon"}],"security":[{"ApiKey":[]}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"sw-context-token"}},"schemas":{}},"paths":{"/offer-add-products/{offerId}":{"post":{"tags":["StoreApi-B2bOffer"],"description":"Add items to an offer","parameters":[{"in":"path","name":"offerId","description":"ID of offer","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"object":{"type":"array","items":{"$ref":"#/components/schemas/B2bsellersOfferItem"}}}}}}},"responses":{"200":{"description":"Returns a success response indicating a successful update","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}}}}}}} ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.b2b-sellers.com/b2b-platform/api-reference/store-api/offer.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.