Factuarea APIDevelopers
Afegit

Packs i un aparador comú per a productes

Els packs tenen la seva pròpia API amb imatges i vista d'aparador, els productes es poden publicar a la web amb preu amb i sense IVA, i les factures admeten línies de pack amb el preu cobrat.

Els packs i l'aparador web ja formen part del contracte públic. Estan disponibles a tots els plans que inclouen productes, des d'Esencial. Esencial admet fins a 5 packs sense arxivar per compte i la resta de plans no té límit.

  • Els packs tenen el seu propi recurs: composició, preu, disponibilitat, imatges (fins a 5, amb URL públiques i permanents), view=storefront per a webs, lectures condicionals amb ETag i un desglossament de preu per tarifa, client (client_id), data i channel.
  • Els productes comparteixen el contracte d'aparador: channels.web, slug, summary, seo, sale_price{net, tax, gross}, availability i alt, width i height de les imatges. Una operació massiva publica o retira fins a 50 productes.
  • Les línies de document admeten {pack_id, quantity, sold_on, unit_price, prices_include_tax, print_mode}. Una venda web cobrada es factura amb el preu cobrat, al cèntim, encara que el pack s'hagi arxivat després.
  • Un pack s'imprimeix igual a tots els documents: cada producte a la seva línia, amb el nom del pack, i l'estalvi sota l'última. print_mode només admet full_breakdown.
  • Les línies de producte amb unit_price admeten prices_include_tax per línia.
  • Els webhooks afegeixen pack.created, pack.updated, pack.archived, pack.restored, pack.deleted i product.deleted.

Llegeix Packs i La teva botiga amb Factuarea.

Esdeveniments

EsdevenimentCanvi
pack.created, pack.updated, pack.archived i pack.restoredNous, amb el pack a view=all
pack.deletedNou, amb {id, object: "pack", deleted: true}
product.deletedNou, amb {id, object: "product", deleted: true}
product.updatedTambé en activar o desactivar un producte, i quan canvien la galeria, el contingut, el slug, el canal web, les variants o l'estat de disponibilitat

Errors nous: pack_not_found, slug_already_exists, pack_in_use, pack_composition_too_small, invalid_pack_component, duplicate_pack_component, invalid_pack_pricing, pack_price_unreachable, pack_price_allocation_impossible, invalid_pack_status_transition, pack_not_sellable, pack_image_limit_reached, pack_snapshot_invalid, pack_lines_must_be_expanded, pack_line_locked i pack_print_mode_not_allowed.

Contracte al dia

Aquesta publicació també recull els canvis finals del contracte de packs, ofertes i tarifes. Les operacions afectades figuren a la llista de sota.

  • Packs. sellable.code és un codi estable i nullable (archived, inactive, out_of_window, no_channel, component_unsellable o price_unreachable) i null quan el pack es pot vendre. Modificar o esborrar les imatges d'un pack d'una altra empresa respon 404 pack_not_found.
  • Tarifes. Actualitzar, eliminar o tocar els ítems d'una tarifa d'una altra empresa respon 404 price_list_not_found. Eliminar un ítem inexistent respon el nou 404 price_list_item_not_found, amb param item_id. Els errors de domini duplicate_price_list_name, invalid_price_list_item, inactive_price_list i price_list_in_use porten el seu code i el seu param.
  • Idempotència. Les escriptures de packs, ofertes i tarifes (19 escriptures) responen 409 idempotency_key_in_use mentre una altra petició amb la mateixa Idempotency-Key continua en curs. Reintenta passats uns segons amb la mateixa clau i el mateix cos.
  • Productes. Un filtre price[gte], price[lte] i similars amb un valor no numèric respon 400 parameter_invalid_format, amb param.
  • Límit del pla. Al pla Esencial un compte admet fins a 5 packs sense arxivar, actius o inactius, entre totes les seves empreses. POST /v1/companies/{company}/packs i POST /v1/companies/{company}/packs/{pack}/restore responen 402 plan_limit_exceeded amb details.resource packs, current i limit quan el compte és ple, i no desen res. Arxiva o esborra un pack per alliberar una plaça, o amplia el pla. La resta de plans no té límit.
  • Mòduls. Els recursos packs i promotions de la v1 exigeixen el mòdul products a cada petició i responen 403 feature_not_available_in_plan si falta. products i price-lists responen com fins ara. Una línia de pack per pack_id en un document exigeix el mòdul packs.
  • Ofertes. El label admet com a màxim 24 caràcters.
  • Documents. Els exemples de línia inclouen pack_group: null.

Nous endpoints12

EndpointDescripció
GET/v1/companies/{company}/packsLlistar tots els packs
POST/v1/companies/{company}/packsCrear un pack
GET/v1/companies/{company}/packs/{pack}Consultar un pack
PATCH/v1/companies/{company}/packs/{pack}Actualitzar un pack
DEL/v1/companies/{company}/packs/{pack}Eliminar un pack
POST/v1/companies/{company}/packs/{pack}/archiveArxivar un pack
POST/v1/companies/{company}/packs/{pack}/restoreRestaurar un pack
GET/v1/companies/{company}/packs/{pack}/price-breakdownObtenir el desglossament de preu d'un pack
POST/v1/companies/{company}/packs/{pack}/imagesPujar una imatge a un pack
PATCH/v1/companies/{company}/packs/{pack}/images/{image}Actualitzar una imatge d'un pack
DEL/v1/companies/{company}/packs/{pack}/images/{image}Eliminar una imatge d'un pack
POST/v1/companies/{company}/products/bulk-channelsPublicar o retirar productes de la web en bloc

Endpoints actualitzats104

EndpointDescripció
POST/v1/companies/{company}/invoices/bulk-createCrear factures en bloc
POST/v1/accounts/{account}/webhooksCrear un webhook endpoint de compte
POST/v1/accounts/{account}/api-keysCrear una API key
POST/v1/companies/{company}/invoices/{invoice}/correctiveGenerar factura rectificativa
POST/v1/companies/{company}/delivery-notesCrear un albarà
POST/v1/companies/{company}/invoicesCrea una factura
POST/v1/companies/{company}/productsCrear un producte
GET/v1/companies/{company}/productsLlistar tots els productes
POST/v1/companies/{company}/products/{product}/presentationsCrear una presentació de producte
GET/v1/companies/{company}/products/{product}/presentationsLlistar presentacions de producte
POST/v1/companies/{company}/products/{product}/variantsCrear una variant de producte
GET/v1/companies/{company}/products/{product}/variantsLlistar variants de producte
POST/v1/companies/{company}/proformasCrea una proforma
POST/v1/companies/{company}/quotesCrea un pressupost
POST/v1/companies/{company}/recurring-invoicesCrea una factura recurrent
POST/v1/companies/{company}/webhook-endpointsCrea un webhook endpoint
GET/v1/companies/{company}/webhook-endpointsLlistar tots els webhook endpoints
PATCH/v1/accounts/{account}/webhooks/{webhook}Actualitzar un webhook endpoint de compte
PATCH/v1/companies/{company}/delivery-notes/{delivery_note}Actualitzar un albarà
PATCH/v1/companies/{company}/invoices/{invoice}Actualitzar una factura
GET/v1/companies/{company}/products/{product}Obtenir un producte
PATCH/v1/companies/{company}/products/{product}Actualitzar un producte
PATCH/v1/companies/{company}/products/{product}/presentations/{presentation}Actualitzar una presentació de producte
PATCH/v1/companies/{company}/products/{product}/variants/{variant}Actualitzar una variant de producte
POST/v1/companies/{company}/products/{product}/videoPuja un vídeo a un producte
PATCH/v1/companies/{company}/proformas/{proforma}Actualitzar una proforma
PATCH/v1/companies/{company}/quotes/{quote}Actualitzar un pressupost
PATCH/v1/companies/{company}/recurring-invoices/{recurring_invoice}Actualitzar una factura recurrent
GET/v1/companies/{company}/webhook-endpoints/{webhook_endpoint}Obtenir un webhook endpoint
PATCH/v1/companies/{company}/webhook-endpoints/{webhook_endpoint}Actualitzar un webhook endpoint
POST/v1/companies/{company}/products/find-by-external-idCercar un producte per external ID
POST/v1/companies/{company}/products/find-by-skuCercar un producte per SKU
GET/v1/companies/{company}/products/low-stock-reportLlista els productes per sota del llindar d'stock
GET/v1/companies/{company}/eventsLlistar tots els esdeveniments
GET/v1/companies/{company}/products/{product}/configurationsLlistar combinacions comercials d'un producte
GET/v1/companies/{company}/webhook-endpoints/{webhook_endpoint}/deliveriesLlista les entregues de webhook
POST/v1/companies/{company}/products/{product}/base-unit-replacementSubstituir un producte canviant la seva unitat base
POST/v1/companies/{company}/products/{product}/resolve-selectionResoldre una selecció de catàleg
POST/v1/companies/{company}/webhook-endpoints/{webhook_endpoint}/rotate-secretRota el secret del webhook
GET/v1/companies/{company}/products/searchCerca productes
POST/v1/accounts/{account}/webhooks/{webhook}/testEnviar un esdeveniment de prova a un webhook endpoint de compte
POST/v1/companies/{company}/webhook-endpoints/{webhook_endpoint}/test-eventEnviar un esdeveniment de prova
GET/v1/companies/{company}/events/{event}Obtenir un esdeveniment
GET/v1/companies/{company}/webhook-endpoints/{webhook_endpoint}/deliveries/{delivery}Recupera el lliurament del webhook
POST/v1/companies/{company}/products/{product}/toggle-activeAlternar l'estat actiu del producte
PATCH/v1/companies/{company}/products/{product}/stockActualitzar l'stock d'un producte
POST/v1/companies/{company}/proformas/{proforma}/acceptAcceptar una proforma
POST/v1/companies/{company}/quotes/{quote}/acceptAcceptar un pressupost
POST/v1/companies/{company}/invoices/{invoice}/annulAnul·lar una factura
POST/v1/companies/{company}/invoices/{invoice}/assign-real-numberAssignar un número de factura real
POST/v1/companies/{company}/delivery-notes/{delivery_note}/cancelAnul·lar un albarà
POST/v1/companies/{company}/delivery-notes/{delivery_note}/convertConvertir albarà en factura
POST/v1/companies/{company}/proformas/{proforma}/convertConvertir proforma en factura
POST/v1/companies/{company}/quotes/{quote}/convertConvertir pressupost en factura
GET/v1/companies/{company}/delivery-notesLlistar tots els albarans
GET/v1/companies/{company}/invoicesLlistar totes les factures
POST/v1/companies/{company}/price-listsCrear una tarifa
GET/v1/companies/{company}/proformasLlistar totes les proformes
GET/v1/companies/{company}/quotesLlistar tots els pressupostos
POST/v1/companies/{company}/invoices/{invoice}/create-recurringCrear una factura recurrent a partir d'una factura
GET/v1/companies/{company}/delivery-notes/{delivery_note}Obtenir un albarà
GET/v1/companies/{company}/invoices/{invoice}Recupera una factura
DEL/v1/companies/{company}/price-lists/{priceList}Eliminar una tarifa
PATCH/v1/companies/{company}/price-lists/{priceList}Actualitzar una tarifa
DEL/v1/companies/{company}/price-lists/{priceList}/items/{item}Eliminar un ítem de tarifa
GET/v1/companies/{company}/proformas/{proforma}Obtenir una proforma
GET/v1/companies/{company}/quotes/{quote}Obtenir un pressupost
POST/v1/companies/{company}/delivery-notes/{delivery_note}/duplicateDuplicar un albarà
POST/v1/companies/{company}/invoices/{invoice}/duplicateDuplicar una factura
POST/v1/companies/{company}/proformas/{proforma}/duplicateDuplicar una proforma
POST/v1/companies/{company}/quotes/{quote}/duplicateDuplicar un pressupost
POST/v1/companies/{company}/delivery-notes/find-by-external-idCercar un albarà per external ID
POST/v1/companies/{company}/invoices/find-by-external-idCercar una factura per external ID
POST/v1/companies/{company}/invoices/find-by-numberCercar una factura per número
POST/v1/companies/{company}/proformas/find-by-external-idCercar una proforma per external ID
POST/v1/companies/{company}/quotes/find-by-external-idCercar un pressupost per external ID
POST/v1/companies/{company}/invoices/{invoice}/issueEmet una factura
GET/v1/companies/{company}/invoices/{invoice}/correctivesLlistar factures rectificatives
POST/v1/companies/{company}/price-lists/{priceList}/itemsFer upsert d’un ítem de tarifa
POST/v1/companies/{company}/delivery-notes/{delivery_note}/mark-deliveredMarca l'albarà com a lliurat
POST/v1/companies/{company}/invoices/{invoice}/mark-paidMarca la factura com a pagada
POST/v1/companies/{company}/invoices/{invoice}/mark-sentMarca una factura com a enviada
POST/v1/companies/{company}/price-lists/{priceList}/items/{item}/purgeEliminar permanentment una entrada de tarifa retirada
POST/v1/companies/{company}/price-lists/{priceList}/items/{item}/reassignReassignar una entrada de tarifa retirada
POST/v1/companies/{company}/proformas/{proforma}/rejectRebutjar una proforma
POST/v1/companies/{company}/quotes/{quote}/rejectRebutjar un pressupost
PATCH/v1/companies/{company}/invoices/{invoice}/rescheduleReprogramar una factura
POST/v1/companies/{company}/invoices/{invoice}/scheduleProgramar una factura
POST/v1/companies/{company}/invoices/{invoice}/sendEnvia la factura per email
POST/v1/companies/{company}/proformas/{proforma}/sendEnvia la proforma per email
POST/v1/companies/{company}/quotes/{quote}/sendEnvia el pressupost per email
POST/v1/companies/{company}/delivery-notes/{delivery_note}/signSignar un albarà
POST/v1/companies/{company}/invoices/substitute-simplifiedSubstituir factures simplificades per factura completa
POST/v1/companies/{company}/invoices/{invoice}/unscheduleDesprogramar una factura
POST/v1/companies/{company}/invoices/{invoice}/unsendAnul·lar l'enviament d'una factura
POST/v1/companies/{company}/invoices/{invoice}/voidAnul·lar una factura
GET/v1/companies/{company}/recurring-invoicesLlistar totes les factures recurrents
GET/v1/companies/{company}/recurring-invoices/{recurring_invoice}Obtenir una factura recurrent
POST/v1/companies/{company}/recurring-invoices/find-by-external-idCercar una factura recurrent per external ID
POST/v1/companies/{company}/recurring-invoices/{recurring_invoice}/activateActivar factura recurrent
POST/v1/companies/{company}/recurring-invoices/{recurring_invoice}/pausePausar factura recurrent
POST/v1/companies/{company}/recurring-invoices/{recurring_invoice}/resumeReprendre factura recurrent
POST/v1/companies/{company}/recurring-invoices/{recurring_invoice}/skipOmetre la pròxima generació de la factura recurrent
POST/v1/companies/{company}/recurring-invoices/{recurring_invoice}/cancelAnul·lar factura recurrent

En aquesta pàgina

Et donem un cop de mà?Contactar amb suport